/usr/share/doc/cfengine2/html/cfengine-Reference.html is in cfengine2 2.2.10-5build1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
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
1688
1689
1690
1691
1692
1693
1694
1695
1696
1697
1698
1699
1700
1701
1702
1703
1704
1705
1706
1707
1708
1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
1740
1741
1742
1743
1744
1745
1746
1747
1748
1749
1750
1751
1752
1753
1754
1755
1756
1757
1758
1759
1760
1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
1775
1776
1777
1778
1779
1780
1781
1782
1783
1784
1785
1786
1787
1788
1789
1790
1791
1792
1793
1794
1795
1796
1797
1798
1799
1800
1801
1802
1803
1804
1805
1806
1807
1808
1809
1810
1811
1812
1813
1814
1815
1816
1817
1818
1819
1820
1821
1822
1823
1824
1825
1826
1827
1828
1829
1830
1831
1832
1833
1834
1835
1836
1837
1838
1839
1840
1841
1842
1843
1844
1845
1846
1847
1848
1849
1850
1851
1852
1853
1854
1855
1856
1857
1858
1859
1860
1861
1862
1863
1864
1865
1866
1867
1868
1869
1870
1871
1872
1873
1874
1875
1876
1877
1878
1879
1880
1881
1882
1883
1884
1885
1886
1887
1888
1889
1890
1891
1892
1893
1894
1895
1896
1897
1898
1899
1900
1901
1902
1903
1904
1905
1906
1907
1908
1909
1910
1911
1912
1913
1914
1915
1916
1917
1918
1919
1920
1921
1922
1923
1924
1925
1926
1927
1928
1929
1930
1931
1932
1933
1934
1935
1936
1937
1938
1939
1940
1941
1942
1943
1944
1945
1946
1947
1948
1949
1950
1951
1952
1953
1954
1955
1956
1957
1958
1959
1960
1961
1962
1963
1964
1965
1966
1967
1968
1969
1970
1971
1972
1973
1974
1975
1976
1977
1978
1979
1980
1981
1982
1983
1984
1985
1986
1987
1988
1989
1990
1991
1992
1993
1994
1995
1996
1997
1998
1999
2000
2001
2002
2003
2004
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
2025
2026
2027
2028
2029
2030
2031
2032
2033
2034
2035
2036
2037
2038
2039
2040
2041
2042
2043
2044
2045
2046
2047
2048
2049
2050
2051
2052
2053
2054
2055
2056
2057
2058
2059
2060
2061
2062
2063
2064
2065
2066
2067
2068
2069
2070
2071
2072
2073
2074
2075
2076
2077
2078
2079
2080
2081
2082
2083
2084
2085
2086
2087
2088
2089
2090
2091
2092
2093
2094
2095
2096
2097
2098
2099
2100
2101
2102
2103
2104
2105
2106
2107
2108
2109
2110
2111
2112
2113
2114
2115
2116
2117
2118
2119
2120
2121
2122
2123
2124
2125
2126
2127
2128
2129
2130
2131
2132
2133
2134
2135
2136
2137
2138
2139
2140
2141
2142
2143
2144
2145
2146
2147
2148
2149
2150
2151
2152
2153
2154
2155
2156
2157
2158
2159
2160
2161
2162
2163
2164
2165
2166
2167
2168
2169
2170
2171
2172
2173
2174
2175
2176
2177
2178
2179
2180
2181
2182
2183
2184
2185
2186
2187
2188
2189
2190
2191
2192
2193
2194
2195
2196
2197
2198
2199
2200
2201
2202
2203
2204
2205
2206
2207
2208
2209
2210
2211
2212
2213
2214
2215
2216
2217
2218
2219
2220
2221
2222
2223
2224
2225
2226
2227
2228
2229
2230
2231
2232
2233
2234
2235
2236
2237
2238
2239
2240
2241
2242
2243
2244
2245
2246
2247
2248
2249
2250
2251
2252
2253
2254
2255
2256
2257
2258
2259
2260
2261
2262
2263
2264
2265
2266
2267
2268
2269
2270
2271
2272
2273
2274
2275
2276
2277
2278
2279
2280
2281
2282
2283
2284
2285
2286
2287
2288
2289
2290
2291
2292
2293
2294
2295
2296
2297
2298
2299
2300
2301
2302
2303
2304
2305
2306
2307
2308
2309
2310
2311
2312
2313
2314
2315
2316
2317
2318
2319
2320
2321
2322
2323
2324
2325
2326
2327
2328
2329
2330
2331
2332
2333
2334
2335
2336
2337
2338
2339
2340
2341
2342
2343
2344
2345
2346
2347
2348
2349
2350
2351
2352
2353
2354
2355
2356
2357
2358
2359
2360
2361
2362
2363
2364
2365
2366
2367
2368
2369
2370
2371
2372
2373
2374
2375
2376
2377
2378
2379
2380
2381
2382
2383
2384
2385
2386
2387
2388
2389
2390
2391
2392
2393
2394
2395
2396
2397
2398
2399
2400
2401
2402
2403
2404
2405
2406
2407
2408
2409
2410
2411
2412
2413
2414
2415
2416
2417
2418
2419
2420
2421
2422
2423
2424
2425
2426
2427
2428
2429
2430
2431
2432
2433
2434
2435
2436
2437
2438
2439
2440
2441
2442
2443
2444
2445
2446
2447
2448
2449
2450
2451
2452
2453
2454
2455
2456
2457
2458
2459
2460
2461
2462
2463
2464
2465
2466
2467
2468
2469
2470
2471
2472
2473
2474
2475
2476
2477
2478
2479
2480
2481
2482
2483
2484
2485
2486
2487
2488
2489
2490
2491
2492
2493
2494
2495
2496
2497
2498
2499
2500
2501
2502
2503
2504
2505
2506
2507
2508
2509
2510
2511
2512
2513
2514
2515
2516
2517
2518
2519
2520
2521
2522
2523
2524
2525
2526
2527
2528
2529
2530
2531
2532
2533
2534
2535
2536
2537
2538
2539
2540
2541
2542
2543
2544
2545
2546
2547
2548
2549
2550
2551
2552
2553
2554
2555
2556
2557
2558
2559
2560
2561
2562
2563
2564
2565
2566
2567
2568
2569
2570
2571
2572
2573
2574
2575
2576
2577
2578
2579
2580
2581
2582
2583
2584
2585
2586
2587
2588
2589
2590
2591
2592
2593
2594
2595
2596
2597
2598
2599
2600
2601
2602
2603
2604
2605
2606
2607
2608
2609
2610
2611
2612
2613
2614
2615
2616
2617
2618
2619
2620
2621
2622
2623
2624
2625
2626
2627
2628
2629
2630
2631
2632
2633
2634
2635
2636
2637
2638
2639
2640
2641
2642
2643
2644
2645
2646
2647
2648
2649
2650
2651
2652
2653
2654
2655
2656
2657
2658
2659
2660
2661
2662
2663
2664
2665
2666
2667
2668
2669
2670
2671
2672
2673
2674
2675
2676
2677
2678
2679
2680
2681
2682
2683
2684
2685
2686
2687
2688
2689
2690
2691
2692
2693
2694
2695
2696
2697
2698
2699
2700
2701
2702
2703
2704
2705
2706
2707
2708
2709
2710
2711
2712
2713
2714
2715
2716
2717
2718
2719
2720
2721
2722
2723
2724
2725
2726
2727
2728
2729
2730
2731
2732
2733
2734
2735
2736
2737
2738
2739
2740
2741
2742
2743
2744
2745
2746
2747
2748
2749
2750
2751
2752
2753
2754
2755
2756
2757
2758
2759
2760
2761
2762
2763
2764
2765
2766
2767
2768
2769
2770
2771
2772
2773
2774
2775
2776
2777
2778
2779
2780
2781
2782
2783
2784
2785
2786
2787
2788
2789
2790
2791
2792
2793
2794
2795
2796
2797
2798
2799
2800
2801
2802
2803
2804
2805
2806
2807
2808
2809
2810
2811
2812
2813
2814
2815
2816
2817
2818
2819
2820
2821
2822
2823
2824
2825
2826
2827
2828
2829
2830
2831
2832
2833
2834
2835
2836
2837
2838
2839
2840
2841
2842
2843
2844
2845
2846
2847
2848
2849
2850
2851
2852
2853
2854
2855
2856
2857
2858
2859
2860
2861
2862
2863
2864
2865
2866
2867
2868
2869
2870
2871
2872
2873
2874
2875
2876
2877
2878
2879
2880
2881
2882
2883
2884
2885
2886
2887
2888
2889
2890
2891
2892
2893
2894
2895
2896
2897
2898
2899
2900
2901
2902
2903
2904
2905
2906
2907
2908
2909
2910
2911
2912
2913
2914
2915
2916
2917
2918
2919
2920
2921
2922
2923
2924
2925
2926
2927
2928
2929
2930
2931
2932
2933
2934
2935
2936
2937
2938
2939
2940
2941
2942
2943
2944
2945
2946
2947
2948
2949
2950
2951
2952
2953
2954
2955
2956
2957
2958
2959
2960
2961
2962
2963
2964
2965
2966
2967
2968
2969
2970
2971
2972
2973
2974
2975
2976
2977
2978
2979
2980
2981
2982
2983
2984
2985
2986
2987
2988
2989
2990
2991
2992
2993
2994
2995
2996
2997
2998
2999
3000
3001
3002
3003
3004
3005
3006
3007
3008
3009
3010
3011
3012
3013
3014
3015
3016
3017
3018
3019
3020
3021
3022
3023
3024
3025
3026
3027
3028
3029
3030
3031
3032
3033
3034
3035
3036
3037
3038
3039
3040
3041
3042
3043
3044
3045
3046
3047
3048
3049
3050
3051
3052
3053
3054
3055
3056
3057
3058
3059
3060
3061
3062
3063
3064
3065
3066
3067
3068
3069
3070
3071
3072
3073
3074
3075
3076
3077
3078
3079
3080
3081
3082
3083
3084
3085
3086
3087
3088
3089
3090
3091
3092
3093
3094
3095
3096
3097
3098
3099
3100
3101
3102
3103
3104
3105
3106
3107
3108
3109
3110
3111
3112
3113
3114
3115
3116
3117
3118
3119
3120
3121
3122
3123
3124
3125
3126
3127
3128
3129
3130
3131
3132
3133
3134
3135
3136
3137
3138
3139
3140
3141
3142
3143
3144
3145
3146
3147
3148
3149
3150
3151
3152
3153
3154
3155
3156
3157
3158
3159
3160
3161
3162
3163
3164
3165
3166
3167
3168
3169
3170
3171
3172
3173
3174
3175
3176
3177
3178
3179
3180
3181
3182
3183
3184
3185
3186
3187
3188
3189
3190
3191
3192
3193
3194
3195
3196
3197
3198
3199
3200
3201
3202
3203
3204
3205
3206
3207
3208
3209
3210
3211
3212
3213
3214
3215
3216
3217
3218
3219
3220
3221
3222
3223
3224
3225
3226
3227
3228
3229
3230
3231
3232
3233
3234
3235
3236
3237
3238
3239
3240
3241
3242
3243
3244
3245
3246
3247
3248
3249
3250
3251
3252
3253
3254
3255
3256
3257
3258
3259
3260
3261
3262
3263
3264
3265
3266
3267
3268
3269
3270
3271
3272
3273
3274
3275
3276
3277
3278
3279
3280
3281
3282
3283
3284
3285
3286
3287
3288
3289
3290
3291
3292
3293
3294
3295
3296
3297
3298
3299
3300
3301
3302
3303
3304
3305
3306
3307
3308
3309
3310
3311
3312
3313
3314
3315
3316
3317
3318
3319
3320
3321
3322
3323
3324
3325
3326
3327
3328
3329
3330
3331
3332
3333
3334
3335
3336
3337
3338
3339
3340
3341
3342
3343
3344
3345
3346
3347
3348
3349
3350
3351
3352
3353
3354
3355
3356
3357
3358
3359
3360
3361
3362
3363
3364
3365
3366
3367
3368
3369
3370
3371
3372
3373
3374
3375
3376
3377
3378
3379
3380
3381
3382
3383
3384
3385
3386
3387
3388
3389
3390
3391
3392
3393
3394
3395
3396
3397
3398
3399
3400
3401
3402
3403
3404
3405
3406
3407
3408
3409
3410
3411
3412
3413
3414
3415
3416
3417
3418
3419
3420
3421
3422
3423
3424
3425
3426
3427
3428
3429
3430
3431
3432
3433
3434
3435
3436
3437
3438
3439
3440
3441
3442
3443
3444
3445
3446
3447
3448
3449
3450
3451
3452
3453
3454
3455
3456
3457
3458
3459
3460
3461
3462
3463
3464
3465
3466
3467
3468
3469
3470
3471
3472
3473
3474
3475
3476
3477
3478
3479
3480
3481
3482
3483
3484
3485
3486
3487
3488
3489
3490
3491
3492
3493
3494
3495
3496
3497
3498
3499
3500
3501
3502
3503
3504
3505
3506
3507
3508
3509
3510
3511
3512
3513
3514
3515
3516
3517
3518
3519
3520
3521
3522
3523
3524
3525
3526
3527
3528
3529
3530
3531
3532
3533
3534
3535
3536
3537
3538
3539
3540
3541
3542
3543
3544
3545
3546
3547
3548
3549
3550
3551
3552
3553
3554
3555
3556
3557
3558
3559
3560
3561
3562
3563
3564
3565
3566
3567
3568
3569
3570
3571
3572
3573
3574
3575
3576
3577
3578
3579
3580
3581
3582
3583
3584
3585
3586
3587
3588
3589
3590
3591
3592
3593
3594
3595
3596
3597
3598
3599
3600
3601
3602
3603
3604
3605
3606
3607
3608
3609
3610
3611
3612
3613
3614
3615
3616
3617
3618
3619
3620
3621
3622
3623
3624
3625
3626
3627
3628
3629
3630
3631
3632
3633
3634
3635
3636
3637
3638
3639
3640
3641
3642
3643
3644
3645
3646
3647
3648
3649
3650
3651
3652
3653
3654
3655
3656
3657
3658
3659
3660
3661
3662
3663
3664
3665
3666
3667
3668
3669
3670
3671
3672
3673
3674
3675
3676
3677
3678
3679
3680
3681
3682
3683
3684
3685
3686
3687
3688
3689
3690
3691
3692
3693
3694
3695
3696
3697
3698
3699
3700
3701
3702
3703
3704
3705
3706
3707
3708
3709
3710
3711
3712
3713
3714
3715
3716
3717
3718
3719
3720
3721
3722
3723
3724
3725
3726
3727
3728
3729
3730
3731
3732
3733
3734
3735
3736
3737
3738
3739
3740
3741
3742
3743
3744
3745
3746
3747
3748
3749
3750
3751
3752
3753
3754
3755
3756
3757
3758
3759
3760
3761
3762
3763
3764
3765
3766
3767
3768
3769
3770
3771
3772
3773
3774
3775
3776
3777
3778
3779
3780
3781
3782
3783
3784
3785
3786
3787
3788
3789
3790
3791
3792
3793
3794
3795
3796
3797
3798
3799
3800
3801
3802
3803
3804
3805
3806
3807
3808
3809
3810
3811
3812
3813
3814
3815
3816
3817
3818
3819
3820
3821
3822
3823
3824
3825
3826
3827
3828
3829
3830
3831
3832
3833
3834
3835
3836
3837
3838
3839
3840
3841
3842
3843
3844
3845
3846
3847
3848
3849
3850
3851
3852
3853
3854
3855
3856
3857
3858
3859
3860
3861
3862
3863
3864
3865
3866
3867
3868
3869
3870
3871
3872
3873
3874
3875
3876
3877
3878
3879
3880
3881
3882
3883
3884
3885
3886
3887
3888
3889
3890
3891
3892
3893
3894
3895
3896
3897
3898
3899
3900
3901
3902
3903
3904
3905
3906
3907
3908
3909
3910
3911
3912
3913
3914
3915
3916
3917
3918
3919
3920
3921
3922
3923
3924
3925
3926
3927
3928
3929
3930
3931
3932
3933
3934
3935
3936
3937
3938
3939
3940
3941
3942
3943
3944
3945
3946
3947
3948
3949
3950
3951
3952
3953
3954
3955
3956
3957
3958
3959
3960
3961
3962
3963
3964
3965
3966
3967
3968
3969
3970
3971
3972
3973
3974
3975
3976
3977
3978
3979
3980
3981
3982
3983
3984
3985
3986
3987
3988
3989
3990
3991
3992
3993
3994
3995
3996
3997
3998
3999
4000
4001
4002
4003
4004
4005
4006
4007
4008
4009
4010
4011
4012
4013
4014
4015
4016
4017
4018
4019
4020
4021
4022
4023
4024
4025
4026
4027
4028
4029
4030
4031
4032
4033
4034
4035
4036
4037
4038
4039
4040
4041
4042
4043
4044
4045
4046
4047
4048
4049
4050
4051
4052
4053
4054
4055
4056
4057
4058
4059
4060
4061
4062
4063
4064
4065
4066
4067
4068
4069
4070
4071
4072
4073
4074
4075
4076
4077
4078
4079
4080
4081
4082
4083
4084
4085
4086
4087
4088
4089
4090
4091
4092
4093
4094
4095
4096
4097
4098
4099
4100
4101
4102
4103
4104
4105
4106
4107
4108
4109
4110
4111
4112
4113
4114
4115
4116
4117
4118
4119
4120
4121
4122
4123
4124
4125
4126
4127
4128
4129
4130
4131
4132
4133
4134
4135
4136
4137
4138
4139
4140
4141
4142
4143
4144
4145
4146
4147
4148
4149
4150
4151
4152
4153
4154
4155
4156
4157
4158
4159
4160
4161
4162
4163
4164
4165
4166
4167
4168
4169
4170
4171
4172
4173
4174
4175
4176
4177
4178
4179
4180
4181
4182
4183
4184
4185
4186
4187
4188
4189
4190
4191
4192
4193
4194
4195
4196
4197
4198
4199
4200
4201
4202
4203
4204
4205
4206
4207
4208
4209
4210
4211
4212
4213
4214
4215
4216
4217
4218
4219
4220
4221
4222
4223
4224
4225
4226
4227
4228
4229
4230
4231
4232
4233
4234
4235
4236
4237
4238
4239
4240
4241
4242
4243
4244
4245
4246
4247
4248
4249
4250
4251
4252
4253
4254
4255
4256
4257
4258
4259
4260
4261
4262
4263
4264
4265
4266
4267
4268
4269
4270
4271
4272
4273
4274
4275
4276
4277
4278
4279
4280
4281
4282
4283
4284
4285
4286
4287
4288
4289
4290
4291
4292
4293
4294
4295
4296
4297
4298
4299
4300
4301
4302
4303
4304
4305
4306
4307
4308
4309
4310
4311
4312
4313
4314
4315
4316
4317
4318
4319
4320
4321
4322
4323
4324
4325
4326
4327
4328
4329
4330
4331
4332
4333
4334
4335
4336
4337
4338
4339
4340
4341
4342
4343
4344
4345
4346
4347
4348
4349
4350
4351
4352
4353
4354
4355
4356
4357
4358
4359
4360
4361
4362
4363
4364
4365
4366
4367
4368
4369
4370
4371
4372
4373
4374
4375
4376
4377
4378
4379
4380
4381
4382
4383
4384
4385
4386
4387
4388
4389
4390
4391
4392
4393
4394
4395
4396
4397
4398
4399
4400
4401
4402
4403
4404
4405
4406
4407
4408
4409
4410
4411
4412
4413
4414
4415
4416
4417
4418
4419
4420
4421
4422
4423
4424
4425
4426
4427
4428
4429
4430
4431
4432
4433
4434
4435
4436
4437
4438
4439
4440
4441
4442
4443
4444
4445
4446
4447
4448
4449
4450
4451
4452
4453
4454
4455
4456
4457
4458
4459
4460
4461
4462
4463
4464
4465
4466
4467
4468
4469
4470
4471
4472
4473
4474
4475
4476
4477
4478
4479
4480
4481
4482
4483
4484
4485
4486
4487
4488
4489
4490
4491
4492
4493
4494
4495
4496
4497
4498
4499
4500
4501
4502
4503
4504
4505
4506
4507
4508
4509
4510
4511
4512
4513
4514
4515
4516
4517
4518
4519
4520
4521
4522
4523
4524
4525
4526
4527
4528
4529
4530
4531
4532
4533
4534
4535
4536
4537
4538
4539
4540
4541
4542
4543
4544
4545
4546
4547
4548
4549
4550
4551
4552
4553
4554
4555
4556
4557
4558
4559
4560
4561
4562
4563
4564
4565
4566
4567
4568
4569
4570
4571
4572
4573
4574
4575
4576
4577
4578
4579
4580
4581
4582
4583
4584
4585
4586
4587
4588
4589
4590
4591
4592
4593
4594
4595
4596
4597
4598
4599
4600
4601
4602
4603
4604
4605
4606
4607
4608
4609
4610
4611
4612
4613
4614
4615
4616
4617
4618
4619
4620
4621
4622
4623
4624
4625
4626
4627
4628
4629
4630
4631
4632
4633
4634
4635
4636
4637
4638
4639
4640
4641
4642
4643
4644
4645
4646
4647
4648
4649
4650
4651
4652
4653
4654
4655
4656
4657
4658
4659
4660
4661
4662
4663
4664
4665
4666
4667
4668
4669
4670
4671
4672
4673
4674
4675
4676
4677
4678
4679
4680
4681
4682
4683
4684
4685
4686
4687
4688
4689
4690
4691
4692
4693
4694
4695
4696
4697
4698
4699
4700
4701
4702
4703
4704
4705
4706
4707
4708
4709
4710
4711
4712
4713
4714
4715
4716
4717
4718
4719
4720
4721
4722
4723
4724
4725
4726
4727
4728
4729
4730
4731
4732
4733
4734
4735
4736
4737
4738
4739
4740
4741
4742
4743
4744
4745
4746
4747
4748
4749
4750
4751
4752
4753
4754
4755
4756
4757
4758
4759
4760
4761
4762
4763
4764
4765
4766
4767
4768
4769
4770
4771
4772
4773
4774
4775
4776
4777
4778
4779
4780
4781
4782
4783
4784
4785
4786
4787
4788
4789
4790
4791
4792
4793
4794
4795
4796
4797
4798
4799
4800
4801
4802
4803
4804
4805
4806
4807
4808
4809
4810
4811
4812
4813
4814
4815
4816
4817
4818
4819
4820
4821
4822
4823
4824
4825
4826
4827
4828
4829
4830
4831
4832
4833
4834
4835
4836
4837
4838
4839
4840
4841
4842
4843
4844
4845
4846
4847
4848
4849
4850
4851
4852
4853
4854
4855
4856
4857
4858
4859
4860
4861
4862
4863
4864
4865
4866
4867
4868
4869
4870
4871
4872
4873
4874
4875
4876
4877
4878
4879
4880
4881
4882
4883
4884
4885
4886
4887
4888
4889
4890
4891
4892
4893
4894
4895
4896
4897
4898
4899
4900
4901
4902
4903
4904
4905
4906
4907
4908
4909
4910
4911
4912
4913
4914
4915
4916
4917
4918
4919
4920
4921
4922
4923
4924
4925
4926
4927
4928
4929
4930
4931
4932
4933
4934
4935
4936
4937
4938
4939
4940
4941
4942
4943
4944
4945
4946
4947
4948
4949
4950
4951
4952
4953
4954
4955
4956
4957
4958
4959
4960
4961
4962
4963
4964
4965
4966
4967
4968
4969
4970
4971
4972
4973
4974
4975
4976
4977
4978
4979
4980
4981
4982
4983
4984
4985
4986
4987
4988
4989
4990
4991
4992
4993
4994
4995
4996
4997
4998
4999
5000
5001
5002
5003
5004
5005
5006
5007
5008
5009
5010
5011
5012
5013
5014
5015
5016
5017
5018
5019
5020
5021
5022
5023
5024
5025
5026
5027
5028
5029
5030
5031
5032
5033
5034
5035
5036
5037
5038
5039
5040
5041
5042
5043
5044
5045
5046
5047
5048
5049
5050
5051
5052
5053
5054
5055
5056
5057
5058
5059
5060
5061
5062
5063
5064
5065
5066
5067
5068
5069
5070
5071
5072
5073
5074
5075
5076
5077
5078
5079
5080
5081
5082
5083
5084
5085
5086
5087
5088
5089
5090
5091
5092
5093
5094
5095
5096
5097
5098
5099
5100
5101
5102
5103
5104
5105
5106
5107
5108
5109
5110
5111
5112
5113
5114
5115
5116
5117
5118
5119
5120
5121
5122
5123
5124
5125
5126
5127
5128
5129
5130
5131
5132
5133
5134
5135
5136
5137
5138
5139
5140
5141
5142
5143
5144
5145
5146
5147
5148
5149
5150
5151
5152
5153
5154
5155
5156
5157
5158
5159
5160
5161
5162
5163
5164
5165
5166
5167
5168
5169
5170
5171
5172
5173
5174
5175
5176
5177
5178
5179
5180
5181
5182
5183
5184
5185
5186
5187
5188
5189
5190
5191
5192
5193
5194
5195
5196
5197
5198
5199
5200
5201
5202
5203
5204
5205
5206
5207
5208
5209
5210
5211
5212
5213
5214
5215
5216
5217
5218
5219
5220
5221
5222
5223
5224
5225
5226
5227
5228
5229
5230
5231
5232
5233
5234
5235
5236
5237
5238
5239
5240
5241
5242
5243
5244
5245
5246
5247
5248
5249
5250
5251
5252
5253
5254
5255
5256
5257
5258
5259
5260
5261
5262
5263
5264
5265
5266
5267
5268
5269
5270
5271
5272
5273
5274
5275
5276
5277
5278
5279
5280
5281
5282
5283
5284
5285
5286
5287
5288
5289
5290
5291
5292
5293
5294
5295
5296
5297
5298
5299
5300
5301
5302
5303
5304
5305
5306
5307
5308
5309
5310
5311
5312
5313
5314
5315
5316
5317
5318
5319
5320
5321
5322
5323
5324
5325
5326
5327
5328
5329
5330
5331
5332
5333
5334
5335
5336
5337
5338
5339
5340
5341
5342
5343
5344
5345
5346
5347
5348
5349
5350
5351
5352
5353
5354
5355
5356
5357
5358
5359
5360
5361
5362
5363
5364
5365
5366
5367
5368
5369
5370
5371
5372
5373
5374
5375
5376
5377
5378
5379
5380
5381
5382
5383
5384
5385
5386
5387
5388
5389
5390
5391
5392
5393
5394
5395
5396
5397
5398
5399
5400
5401
5402
5403
5404
5405
5406
5407
5408
5409
5410
5411
5412
5413
5414
5415
5416
5417
5418
5419
5420
5421
5422
5423
5424
5425
5426
5427
5428
5429
5430
5431
5432
5433
5434
5435
5436
5437
5438
5439
5440
5441
5442
5443
5444
5445
5446
5447
5448
5449
5450
5451
5452
5453
5454
5455
5456
5457
5458
5459
5460
5461
5462
5463
5464
5465
5466
5467
5468
5469
5470
5471
5472
5473
5474
5475
5476
5477
5478
5479
5480
5481
5482
5483
5484
5485
5486
5487
5488
5489
5490
5491
5492
5493
5494
5495
5496
5497
5498
5499
5500
5501
5502
5503
5504
5505
5506
5507
5508
5509
5510
5511
5512
5513
5514
5515
5516
5517
5518
5519
5520
5521
5522
5523
5524
5525
5526
5527
5528
5529
5530
5531
5532
5533
5534
5535
5536
5537
5538
5539
5540
5541
5542
5543
5544
5545
5546
5547
5548
5549
5550
5551
5552
5553
5554
5555
5556
5557
5558
5559
5560
5561
5562
5563
5564
5565
5566
5567
5568
5569
5570
5571
5572
5573
5574
5575
5576
5577
5578
5579
5580
5581
5582
5583
5584
5585
5586
5587
5588
5589
5590
5591
5592
5593
5594
5595
5596
5597
5598
5599
5600
5601
5602
5603
5604
5605
5606
5607
5608
5609
5610
5611
5612
5613
5614
5615
5616
5617
5618
5619
5620
5621
5622
5623
5624
5625
5626
5627
5628
5629
5630
5631
5632
5633
5634
5635
5636
5637
5638
5639
5640
5641
5642
5643
5644
5645
5646
5647
5648
5649
5650
5651
5652
5653
5654
5655
5656
5657
5658
5659
5660
5661
5662
5663
5664
5665
5666
5667
5668
5669
5670
5671
5672
5673
5674
5675
5676
5677
5678
5679
5680
5681
5682
5683
5684
5685
5686
5687
5688
5689
5690
5691
5692
5693
5694
5695
5696
5697
5698
5699
5700
5701
5702
5703
5704
5705
5706
5707
5708
5709
5710
5711
5712
5713
5714
5715
5716
5717
5718
5719
5720
5721
5722
5723
5724
5725
5726
5727
5728
5729
5730
5731
5732
5733
5734
5735
5736
5737
5738
5739
5740
5741
5742
5743
5744
5745
5746
5747
5748
5749
5750
5751
5752
5753
5754
5755
5756
5757
5758
5759
5760
5761
5762
5763
5764
5765
5766
5767
5768
5769
5770
5771
5772
5773
5774
5775
5776
5777
5778
5779
5780
5781
5782
5783
5784
5785
5786
5787
5788
5789
5790
5791
5792
5793
5794
5795
5796
5797
5798
5799
5800
5801
5802
5803
5804
5805
5806
5807
5808
5809
5810
5811
5812
5813
5814
5815
5816
5817
5818
5819
5820
5821
5822
5823
5824
5825
5826
5827
5828
5829
5830
5831
5832
5833
5834
5835
5836
5837
5838
5839
5840
5841
5842
5843
5844
5845
5846
5847
5848
5849
5850
5851
5852
5853
5854
5855
5856
5857
5858
5859
5860
5861
5862
5863
5864
5865
5866
5867
5868
5869
5870
5871
5872
5873
5874
5875
5876
5877
5878
5879
5880
5881
5882
5883
5884
5885
5886
5887
5888
5889
5890
5891
5892
5893
5894
5895
5896
5897
5898
5899
5900
5901
5902
5903
5904
5905
5906
5907
5908
5909
5910
5911
5912
5913
5914
5915
5916
5917
5918
5919
5920
5921
5922
5923
5924
5925
5926
5927
5928
5929
5930
5931
5932
5933
5934
5935
5936
5937
5938
5939
5940
5941
5942
5943
5944
5945
5946
5947
5948
5949
5950
5951
5952
5953
5954
5955
5956
5957
5958
5959
5960
5961
5962
5963
5964
5965
5966
5967
5968
5969
5970
5971
5972
5973
5974
5975
5976
5977
5978
5979
5980
5981
5982
5983
5984
5985
5986
5987
5988
5989
5990
5991
5992
5993
5994
5995
5996
5997
5998
5999
6000
6001
6002
6003
6004
6005
6006
6007
6008
6009
6010
6011
6012
6013
6014
6015
6016
6017
6018
6019
6020
6021
6022
6023
6024
6025
6026
6027
6028
6029
6030
6031
6032
6033
6034
6035
6036
6037
6038
6039
6040
6041
6042
6043
6044
6045
6046
6047
6048
6049
6050
6051
6052
6053
6054
6055
6056
6057
6058
6059
6060
6061
6062
6063
6064
6065
6066
6067
6068
6069
6070
6071
6072
6073
6074
6075
6076
6077
6078
6079
6080
6081
6082
6083
6084
6085
6086
6087
6088
6089
6090
6091
6092
6093
6094
6095
6096
6097
6098
6099
6100
6101
6102
6103
6104
6105
6106
6107
6108
6109
6110
6111
6112
6113
6114
6115
6116
6117
6118
6119
6120
6121
6122
6123
6124
6125
6126
6127
6128
6129
6130
6131
6132
6133
6134
6135
6136
6137
6138
6139
6140
6141
6142
6143
6144
6145
6146
6147
6148
6149
6150
6151
6152
6153
6154
6155
6156
6157
6158
6159
6160
6161
6162
6163
6164
6165
6166
6167
6168
6169
6170
6171
6172
6173
6174
6175
6176
6177
6178
6179
6180
6181
6182
6183
6184
6185
6186
6187
6188
6189
6190
6191
6192
6193
6194
6195
6196
6197
6198
6199
6200
6201
6202
6203
6204
6205
6206
6207
6208
6209
6210
6211
6212
6213
6214
6215
6216
6217
6218
6219
6220
6221
6222
6223
6224
6225
6226
6227
6228
6229
6230
6231
6232
6233
6234
6235
6236
6237
6238
6239
6240
6241
6242
6243
6244
6245
6246
6247
6248
6249
6250
6251
6252
6253
6254
6255
6256
6257
6258
6259
6260
6261
6262
6263
6264
6265
6266
6267
6268
6269
6270
6271
6272
6273
6274
6275
6276
6277
6278
6279
6280
6281
6282
6283
6284
6285
6286
6287
6288
6289
6290
6291
6292
6293
6294
6295
6296
6297
6298
6299
6300
6301
6302
6303
6304
6305
6306
6307
6308
6309
6310
6311
6312
6313
6314
6315
6316
6317
6318
6319
6320
6321
6322
6323
6324
6325
6326
6327
6328
6329
6330
6331
6332
6333
6334
6335
6336
6337
6338
6339
6340
6341
6342
6343
6344
6345
6346
6347
6348
6349
6350
6351
6352
6353
6354
6355
6356
6357
6358
6359
6360
6361
6362
6363
6364
6365
6366
6367
6368
6369
6370
6371
6372
6373
6374
6375
6376
6377
6378
6379
6380
6381
6382
6383
6384
6385
6386
6387
6388
6389
6390
6391
6392
6393
6394
6395
6396
6397
6398
6399
6400
6401
6402
6403
6404
6405
6406
6407
6408
6409
6410
6411
6412
6413
6414
6415
6416
6417
6418
6419
6420
6421
6422
6423
6424
6425
6426
6427
6428
6429
6430
6431
6432
6433
6434
6435
6436
6437
6438
6439
6440
6441
6442
6443
6444
6445
6446
6447
6448
6449
6450
6451
6452
6453
6454
6455
6456
6457
6458
6459
6460
6461
6462
6463
6464
6465
6466
6467
6468
6469
6470
6471
6472
6473
6474
6475
6476
6477
6478
6479
6480
6481
6482
6483
6484
6485
6486
6487
6488
6489
6490
6491
6492
6493
6494
6495
6496
6497
6498
6499
6500
6501
6502
6503
6504
6505
6506
6507
6508
6509
6510
6511
6512
6513
6514
6515
6516
6517
6518
6519
6520
6521
6522
6523
6524
6525
6526
6527
6528
6529
6530
6531
6532
6533
6534
6535
6536
6537
6538
6539
6540
6541
6542
6543
6544
6545
6546
6547
6548
6549
6550
6551
6552
6553
6554
6555
6556
6557
6558
6559
6560
6561
6562
6563
6564
6565
6566
6567
6568
6569
6570
6571
6572
6573
6574
6575
6576
6577
6578
6579
6580
6581
6582
6583
6584
6585
6586
6587
6588
6589
6590
6591
6592
6593
6594
6595
6596
6597
6598
6599
6600
6601
6602
6603
6604
6605
6606
6607
6608
6609
6610
6611
6612
6613
6614
6615
6616
6617
6618
6619
6620
6621
6622
6623
6624
6625
6626
6627
6628
6629
6630
6631
6632
6633
6634
6635
6636
6637
6638
6639
6640
6641
6642
6643
6644
6645
6646
6647
6648
6649
6650
6651
6652
6653
6654
6655
6656
6657
6658
6659
6660
6661
6662
6663
6664
6665
6666
6667
6668
6669
6670
6671
6672
6673
6674
6675
6676
6677
6678
6679
6680
6681
6682
6683
6684
6685
6686
6687
6688
6689
6690
6691
6692
6693
6694
6695
6696
6697
6698
6699
6700
6701
6702
6703
6704
6705
6706
6707
6708
6709
6710
6711
6712
6713
6714
6715
6716
6717
6718
6719
6720
6721
6722
6723
6724
6725
6726
6727
6728
6729
6730
6731
6732
6733
6734
6735
6736
6737
6738
6739
6740
6741
6742
6743
6744
6745
6746
6747
6748
6749
6750
6751
6752
6753
6754
6755
6756
6757
6758
6759
6760
6761
6762
6763
6764
6765
6766
6767
6768
6769
6770
6771
6772
6773
6774
6775
6776
6777
6778
6779
6780
6781
6782
6783
6784
6785
6786
6787
6788
6789
6790
6791
6792
6793
6794
6795
6796
6797
6798
6799
6800
6801
6802
6803
6804
6805
6806
6807
6808
6809
6810
6811
6812
6813
6814
6815
6816
6817
6818
6819
6820
6821
6822
6823
6824
6825
6826
6827
6828
6829
6830
6831
6832
6833
6834
6835
6836
6837
6838
6839
6840
6841
6842
6843
6844
6845
6846
6847
6848
6849
6850
6851
6852
6853
6854
6855
6856
6857
6858
6859
6860
6861
6862
6863
6864
6865
6866
6867
6868
6869
6870
6871
6872
6873
6874
6875
6876
6877
6878
6879
6880
6881
6882
6883
6884
6885
6886
6887
6888
6889
6890
6891
6892
6893
6894
6895
6896
6897
6898
6899
6900
6901
6902
6903
6904
6905
6906
6907
6908
6909
6910
6911
6912
6913
6914
6915
6916
6917
6918
6919
6920
6921
6922
6923
6924
6925
6926
6927
6928
6929
6930
6931
6932
6933
6934
6935
6936
6937
6938
6939
6940
6941
6942
6943
6944
6945
6946
6947
6948
6949
6950
6951
6952
6953
6954
6955
6956
6957
6958
6959
6960
6961
6962
6963
6964
6965
6966
6967
6968
6969
6970
6971
6972
6973
6974
6975
6976
6977
6978
6979
6980
6981
6982
6983
6984
6985
6986
6987
6988
6989
6990
6991
6992
6993
6994
6995
6996
6997
6998
6999
7000
7001
7002
7003
7004
7005
7006
7007
7008
7009
7010
7011
7012
7013
7014
7015
7016
7017
7018
7019
7020
7021
7022
7023
7024
7025
7026
7027
7028
7029
7030
7031
7032
7033
7034
7035
7036
7037
7038
7039
7040
7041
7042
7043
7044
7045
7046
7047
7048
7049
7050
7051
7052
7053
7054
7055
7056
7057
7058
7059
7060
7061
7062
7063
7064
7065
7066
7067
7068
7069
7070
7071
7072
7073
7074
7075
7076
7077
7078
7079
7080
7081
7082
7083
7084
7085
7086
7087
7088
7089
7090
7091
7092
7093
7094
7095
7096
7097
7098
7099
7100
7101
7102
7103
7104
7105
7106
7107
7108
7109
7110
7111
7112
7113
7114
7115
7116
7117
7118
7119
7120
7121
7122
7123
7124
7125
7126
7127
7128
7129
7130
7131
7132
7133
7134
7135
7136
7137
7138
7139
7140
7141
7142
7143
7144
7145
7146
7147
7148
7149
7150
7151
7152
7153
7154
7155
7156
7157
7158
7159
7160
7161
7162
7163
7164
7165
7166
7167
7168
7169
7170
7171
7172
7173
7174
7175
7176
7177
7178
7179
7180
7181
7182
7183
7184
7185
7186
7187
7188
7189
7190
7191
7192
7193
7194
7195
7196
7197
7198
7199
7200
7201
7202
7203
7204
7205
7206
7207
7208
7209
7210
7211
7212
7213
7214
7215
7216
7217
7218
7219
7220
7221
7222
7223
7224
7225
7226
7227
7228
7229
7230
7231
7232
7233
7234
7235
7236
7237
7238
7239
7240
7241
7242
7243
7244
7245
7246
7247
7248
7249
7250
7251
7252
7253
7254
7255
7256
7257
7258
7259
7260
7261
7262
7263
7264
7265
7266
7267
7268
7269
7270
7271
7272
7273
7274
7275
7276
7277
7278
7279
7280
7281
7282
7283
7284
7285
7286
7287
7288
7289
7290
7291
7292
7293
7294
7295
7296
7297
7298
7299
7300
7301
7302
7303
7304
7305
7306
7307
7308
7309
7310
7311
7312
7313
7314
7315
7316
7317
7318
7319
7320
7321
7322
7323
7324
7325
7326
7327
7328
7329
7330
7331
7332
7333
7334
7335
7336
7337
7338
7339
7340
7341
7342
7343
7344
7345
7346
7347
7348
7349
7350
7351
7352
7353
7354
7355
7356
7357
7358
7359
7360
7361
7362
7363
7364
7365
7366
7367
7368
7369
7370
7371
7372
7373
7374
7375
7376
7377
7378
7379
7380
7381
7382
7383
7384
7385
7386
7387
7388
7389
7390
7391
7392
7393
7394
7395
7396
7397
7398
7399
7400
7401
7402
7403
7404
7405
7406
7407
7408
7409
7410
7411
7412
7413
7414
7415
7416
7417
7418
7419
7420
7421
7422
7423
7424
7425
7426
7427
7428
7429
7430
7431
7432
7433
7434
7435
7436
7437
7438
7439
7440
7441
7442
7443
7444
7445
7446
7447
7448
7449
7450
7451
7452
7453
7454
7455
7456
7457
7458
7459
7460
7461
7462
7463
7464
7465
7466
7467
7468
7469
7470
7471
7472
7473
7474
7475
7476
7477
7478
7479
7480
7481
7482
7483
7484
7485
7486
7487
7488
7489
7490
7491
7492
7493
7494
7495
7496
7497
7498
7499
7500
7501
7502
7503
7504
7505
7506
7507
7508
7509
7510
7511
7512
7513
7514
7515
7516
7517
7518
7519
7520
7521
7522
7523
7524
7525
7526
7527
7528
7529
7530
7531
7532
7533
7534
7535
7536
7537
7538
7539
7540
7541
7542
7543
7544
7545
7546
7547
7548
7549
7550
7551
7552
7553
7554
7555
7556
7557
7558
7559
7560
7561
7562
7563
7564
7565
7566
7567
7568
7569
7570
7571
7572
7573
7574
7575
7576
7577
7578
7579
7580
7581
7582
7583
7584
7585
7586
7587
7588
7589
7590
7591
7592
7593
7594
7595
7596
7597
7598
7599
7600
7601
7602
7603
7604
7605
7606
7607
7608
7609
7610
7611
7612
7613
7614
7615
7616
7617
7618
7619
7620
7621
7622
7623
7624
7625
7626
7627
7628
7629
7630
7631
7632
7633
7634
7635
7636
7637
7638
7639
7640
7641
7642
7643
7644
7645
7646
7647
7648
7649
7650
7651
7652
7653
7654
7655
7656
7657
7658
7659
7660
7661
7662
7663
7664
7665
7666
7667
7668
7669
7670
7671
7672
7673
7674
7675
7676
7677
7678
7679
7680
7681
7682
7683
7684
7685
7686
7687
7688
7689
7690
7691
7692
7693
7694
7695
7696
7697
7698
7699
7700
7701
7702
7703
7704
7705
7706
7707
7708
7709
7710
7711
7712
7713
7714
7715
7716
7717
7718
7719
7720
7721
7722
7723
7724
7725
7726
7727
7728
7729
7730
7731
7732
7733
7734
7735
7736
7737
7738
7739
7740
7741
7742
7743
7744
7745
7746
7747
7748
7749
7750
7751
7752
7753
7754
7755
7756
7757
7758
7759
7760
7761
7762
7763
7764
7765
7766
7767
7768
7769
7770
7771
7772
7773
7774
7775
7776
7777
7778
7779
7780
7781
7782
7783
7784
7785
7786
7787
7788
7789
7790
7791
7792
7793
7794
7795
7796
7797
7798
7799
7800
7801
7802
7803
7804
7805
7806
7807
7808
7809
7810
7811
7812
7813
7814
7815
7816
7817
7818
7819
7820
7821
7822
7823
7824
7825
7826
7827
7828
7829
7830
7831
7832
7833
7834
7835
7836
7837
7838
7839
7840
7841
7842
7843
7844
7845
7846
7847
7848
7849
7850
7851
7852
7853
7854
7855
7856
7857
7858
7859
7860
7861
7862
7863
7864
7865
7866
7867
7868
7869
7870
7871
7872
7873
7874
7875
7876
7877
7878
7879
7880
7881
7882
7883
7884
7885
7886
7887
7888
7889
7890
7891
7892
7893
7894
7895
7896
7897
7898
7899
7900
7901
7902
7903
7904
7905
7906
7907
7908
7909
7910
7911
7912
7913
7914
7915
7916
7917
7918
7919
7920
7921
7922
7923
7924
7925
7926
7927
7928
7929
7930
7931
7932
7933
7934
7935
7936
7937
7938
7939
7940
7941
7942
7943
7944
7945
7946
7947
7948
7949
7950
7951
7952
7953
7954
7955
7956
7957
7958
7959
7960
7961
7962
7963
7964
7965
7966
7967
7968
7969
7970
7971
7972
7973
7974
7975
7976
7977
7978
7979
7980
7981
7982
7983
7984
7985
7986
7987
7988
7989
7990
7991
7992
7993
7994
7995
7996
7997
7998
7999
8000
8001
8002
8003
8004
8005
8006
8007
8008
8009
8010
8011
8012
8013
8014
8015
8016
8017
8018
8019
8020
8021
8022
8023
8024
8025
8026
8027
8028
8029
8030
8031
8032
8033
8034
8035
8036
8037
8038
8039
8040
8041
8042
8043
8044
8045
8046
8047
8048
8049
8050
8051
8052
8053
8054
8055
8056
8057
8058
8059
8060
8061
8062
8063
8064
8065
8066
8067
8068
8069
8070
8071
8072
8073
8074
8075
8076
8077
8078
8079
8080
8081
8082
8083
8084
8085
8086
8087
8088
8089
8090
8091
8092
8093
8094
8095
8096
8097
8098
8099
8100
8101
8102
8103
8104
8105
8106
8107
8108
8109
8110
8111
8112
8113
8114
8115
8116
8117
8118
8119
8120
8121
8122
8123
8124
8125
8126
8127
8128
8129
8130
8131
8132
8133
8134
8135
8136
8137
8138
8139
8140
8141
8142
8143
8144
8145
8146
8147
8148
8149
8150
8151
8152
8153
8154
8155
8156
8157
8158
8159
8160
8161
8162
8163
8164
8165
8166
8167
8168
8169
8170
8171
8172
8173
8174
8175
8176
8177
8178
8179
8180
8181
8182
8183
8184
8185
8186
8187
8188
8189
8190
8191
8192
8193
8194
8195
8196
8197
8198
8199
8200
8201
8202
8203
8204
8205
8206
8207
8208
8209
8210
8211
8212
8213
8214
8215
8216
8217
8218
8219
8220
8221
8222
8223
8224
8225
8226
8227
8228
8229
8230
8231
8232
8233
8234
8235
8236
8237
8238
8239
8240
8241
8242
8243
8244
8245
8246
8247
8248
8249
8250
8251
8252
8253
8254
8255
8256
8257
8258
8259
8260
8261
8262
8263
8264
8265
8266
8267
8268
8269
8270
8271
8272
8273
8274
8275
8276
8277
8278
8279
8280
8281
8282
8283
8284
8285
8286
8287
8288
8289
8290
8291
8292
8293
8294
8295
8296
8297
8298
8299
8300
8301
8302
8303
8304
8305
8306
8307
8308
8309
8310
8311
8312
8313
8314
8315
8316
8317
8318
8319
8320
8321
8322
8323
8324
8325
8326
8327
8328
8329
8330
8331
8332
8333
8334
8335
8336
8337
8338
8339
8340
8341
8342
8343
8344
8345
8346
8347
8348
8349
8350
8351
8352
8353
8354
8355
8356
8357
8358
8359
8360
8361
8362
8363
8364
8365
8366
8367
8368
8369
8370
8371
8372
8373
8374
8375
8376
8377
8378
8379
8380
8381
8382
8383
8384
8385
8386
8387
8388
8389
8390
8391
8392
8393
8394
8395
8396
8397
8398
8399
8400
8401
8402
8403
8404
8405
8406
8407
8408
8409
8410
8411
8412
8413
8414
8415
8416
8417
8418
8419
8420
8421
8422
8423
8424
8425
8426
8427
8428
8429
8430
8431
8432
8433
8434
8435
8436
8437
8438
8439
8440
8441
8442
8443
8444
8445
8446
8447
8448
8449
8450
8451
8452
8453
8454
8455
8456
8457
8458
8459
8460
8461
8462
8463
8464
8465
8466
8467
8468
8469
8470
8471
8472
8473
8474
8475
8476
8477
8478
8479
8480
8481
8482
8483
8484
8485
8486
8487
8488
8489
8490
8491
8492
8493
8494
8495
8496
8497
8498
8499
8500
8501
8502
8503
8504
8505
8506
8507
8508
8509
8510
8511
8512
8513
8514
8515
8516
8517
8518
8519
8520
8521
8522
8523
8524
8525
8526
8527
8528
8529
8530
8531
8532
8533
8534
8535
8536
8537
8538
8539
8540
8541
8542
8543
8544
8545
8546
8547
8548
8549
8550
8551
8552
8553
8554
8555
8556
8557
8558
8559
8560
8561
8562
8563
8564
8565
8566
8567
8568
8569
8570
8571
8572
8573
8574
8575
8576
8577
8578
8579
8580
8581
8582
8583
8584
8585
8586
8587
8588
8589
8590
8591
8592
8593
8594
8595
8596
8597
8598
8599
8600
8601
8602
8603
8604
8605
8606
8607
8608
8609
8610
8611
8612
8613
8614
8615
8616
8617
8618
8619
8620
8621
8622
8623
8624
8625
8626
8627
8628
8629
8630
8631
8632
8633
8634
8635
8636
8637
8638
8639
8640
8641
8642
8643
8644
8645
8646
8647
8648
8649
8650
8651
8652
8653
8654
8655
8656
8657
8658
8659
8660
8661
8662
8663
8664
8665
8666
8667
8668
8669
8670
8671
8672
8673
8674
8675
8676
8677
8678
8679
8680
8681
8682
8683
8684
8685
8686
8687
8688
8689
8690
8691
8692
8693
8694
8695
8696
8697
8698
8699
8700
8701
8702
8703
8704
8705
8706
8707
8708
8709
8710
8711
8712
8713
8714
8715
8716
8717
8718
8719
8720
8721
8722
8723
8724
8725
8726
8727
8728
8729
8730
8731
8732
8733
8734
8735
8736
8737
8738
8739
8740
8741
8742
8743
8744
8745
8746
8747
8748
8749
8750
8751
8752
8753
8754
8755
8756
8757
8758
8759
8760
8761
8762
8763
8764
8765
8766
8767
8768
8769
8770
8771
8772
8773
8774
8775
8776
8777
8778
8779
8780
8781
8782
8783
8784
8785
8786
8787
8788
8789
8790
8791
8792
8793
8794
8795
8796
8797
8798
8799
8800
8801
8802
8803
8804
8805
8806
8807
8808
8809
8810
8811
8812
8813
8814
8815
8816
8817
8818
8819
8820
8821
8822
8823
8824
8825
8826
8827
8828
8829
8830
8831
8832
8833
8834
8835
8836
8837
8838
8839
8840
8841
8842
8843
8844
8845
8846
8847
8848
8849
8850
8851
8852
8853
8854
8855
8856
8857
8858
8859
8860
8861
8862
8863
8864
8865
8866
8867
8868
8869
8870
8871
8872
8873
8874
8875
8876
8877
8878
8879
8880
8881
8882
8883
8884
8885
8886
8887
8888
8889
8890
8891
8892
8893
8894
8895
8896
8897
8898
8899
8900
8901
8902
8903
8904
8905
8906
8907
8908
8909
8910
8911
8912
8913
8914
8915
8916
8917
8918
8919
8920
8921
8922
8923
8924
8925
8926
8927
8928
8929
8930
8931
8932
8933
8934
8935
8936
8937
8938
8939
8940
8941
8942
8943
8944
8945
8946
8947
8948
8949
8950
8951
8952
8953
8954
8955
8956
8957
8958
8959
8960
8961
8962
8963
8964
8965
8966
8967
8968
8969
8970
8971
8972
8973
8974
8975
8976
8977
8978
8979
8980
8981
8982
8983
8984
8985
8986
8987
8988
8989
8990
8991
8992
8993
8994
8995
8996
8997
8998
8999
9000
9001
9002
9003
9004
9005
9006
9007
9008
9009
9010
9011
9012
9013
9014
9015
9016
9017
9018
9019
9020
9021
9022
9023
9024
9025
9026
9027
9028
9029
9030
9031
9032
9033
9034
9035
9036
9037
9038
9039
9040
9041
9042
9043
9044
9045
9046
9047
9048
9049
9050
9051
9052
9053
9054
9055
9056
9057
9058
9059
9060
9061
9062
9063
9064
9065
9066
9067
9068
9069
9070
9071
9072
9073
9074
9075
9076
9077
9078
9079
9080
9081
9082
9083
9084
9085
9086
9087
9088
9089
9090
9091
9092
9093
9094
9095
9096
9097
9098
9099
9100
9101
9102
9103
9104
9105
9106
9107
9108
9109
9110
9111
9112
9113
9114
9115
9116
9117
9118
9119
9120
9121
9122
9123
9124
9125
9126
9127
9128
9129
9130
9131
9132
9133
9134
9135
9136
9137
9138
9139
9140
9141
9142
9143
9144
9145
9146
9147
9148
9149
9150
9151
9152
9153
9154
9155
9156
9157
9158
9159
9160
9161
9162
9163
9164
9165
9166
9167
9168
9169
9170
9171
9172
9173
9174
9175
9176
9177
9178
9179
9180
9181
9182
9183
9184
9185
9186
9187
9188
9189
9190
9191
9192
9193
9194
9195
9196
9197
9198
9199
9200
9201
9202
9203
9204
9205
9206
9207
9208
9209
9210
9211
9212
9213
9214
9215
9216
9217
9218
9219
9220
9221
9222
9223
9224
9225
9226
9227
9228
9229
9230
9231
9232
9233
9234
9235
9236
9237
9238
9239
9240
9241
9242
9243
9244
9245
9246
9247
9248
9249
9250
9251
9252
9253
9254
9255
9256
9257
9258
9259
9260
9261
9262
9263
9264
9265
9266
9267
9268
9269
9270
9271
9272
9273
9274
9275
9276
9277
9278
9279
9280
9281
9282
9283
9284
9285
9286
9287
9288
9289
9290
9291
9292
9293
9294
9295
9296
9297
9298
9299
9300
9301
9302
9303
9304
9305
9306
9307
9308
9309
9310
9311
9312
9313
9314
9315
9316
9317
9318
9319
9320
9321
9322
9323
9324
9325
9326
9327
9328
9329
9330
9331
9332
9333
9334
9335
9336
9337
9338
9339
9340
9341
9342
9343
9344
9345
9346
9347
9348
9349
9350
9351
9352
9353
9354
9355
9356
9357
9358
9359
9360
9361
9362
9363
9364
9365
9366
9367
9368
9369
9370
9371
9372
9373
9374
9375
9376
9377
9378
9379
9380
9381
9382
9383
9384
9385
9386
9387
9388
9389
9390
9391
9392
9393
9394
9395
9396
9397
9398
9399
9400
9401
9402
9403
9404
9405
9406
9407
9408
9409
9410
9411
9412
9413
9414
9415
9416
9417
9418
9419
9420
9421
9422
9423
9424
9425
9426
9427
9428
9429
9430
9431
9432
9433
9434
9435
9436
9437
9438
9439
9440
9441
9442
9443
9444
9445
9446
9447
9448
9449
9450
9451
9452
9453
9454
9455
9456
9457
9458
9459
9460
9461
9462
9463
9464
9465
9466
9467
9468
9469
9470
9471
9472
9473
9474
9475
9476
9477
9478
9479
9480
9481
9482
9483
9484
9485
9486
9487
9488
9489
9490
9491
9492
9493
9494
9495
9496
9497
9498
9499
9500
9501
9502
9503
9504
9505
9506
9507
9508
9509
9510
9511
9512
9513
9514
9515
9516
9517
9518
9519
9520
9521
9522
9523
9524
9525
9526
9527
9528
9529
9530
9531
9532
9533
9534
9535
9536
9537
9538
9539
9540
9541
9542
9543
9544
9545
9546
9547
9548
9549
9550
9551
9552
9553
9554
9555
9556
9557
9558
9559
9560
9561
9562
9563
9564
9565
9566
9567
9568
9569
9570
9571
9572
9573
9574
9575
9576
9577
9578
9579
9580
9581
9582
9583
9584
9585
9586
9587
9588
9589
9590
9591
9592
9593
9594
9595
9596
9597
9598
9599
9600
9601
9602
9603
9604
9605
9606
9607
9608
9609
9610
9611
9612
9613
9614
9615
9616
9617
9618
9619
9620
9621
9622
9623
9624
9625
9626
9627
9628
9629
9630
9631
9632
9633
9634
9635
9636
9637
9638
9639
9640
9641
9642
9643
9644
9645
9646
9647
9648
9649
9650
9651
9652
9653
9654
9655
9656
9657
9658
9659
9660
9661
9662
9663
9664
9665
9666
9667
9668
9669
9670
9671
9672
9673
9674
9675
9676
9677
9678
9679
9680
9681
9682
9683
9684
9685
9686
9687
9688
9689
9690
9691
9692
9693
9694
9695
9696
9697
9698
9699
9700
9701
9702
9703
9704
9705
9706
9707
9708
9709
9710
9711
9712
9713
9714
9715
9716
9717
9718
9719
9720
9721
9722
9723
9724
9725
9726
9727
9728
9729
9730
9731
9732
9733
9734
9735
9736
9737
9738
9739
9740
9741
9742
9743
9744
9745
9746
9747
9748
9749
9750
9751
9752
9753
9754
9755
9756
9757
9758
9759
9760
9761
9762
9763
9764
9765
9766
9767
9768
9769
9770
9771
9772
9773
9774
9775
9776
9777
9778
9779
9780
9781
9782
9783
9784
9785
9786
9787
9788
9789
9790
9791
9792
9793
9794
9795
9796
9797
9798
9799
9800
9801
9802
9803
9804
9805
9806
9807
9808
9809
9810
9811
9812
9813
9814
9815
9816
9817
9818
9819
9820
9821
9822
9823
9824
9825
9826
9827
9828
9829
9830
9831
9832
9833
9834
9835
9836
9837
9838
9839
9840
9841
9842
9843
9844
9845
9846
9847
9848
9849
9850
9851
9852
9853
9854
9855
9856
9857
9858
9859
9860
9861
9862
9863
9864
9865
9866
9867
9868
9869
9870
9871
9872
9873
9874
9875
9876
9877
9878
9879
9880
9881
9882
9883
9884
9885
9886
9887
9888
9889
9890
9891
9892
9893
9894
9895
9896
9897
9898
9899
9900
9901
9902
9903
9904
9905
9906
9907
9908
9909
9910
9911
9912
9913
9914
9915
9916
9917
9918
9919
9920
9921
9922
9923
9924
9925
9926
9927
9928
9929
9930
9931
9932
9933
9934
9935
9936
9937
9938
9939
9940
9941
9942
9943
9944
9945
9946
9947
9948
9949
9950
9951
9952
9953
9954
9955
9956
9957
9958
9959
9960
9961
9962
9963
9964
9965
9966
9967
9968
9969
9970
9971
9972
9973
9974
9975
9976
9977
9978
9979
9980
9981
9982
9983
9984
9985
9986
9987
9988
9989
9990
9991
9992
9993
9994
9995
9996
9997
9998
9999
10000
10001
10002
10003
10004
10005
10006
10007
10008
10009
10010
10011
10012
10013
10014
10015
10016
10017
10018
10019
10020
10021
10022
10023
10024
10025
10026
10027
10028
10029
10030
10031
10032
10033
10034
10035
10036
10037
10038
10039
10040
10041
10042
10043
10044
10045
10046
10047
10048
10049
10050
10051
10052
10053
10054
10055
10056
10057
10058
10059
10060
10061
10062
10063
10064
10065
10066
10067
10068
10069
10070
10071
10072
10073
10074
10075
10076
10077
10078
10079
10080
10081
10082
10083
10084
10085
10086
10087
10088
10089
10090
10091
10092
10093
10094
10095
10096
10097
10098
10099
10100
10101
10102
10103
10104
10105
10106
10107
10108
10109
10110
10111
10112
10113
10114
10115
10116
10117
10118
10119
10120
10121
10122
10123
10124
10125
10126
10127
10128
10129
10130
10131
10132
10133
10134
10135
10136
10137
10138
10139
10140
10141
10142
10143
10144
10145
10146
10147
10148
10149
10150
10151
10152
10153
10154
10155
10156
10157
10158
10159
10160
10161
10162
10163
10164
10165
10166
10167
10168
10169
10170
10171
10172
10173
10174
10175
10176
10177
10178
10179
10180
10181
10182
10183
10184
10185
10186
10187
10188
10189
10190
10191
10192
10193
10194
10195
10196
10197
10198
10199
10200
10201
10202
10203
10204
10205
10206
10207
10208
10209
10210
10211
10212
10213
10214
10215
10216
10217
10218
10219
10220
10221
10222
10223
10224
10225
10226
10227
10228
10229
10230
10231
10232
10233
10234
10235
10236
10237
10238
10239
10240
10241
10242
10243
10244
10245
10246
10247
10248
10249
10250
10251
10252
10253
10254
10255
10256
10257
10258
10259
10260
10261
10262
10263
10264
10265
10266
10267
10268
10269
10270
10271
10272
10273
10274
10275
10276
10277
10278
10279
10280
10281
10282
10283
10284
10285
10286
10287
10288
10289
10290
10291
10292
10293
10294
10295
10296
10297
10298
10299
10300
10301
10302
10303
10304
10305
10306
10307
10308
10309
10310
10311
10312
10313
10314
10315
10316
10317
10318
10319
10320
10321
10322
10323
10324
10325
10326
10327
10328
10329
10330
10331
10332
10333
10334
10335
10336
10337
10338
10339
10340
10341
10342
10343
10344
10345
10346
10347
10348
10349
10350
10351
10352
10353
10354
10355
10356
10357
10358
10359
10360
10361
10362
10363
10364
10365
10366
10367
10368
10369
10370
10371
10372
10373
10374
10375
10376
10377
10378
10379
10380
10381
10382
10383
10384
10385
10386
10387
10388
10389
10390
10391
10392
10393
10394
10395
10396
10397
10398
10399
10400
10401
10402
10403
10404
10405
10406
10407
10408
10409
10410
10411
10412
10413
10414
10415
10416
10417
10418
10419
10420
10421
10422
10423
10424
10425
10426
10427
10428
10429
10430
10431
10432
10433
10434
10435
10436
10437
10438
10439
10440
10441
10442
10443
10444
10445
10446
10447
10448
10449
10450
10451
10452
10453
10454
10455
10456
10457
10458
10459
10460
10461
10462
10463
10464
10465
10466
10467
10468
10469
10470
10471
10472
10473
10474
10475
10476
10477
10478
10479
10480
10481
10482
10483
10484
10485
10486
10487
10488
10489
10490
10491
10492
10493
10494
10495
10496
10497
10498
10499
10500
10501
10502
10503
10504
10505
10506
10507
10508
10509
10510
10511
10512
10513
10514
10515
10516
10517
10518
10519
10520
10521
10522
10523
10524
10525
10526
10527
10528
10529
10530
10531
10532
10533
10534
10535
10536
10537
10538
10539
10540
10541
10542
10543
10544
10545
10546
10547
10548
10549
10550
10551
10552
10553
10554
10555
10556
10557
10558
10559
10560
10561
10562
10563
10564
10565
10566
10567
10568
10569
10570
10571
10572
10573
10574
10575
10576
10577
10578
10579
10580
10581
10582
10583
10584
10585
10586
10587
10588
10589
10590
10591
10592
10593
10594
10595
10596
10597
10598
10599
10600
10601
10602
10603
10604
10605
10606
10607
10608
10609
10610
10611
10612
10613
10614
10615
10616
10617
10618
10619
10620
10621
10622
10623
10624
10625
10626
10627
10628
10629
10630
10631
10632
10633
10634
10635
10636
10637
10638
10639
10640
10641
10642
10643
10644
10645
10646
10647
10648
10649
10650
10651
10652
10653
10654
10655
10656
10657
10658
10659
10660
10661
10662
10663
10664
10665
10666
10667
10668
10669
10670
10671
10672
10673
10674
10675
10676
10677
10678
10679
10680
10681
10682
10683
10684
10685
10686
10687
10688
10689
10690
10691
10692
10693
10694
10695
10696
10697
10698
10699
10700
10701
10702
10703
10704
10705
10706
10707
10708
10709
10710
10711
10712
10713
10714
10715
10716
10717
10718
10719
10720
10721
10722
10723
10724
10725
10726
10727
10728
10729
10730
10731
10732
10733
10734
10735
10736
10737
10738
10739
10740
10741
10742
10743
10744
10745
10746
10747
10748
10749
10750
10751
10752
10753
10754
10755
10756
10757
10758
10759
10760
10761
10762
10763
10764
10765
10766
10767
10768
10769
10770
10771
10772
10773
10774
10775
10776
10777
10778
10779
10780
10781
10782
10783
10784
10785
10786
10787
10788
10789
10790
10791
10792
10793
10794
10795
10796
10797
10798
10799
10800
10801
10802
10803
10804
10805
10806
10807
10808
10809
10810
10811
10812
10813
10814
10815
10816
10817
10818
10819
10820
10821
10822
10823
10824
10825
10826
10827
10828
10829
10830
10831
10832
10833
10834
10835
10836
10837
10838
10839
10840
10841
10842
10843
10844
10845
10846
10847
10848
10849
10850
10851
10852
10853
10854
10855
10856
10857
10858
10859
10860
10861
10862
10863
10864
10865
10866
10867
10868
10869
10870
10871
10872
10873
10874
10875
10876
10877
10878
10879
10880
10881
10882
10883
10884
10885
10886
10887
10888
10889
10890
10891
10892
10893
10894
10895
10896
10897
10898
10899
10900
10901
10902
10903
10904
10905
10906
10907
10908
10909
10910
10911
10912
10913
10914
10915
10916
10917
10918
10919
10920
10921
10922
10923
10924
10925
10926
10927
10928
10929
10930
10931
10932
10933
10934
10935
10936
10937
10938
10939
10940
10941
10942
10943
10944
10945
10946
10947
10948
10949
10950
10951
10952
10953
10954
10955
10956
10957
10958
10959
10960
10961
10962
10963
10964
10965
10966
10967
10968
10969
10970
10971
10972
10973
10974
10975
10976
10977
10978
10979
10980
10981
10982
10983
10984
10985
10986
10987
10988
10989
10990
10991
10992
10993
10994
10995
10996
10997
10998
10999
11000
11001
11002
11003
11004
11005
11006
11007
11008
11009
11010
11011
11012
11013
11014
11015
11016
11017
11018
11019
11020
11021
11022
11023
11024
11025
11026
11027
11028
11029
11030
11031
11032
11033
11034
11035
11036
11037
11038
11039
11040
11041
11042
11043
11044
11045
11046
11047
11048
11049
11050
11051
11052
11053
11054
11055
11056
11057
11058
11059
11060
11061
11062
11063
11064
11065
11066
11067
11068
11069
11070
11071
11072
11073
11074
11075
11076
11077
11078
11079
11080
11081
11082
11083
11084
11085
11086
11087
11088
11089
11090
11091
11092
11093
11094
11095
11096
11097
11098
11099
11100
11101
11102
11103
11104
11105
11106
11107
11108
11109
11110
11111
11112
11113
11114
11115
11116
11117
11118
11119
11120
11121
11122
11123
11124
11125
11126
11127
11128
11129
11130
11131
11132
11133
11134
11135
11136
11137
11138
11139
11140
11141
11142
11143
11144
11145
11146
11147
11148
11149
11150
11151
11152
11153
11154
11155
11156
11157
11158
11159
11160
11161
11162
11163
11164
11165
11166
11167
11168
11169
11170
11171
11172
11173
11174
11175
11176
11177
11178
11179
11180
11181
11182
11183
11184
11185
11186
11187
11188
11189
11190
11191
11192
11193
11194
11195
11196
11197
11198
11199
11200
11201
11202
11203
11204
11205
11206
11207
11208
11209
11210
11211
11212
11213
11214
11215
11216
11217
11218
11219
11220
11221
11222
11223
11224
11225
11226
11227
11228
11229
11230
11231
11232
11233
11234
11235
11236
11237
11238
11239
11240
11241
11242
11243
11244
11245
11246
11247
11248
11249
11250
11251
11252
11253
11254
11255
11256
11257
11258
11259
11260
11261
11262
11263
11264
11265
11266
11267
11268
11269
11270
11271
11272
11273
11274
11275
11276
11277
11278
11279
11280
11281
11282
11283
11284
11285
11286
11287
11288
11289
11290
11291
11292
11293
11294
11295
11296
11297
11298
11299
11300
11301
11302
11303
11304
11305
11306
11307
11308
11309
11310
11311
11312
11313
11314
11315
11316
11317
11318
11319
11320
11321
11322
11323
11324
11325
11326
11327
11328
11329
11330
11331
11332
11333
11334
11335
11336
11337
11338
11339
11340
11341
11342
11343
11344
11345
11346
11347
11348
11349
11350
11351
11352
11353
11354
11355
11356
11357
11358
11359
11360
11361
11362
11363
11364
11365
11366
11367
11368
11369
11370
11371
11372
11373
11374
11375
11376
11377
11378
11379
11380
11381
11382
11383
11384
11385
11386
11387
11388
11389
11390
11391
11392
11393
11394
11395
11396
11397
11398
11399
11400
11401
11402
11403
11404
11405
11406
11407
11408
11409
11410
11411
11412
11413
11414
11415
11416
11417
11418
11419
11420
11421
11422
11423
11424
11425
11426
11427
11428
11429
11430
11431
11432
11433
11434
11435
11436
11437
11438
11439
11440
11441
11442
11443
11444
11445
11446
11447
11448
11449
11450
11451
11452
11453
11454
11455
11456
11457
11458
11459
11460
11461
11462
11463
11464
11465
11466
11467
11468
11469
11470
11471
11472
11473
11474
11475
11476
11477
11478
11479
11480
11481
11482
11483
11484
11485
11486
11487
11488
11489
11490
11491
11492
11493
11494
11495
11496
11497
11498
11499
11500
11501
11502
11503
11504
11505
11506
11507
11508
11509
11510
11511
11512
11513
11514
11515
11516
11517
11518
11519
11520
11521
11522
11523
11524
11525
11526
11527
11528
11529
11530
11531
11532
11533
11534
11535
11536
11537
11538
11539
11540
11541
11542
11543
11544
11545
11546
11547
11548
11549
11550
11551
11552
11553
11554
11555
11556
11557
11558
11559
11560
11561
11562
11563
11564
11565
11566
11567
11568
11569
11570
11571
11572
11573
11574
11575
11576
11577
11578
11579
11580
11581
11582
11583
11584
11585
11586
11587
11588
11589
11590
11591
11592
11593
11594
11595
11596
11597
11598
11599
11600
11601
11602
11603
11604
11605
11606
11607
11608
11609
11610
11611
11612
11613
11614
11615
11616
11617
11618
11619
11620
11621
11622
11623
11624
11625
11626
11627
11628
11629
11630
11631
11632
11633
11634
11635
11636
11637
11638
11639
11640
11641
11642
11643
11644
11645
11646
11647
11648
11649
11650
11651
11652
11653
11654
11655
11656
11657
11658
11659
11660
11661
11662
11663
11664
11665
11666
11667
11668
11669
11670
11671
11672
11673
11674
11675
11676
11677
11678
11679
11680
11681
11682
11683
11684
11685
11686
11687
11688
11689
11690
11691
11692
11693
11694
11695
11696
11697
11698
11699
11700
11701
11702
11703
11704
11705
11706
11707
11708
11709
11710
11711
11712
11713
11714
11715
11716
11717
11718
11719
11720
11721
11722
11723
11724
11725
11726
11727
11728
11729
11730
11731
11732
11733
11734
11735
11736
11737
11738
11739
11740
11741
11742
11743
11744
11745
11746
11747
11748
11749
11750
11751
11752
11753
11754
11755
11756
11757
11758
11759
11760
11761
11762
11763
11764
11765
11766
11767
11768
11769
11770
11771
11772
11773
11774
11775
11776
11777
11778
11779
11780
11781
11782
11783
11784
11785
11786
11787
11788
11789
11790
11791
11792
11793
11794
11795
11796
11797
11798
11799
11800
11801
11802
11803
11804
11805
11806
11807
11808
11809
11810
11811
11812
11813
11814
11815
11816
11817
11818
11819
11820
11821
11822
11823
11824
11825
11826
11827
11828
11829
11830
11831
11832
11833
11834
11835
11836
11837
11838
11839
11840
11841
11842
11843
11844
11845
11846
11847
11848
11849
11850
11851
11852
11853
11854
11855
11856
11857
11858
11859
11860
11861
11862
11863
11864
11865
11866
11867
11868
11869
11870
11871
11872
11873
11874
11875
11876
11877
11878
11879
11880
11881
11882
11883
11884
11885
11886
11887
11888
11889
11890
11891
11892
11893
11894
11895
11896
11897
11898
11899
11900
11901
11902
11903
11904
11905
11906
11907
11908
11909
11910
11911
11912
11913
11914
11915
11916
11917
11918
11919
11920
11921
11922
11923
11924
11925
11926
11927
11928
11929
11930
11931
11932
11933
11934
11935
11936
11937
11938
11939
11940
11941
11942
11943
11944
11945
11946
11947
11948
11949
11950
11951
11952
11953
11954
11955
11956
11957
11958
11959
11960
11961
11962
11963
11964
11965
11966
11967
11968
11969
11970
11971
11972
11973
11974
11975
11976
11977
11978
11979
11980
11981
11982
11983
11984
11985
11986
11987
11988
11989
11990
11991
11992
11993
11994
11995
11996
11997
11998
11999
12000
12001
12002
12003
12004
12005
12006
12007
12008
12009
12010
12011
12012
12013
12014
12015
12016
12017
12018
12019
12020
12021
12022
12023
12024
12025
12026
12027
12028
12029
12030
12031
12032
12033
12034
12035
12036
12037
12038
12039
12040
12041
12042
12043
12044
12045
12046
12047
12048
12049
12050
12051
12052
12053
12054
12055
12056
12057
12058
12059
12060
12061
12062
12063
12064
12065
12066
12067
12068
12069
12070
12071
12072
12073
12074
12075
12076
12077
12078
12079
12080
12081
12082
12083
12084
12085
12086
12087
12088
12089
12090
12091
12092
12093
12094
12095
12096
12097
12098
12099
12100
12101
12102
12103
12104
12105
12106
12107
12108
12109
12110
12111
12112
12113
12114
12115
12116
12117
12118
12119
12120
12121
12122
12123
12124
12125
12126
12127
12128
12129
12130
12131
12132
12133
12134
12135
12136
12137
12138
12139
12140
12141
12142
12143
12144
12145
12146
12147
12148
12149
12150
12151
12152
12153
12154
12155
12156
12157
12158
12159
12160
12161
12162
12163
12164
12165
12166
12167
12168
12169
12170
12171
12172
12173
12174
12175
12176
12177
12178
12179
12180
12181
12182
12183
12184
12185
12186
12187
12188
12189
12190
12191
12192
12193
12194
12195
12196
12197
12198
12199
12200
12201
12202
12203
12204
12205
12206
12207
12208
12209
12210
12211
12212
12213
12214
12215
12216
12217
12218
12219
12220
12221
12222
12223
12224
12225
12226
12227
12228
12229
12230
12231
12232
12233
12234
12235
12236
12237
12238
12239
12240
12241
12242
12243
12244
12245
12246
12247
12248
12249
12250
12251
12252
12253
12254
12255
12256
12257
12258
12259
12260
12261
12262
12263
12264
12265
12266
12267
12268
12269
12270
12271
12272
12273
12274
12275
12276
12277
12278
12279
12280
12281
12282
12283
12284
12285
12286
12287
12288
12289
12290
12291
12292
12293
12294
12295
12296
12297
12298
12299
12300
12301
12302
12303
12304
12305
12306
12307
12308
12309
12310
12311
12312
12313
12314
12315
12316
12317
12318
12319
12320
12321
12322
12323
12324
12325
12326
12327
12328
12329
12330
12331
12332
12333
12334
12335
12336
12337
12338
12339
12340
12341
12342
12343
12344
12345
12346
12347
12348
12349
12350
12351
12352
12353
12354
12355
12356
12357
12358
12359
12360
12361
12362
12363
12364
12365
12366
12367
12368
12369
12370
12371
12372
12373
12374
12375
12376
12377
12378
12379
12380
12381
12382
12383
12384
12385
12386
12387
12388
12389
12390
12391
12392
12393
12394
12395
12396
12397
12398
12399
12400
12401
12402
12403
12404
12405
12406
12407
12408
12409
12410
12411
12412
12413
12414
12415
12416
12417
12418
12419
12420
12421
12422
12423
12424
12425
12426
12427
12428
12429
12430
12431
12432
12433
12434
12435
12436
12437
12438
12439
12440
12441
12442
12443
12444
12445
12446
12447
12448
12449
12450
12451
12452
12453
12454
12455
12456
12457
12458
12459
12460
12461
12462
12463
12464
12465
12466
12467
12468
12469
12470
12471
12472
12473
12474
12475
12476
12477
12478
12479
12480
12481
12482
12483
12484
12485
12486
12487
12488
12489
12490
12491
12492
12493
12494
12495
12496
12497
12498
12499
12500
12501
12502
12503
12504
12505
12506
12507
12508
12509
12510
12511
12512
12513
12514
12515
12516
12517
12518
12519
12520
12521
12522
12523
12524
12525
12526
12527
12528
12529
12530
12531
12532
12533
12534
12535
12536
12537
12538
12539
12540
12541
12542
12543
12544
12545
12546
12547
12548
12549
12550
12551
12552
12553
12554
12555
12556
12557
12558
12559
12560
12561
12562
12563
12564
12565
12566
12567
12568
12569
12570
12571
12572
12573
12574
12575
12576
12577
12578
12579
12580
12581
12582
12583
12584
12585
12586
12587
12588
12589
12590
12591
12592
12593
12594
12595
12596
12597
12598
12599
12600
12601
12602
12603
12604
12605
12606
12607
12608
12609
12610
12611
12612
12613
12614
12615
12616
12617
12618
12619
12620
12621
12622
12623
12624
12625
12626
12627
12628
12629
12630
12631
12632
12633
12634
12635
12636
12637
12638
12639
12640
12641
12642
12643
12644
12645
12646
12647
12648
12649
12650
12651
12652
12653
12654
12655
12656
12657
12658
12659
12660
12661
12662
12663
12664
12665
12666
12667
12668
12669
12670
12671
12672
12673
12674
12675
12676
12677
12678
12679
12680
12681
12682
12683
12684
12685
12686
12687
12688
12689
12690
12691
12692
12693
12694
12695
12696
12697
12698
12699
12700
12701
12702
12703
12704
12705
12706
12707
12708
12709
12710
12711
12712
12713
12714
12715
12716
12717
12718
12719
12720
12721
12722
12723
12724
12725
12726
12727
12728
12729
12730
12731
12732
12733
12734
12735
12736
12737
12738
12739
12740
12741
12742
12743
12744
12745
12746
12747
12748
12749
12750
12751
12752
12753
12754
12755
12756
12757
12758
12759
12760
12761
12762
12763
12764
12765
12766
12767
12768
12769
12770
12771
12772
12773
12774
12775
12776
12777
12778
12779
12780
12781
12782
12783
12784
12785
12786
12787
12788
12789
12790
12791
12792
12793
12794
12795
12796
12797
12798
12799
12800
12801
12802
12803
12804
12805
12806
12807
12808
12809
12810
12811
12812
12813
12814
12815
12816
12817
12818
12819
12820
12821
12822
12823
12824
12825
12826
12827
12828
12829
12830
12831
12832
12833
12834
12835
12836
12837
12838
12839
12840
12841
12842
12843
12844
12845
12846
12847
12848
12849
12850
12851
12852
12853
12854
12855
12856
12857
12858
12859
12860
12861
12862
12863
12864
12865
12866
12867
12868
12869
12870
12871
12872
12873
12874
12875
12876
12877
12878
12879
12880
12881
12882
12883
12884
12885
12886
12887
12888
12889
12890
12891
12892
12893
12894
12895
12896
12897
12898
12899
12900
12901
12902
12903
12904
12905
12906
12907
12908
12909
12910
12911
12912
12913
12914
12915
12916
12917
12918
12919
12920
12921
12922
12923
12924
12925
12926
12927
12928
12929
12930
12931
12932
12933
12934
12935
12936
12937
12938
12939
12940
12941
12942
12943
12944
12945
12946
12947
12948
12949
12950
12951
12952
12953
12954
12955
12956
12957
12958
12959
12960
12961
12962
12963
12964
12965
12966
12967
12968
12969
12970
12971
12972
12973
12974
12975
12976
12977
12978
12979
12980
12981
12982
12983
12984
12985
12986
12987
12988
12989
12990
12991
12992
12993
12994
12995
12996
12997
12998
12999
13000
13001
13002
13003
13004
13005
13006
13007
13008
13009
13010
13011
13012
13013
13014
13015
13016
13017
13018
13019
13020
13021
13022
13023
13024
13025
13026
13027
13028
13029
13030
13031
13032
13033
13034
13035
13036
13037
13038
13039
13040
13041
13042
13043
13044
13045
13046
13047
13048
13049
13050
13051
13052
13053
13054
13055
13056
13057
13058
13059
13060
13061
13062
13063
13064
13065
13066
13067
13068
13069
13070
13071
13072
13073
13074
13075
13076
13077
13078
13079
13080
13081
13082
13083
13084
13085
13086
13087
13088
13089
13090
13091
13092
13093
13094
13095
13096
13097
13098
13099
13100
13101
13102
13103
13104
13105
13106
13107
13108
13109
13110
13111
13112
13113
13114
13115
13116
13117
13118
13119
13120
13121
13122
13123
13124
13125
13126
13127
13128
13129
13130
13131
13132
13133
13134
13135
13136
13137
13138
13139
13140
13141
13142
13143
13144
13145
13146
13147
13148
13149
13150
13151
13152
13153
13154
13155
13156
13157
13158
13159
13160
13161
13162
13163
13164
13165
13166
13167
13168
13169
13170
13171
13172
13173
13174
13175
13176
13177
13178
13179
13180
13181
13182
13183
13184
13185
13186
13187
13188
13189
13190
13191
13192
13193
13194
13195
13196
13197
13198
13199
13200
13201
13202
13203
13204
13205
13206
13207
13208
13209
13210
13211
13212
13213
13214
13215
13216
13217
13218
13219
13220
13221
13222
13223
13224
13225
13226
13227
13228
13229
13230
13231
13232
13233
13234
13235
13236
13237
13238
13239
13240
13241
13242
13243
13244
13245
13246
13247
13248
13249
13250
13251
13252
13253
13254
13255
13256
13257
13258
13259
13260
13261
13262
13263
13264
13265
13266
13267
13268
13269
13270
13271
13272
13273
13274
13275
13276
13277
13278
13279
13280
13281
13282
13283
13284
13285
13286
13287
13288
13289
13290
13291
13292
13293
13294
13295
13296
13297
13298
13299
13300
13301
13302
13303
13304
13305
13306
13307
13308
13309
13310
13311
13312
13313
13314
13315
13316
13317
13318
13319
13320
13321
13322
13323
13324
13325
13326
13327
13328
13329
13330
13331
13332
13333
13334
13335
13336
13337
13338
13339
13340
13341
13342
13343
13344
13345
13346
13347
13348
13349
13350
13351
13352
13353
13354
13355
13356
13357
13358
13359
13360
13361
13362
13363
13364
13365
13366
13367
13368
13369
13370
13371
13372
13373
13374
13375
13376
13377
13378
13379
13380
13381
13382
13383
13384
13385
13386
13387
13388
13389
13390
13391
13392
13393
13394
13395
13396
13397
13398
13399
13400
13401
13402
13403
13404
13405
13406
13407
13408
13409
13410
13411
13412
13413
13414
13415
13416
13417
13418
13419
13420
13421
13422
13423
13424
13425
13426
13427
13428
13429
13430
13431
13432
13433
13434
13435
13436
13437
13438
13439
13440
13441
13442
13443
13444
13445
13446
13447
13448
13449
13450
13451
13452
13453
13454
13455
13456
13457
13458
13459
13460
13461
13462
13463
13464
13465
13466
13467
13468
13469
13470
13471
13472
13473
13474
13475
13476
13477
13478
13479
13480
13481
13482
13483
13484
13485
13486
13487
13488
13489
13490
13491
13492
13493
13494
13495
13496
13497
13498
13499
13500
13501
13502
13503
13504
13505
13506
13507
13508
13509
13510
13511
13512
13513
13514
13515
13516
13517
13518
13519
13520
13521
13522
13523
13524
13525
13526
13527
13528
13529
13530
13531
13532
13533
13534
13535
13536
13537
13538
13539
13540
13541
13542
13543
13544
13545
13546
13547
13548
13549
13550
13551
13552
13553
13554
13555
13556
13557
13558
13559
13560
13561
13562
13563
13564
13565
13566
13567
13568
13569
13570
13571
13572
13573
13574
13575
13576
13577
13578
13579
13580
13581
13582
13583
13584
13585
13586
13587
13588
13589
13590
13591
13592
13593
13594
13595
13596
13597
13598
13599
13600
13601
13602
13603
13604
13605
13606
13607
13608
13609
13610
13611
13612
13613
13614
13615
13616
13617
13618
13619
13620
13621
13622
13623
13624
13625
13626
13627
13628
13629
13630
13631
13632
13633
13634
13635
13636
13637
13638
13639
13640
13641
13642
13643
13644
13645
13646
13647
13648
13649
13650
13651
13652
13653
13654
13655
13656
13657
13658
13659
13660
13661
13662
13663
13664
13665
13666
13667
13668
13669
13670
13671
13672
13673
13674
13675
13676
13677
13678
13679
13680
13681
13682
13683
13684
13685
13686
13687
13688
13689
13690
13691
13692
13693
13694
13695
13696
13697
13698
13699
13700
13701
13702
13703
13704
13705
13706
13707
13708
13709
13710
13711
13712
13713
13714
13715
13716
13717
13718
13719
13720
13721
13722
13723
13724
13725
13726
13727
13728
13729
13730
13731
13732
13733
13734
13735
13736
13737
13738
13739
13740
13741
13742
13743
13744
13745
13746
13747
13748
13749
13750
13751
13752
13753
13754
13755
13756
13757
13758
13759
13760
13761
13762
13763
13764
13765
13766
13767
13768
13769
13770
13771
13772
13773
13774
13775
13776
13777
13778
13779
13780
13781
13782
13783
13784
13785
13786
13787
13788
13789
13790
13791
13792
13793
13794
13795
13796
13797
13798
13799
13800
13801
13802
13803
13804
13805
13806
13807
13808
13809
13810
13811
13812
13813
13814
13815
13816
13817
13818
13819
13820
13821
13822
13823
13824
13825
13826
13827
13828
13829
13830
13831
13832
13833
13834
13835
13836
13837
13838
13839
13840
13841
13842
13843
13844
13845
13846
13847
13848
13849
13850
13851
13852
13853
13854
13855
13856
13857
13858
13859
13860
13861
13862
13863
13864
13865
13866
13867
13868
13869
13870
13871
13872
13873
13874
13875
13876
13877
13878
13879
13880
13881
13882
13883
13884
13885
13886
13887
13888
13889
13890
13891
13892
13893
13894
13895
13896
13897
13898
13899
13900
13901
13902
13903
13904
13905
13906
13907
13908
13909
13910
13911
13912
13913
13914
13915
13916
13917
13918
13919
13920
13921
13922
13923
13924
13925
13926
13927
13928
13929
13930
13931
13932
13933
13934
13935
13936
13937
13938
13939
13940
13941
13942
13943
13944
13945
13946
13947
13948
13949
13950
13951
13952
13953
13954
13955
13956
13957
13958
13959
13960
13961
13962
13963
13964
13965
13966
13967
13968
13969
13970
13971
13972
13973
13974
13975
13976
13977
13978
13979
13980
13981
13982
13983
13984
13985
13986
13987
13988
13989
13990
13991
13992
13993
13994
13995
13996
13997
13998
13999
14000
14001
14002
14003
14004
14005
14006
14007
14008
14009
14010
14011
14012
14013
14014
14015
14016
14017
14018
14019
14020
14021
14022
14023
14024
14025
14026
14027
14028
14029
14030
14031
14032
14033
14034
14035
14036
14037
14038
14039
14040
14041
14042
14043
14044
14045
14046
14047
14048
14049
14050
14051
14052
14053
14054
14055
14056
14057
14058
14059
14060
14061
14062
14063
14064
14065
14066
14067
14068
14069
14070
14071
14072
14073
14074
14075
14076
14077
14078
14079
14080
14081
14082
14083
14084
14085
14086
14087
14088
14089
14090
14091
14092
14093
14094
14095
14096
14097
14098
14099
14100
14101
14102
14103
14104
14105
14106
14107
14108
14109
14110
14111
14112
14113
14114
14115
14116
14117
14118
14119
14120
14121
14122
14123
14124
14125
14126
14127
14128
14129
14130
14131
14132
14133
14134
14135
14136
14137
14138
14139
14140
14141
14142
14143
14144
14145
14146
14147
14148
14149
14150
14151
14152
14153
14154
14155
14156
14157
14158
14159
14160
14161
14162
14163
14164
14165
14166
14167
14168
14169
14170
14171
14172
14173
14174
14175
14176
14177
14178
14179
14180
14181
14182
14183
14184
14185
14186
14187
14188
14189
14190
14191
14192
14193
14194
14195
14196
14197
14198
14199
14200
14201
14202
14203
14204
14205
14206
14207
14208
14209
14210
14211
14212
14213
14214
14215
14216
14217
14218
14219
14220
14221
14222
14223
14224
14225
14226
14227
14228
14229
14230
14231
14232
14233
14234
14235
14236
14237
14238
14239
14240
14241
14242
14243
14244
14245
14246
14247
14248
14249
14250
14251
14252
14253
14254
14255
14256
14257
14258
14259
14260
14261
14262
14263
14264
14265
14266
14267
14268
14269
14270
14271
14272
14273
14274
14275
14276
14277
14278
14279
14280
14281
14282
14283
14284
14285
14286
14287
14288
14289
14290
14291
14292
14293
14294
14295
14296
14297
14298
14299
14300
14301
14302
14303
14304
14305
14306
14307
14308
14309
14310
14311
14312
14313
14314
14315
14316
14317
14318
14319
14320
14321
14322
14323
14324
14325
14326
14327
14328
14329
14330
14331
14332
14333
14334
14335
14336
14337
14338
14339
14340
14341
14342
14343
14344
14345
14346
14347
14348
14349
14350
14351
14352
14353
14354
14355
14356
14357
14358
14359
14360
14361
14362
14363
14364
14365
14366
14367
14368
14369
14370
14371
14372
14373
14374
14375
14376
14377
14378
14379
14380
14381
14382
14383
14384
14385
14386
14387
14388
14389
14390
14391
14392
14393
14394
14395
14396
14397
14398
14399
14400
14401
14402
14403
14404
14405
14406
14407
14408
14409
14410
14411
14412
14413
14414
14415
14416
14417
14418
14419
14420
14421
14422
14423
14424
14425
14426
14427
14428
14429
14430
14431
14432
14433
14434
14435
14436
14437
14438
14439
14440
14441
14442
14443
14444
14445
14446
14447
14448
14449
14450
14451
14452
14453
14454
14455
14456
14457
14458
14459
14460
14461
14462
14463
14464
14465
14466
14467
14468
14469
14470
14471
14472
14473
14474
14475
14476
14477
14478
14479
14480
14481
14482
14483
14484
14485
14486
14487
14488
14489
14490
14491
14492
14493
14494
14495
14496
14497
14498
14499
14500
14501
14502
14503
14504
14505
14506
14507
14508
14509
14510
14511
14512
14513
14514
14515
14516
14517
14518
14519
14520
14521
14522
14523
14524
14525
14526
14527
14528
14529
14530
14531
14532
14533
14534
14535
14536
14537
14538
14539
14540
14541
14542
14543
14544
14545
14546
14547
14548
14549
14550
14551
14552
14553
14554
14555
14556
14557
14558
14559
14560
14561
14562
14563
14564
14565
14566
14567
14568
14569
14570
14571
14572
14573
14574
14575
14576
14577
14578
14579
14580
14581
14582
14583
14584
14585
14586
14587
14588
14589
14590
14591
14592
14593
14594
14595
14596
14597
14598
14599
14600
14601
14602
14603
14604
14605
14606
14607
14608
14609
14610
14611
14612
14613
14614
14615
14616
14617
14618
14619
14620
14621
14622
14623
14624
14625
14626
14627
14628
14629
14630
14631
14632
14633
14634
14635
14636
14637
14638
14639
14640
14641
14642
14643
14644
14645
14646
14647
14648
14649
14650
14651
14652
14653
14654
14655
14656
14657
14658
14659
14660
14661
14662
14663
14664
14665
14666
14667
14668
14669
14670
14671
14672
14673
14674
14675
14676
14677
14678
14679
14680
14681
14682
14683
14684
14685
14686
14687
14688
14689
14690
14691
14692
14693
14694
14695
14696
14697
14698
14699
14700
14701
14702
14703
14704
14705
14706
14707
14708
14709
14710
14711
14712
14713
14714
14715
14716
14717
14718
14719
14720
14721
14722
14723
14724
14725
14726
14727
14728
14729
14730
14731
14732
14733
14734
14735
14736
14737
14738
14739
14740
14741
14742
14743
14744
14745
14746
14747
14748
14749
14750
14751
14752
14753
14754
14755
14756
14757
14758
14759
14760
14761
14762
14763
14764
14765
14766
14767
14768
14769
14770
14771
14772
14773
14774
14775
14776
14777
14778
14779
14780
14781
14782
14783
14784
14785
14786
14787
14788
14789
14790
14791
14792
14793
14794
14795
14796
14797
14798
14799
14800
14801
14802
14803
14804
14805
14806
14807
14808
14809
14810
14811
14812
14813
14814
14815
14816
14817
14818
14819
14820
14821
14822
14823
14824
14825
14826
14827
14828
14829
14830
14831
14832
14833
14834
14835
14836
14837
14838
14839
14840
14841
14842
14843
14844
14845
14846
14847
14848
14849
14850
14851
14852
14853
14854
14855
14856
14857
14858
14859
14860
14861
14862
14863
14864
14865
14866
14867
14868
14869
14870
14871
14872
14873
14874
14875
14876
14877
14878
14879
14880
14881
14882
14883
14884
14885
14886
14887
14888
14889
14890
14891
14892
14893
14894
14895
14896
14897
14898
14899
14900
14901
14902
14903
14904
14905
14906
14907
14908
14909
14910
14911
14912
14913
14914
14915
14916
14917
14918
14919
14920
14921
14922
14923
14924
14925
14926
14927
14928
14929
14930
14931
14932
14933
14934
14935
14936
14937
14938
14939
14940
14941
14942
14943
14944
14945
14946
14947
14948
14949
14950
14951
14952
14953
14954
14955
14956
14957
14958
14959
14960
14961
14962
14963
14964
14965
14966
14967
14968
14969
14970
14971
14972
14973
14974
14975
14976
14977
14978
14979
14980
14981
14982
14983
14984
14985
14986
14987
14988
14989
14990
14991
14992
14993
14994
14995
14996
14997
14998
14999
15000
15001
15002
15003
15004
15005
15006
15007
15008
15009
15010
15011
15012
15013
15014
15015
15016
15017
15018
15019
15020
15021
15022
15023
15024
15025
15026
15027
15028
15029
15030
15031
15032
15033
15034
15035
15036
15037
15038
15039
15040
15041
15042
15043
15044
15045
15046
15047
15048
15049
15050
15051
15052
15053
15054
15055
15056
15057
15058
15059
15060
15061
15062
15063
15064
15065
15066
15067
15068
15069
15070
15071
15072
15073
15074
15075
15076
15077
15078
15079
15080
15081
15082
15083
15084
15085
15086
15087
15088
15089
15090
15091
15092
15093
15094
15095
15096
15097
15098
15099
15100
15101
15102
15103
15104
15105
15106
15107
15108
15109
15110
15111
15112
15113
15114
15115
15116
15117
15118
15119
15120
15121
15122
15123
15124
15125
15126
15127
15128
15129
15130
15131
15132
15133
15134
15135
15136
15137
15138
15139
15140
15141
15142
15143
15144
15145
15146
15147
15148
15149
15150
15151
15152
15153
15154
15155
15156
15157
15158
15159
15160
15161
15162
15163
15164
15165
15166
15167
15168
15169
15170
15171
15172
15173
15174
15175
15176
15177
15178
15179
15180
15181
15182
15183
15184
15185
15186
15187
15188
15189
15190
15191
15192
15193
15194
15195
15196
15197
15198
15199
15200
15201
15202
15203
15204
15205
15206
15207
15208
15209
15210
15211
15212
15213
15214
15215
15216
15217
15218
15219
15220
15221
15222
15223
15224
15225
15226
15227
15228
15229
15230
15231
15232
15233
15234
15235
15236
15237
15238
15239
15240
15241
15242
15243
15244
15245
15246
15247
15248
15249
15250
15251
15252
15253
15254
15255
15256
15257
15258
15259
15260
15261
15262
15263
15264
15265
15266
15267
15268
15269
15270
15271
15272
15273
15274
15275
15276
15277
15278
15279
15280
15281
15282
15283
15284
15285
15286
15287
15288
15289
15290
15291
15292
15293
15294
15295
15296
15297
15298
15299
15300
15301
15302
15303
15304
15305
15306
15307
15308
15309
15310
15311
15312
15313
15314
15315
15316
15317
15318
15319
15320
15321
15322
15323
15324
15325
15326
15327
15328
15329
15330
15331
15332
15333
15334
15335
15336
15337
15338
15339
15340
15341
15342
15343
15344
15345
15346
15347
15348
15349
15350
15351
15352
15353
15354
15355
15356
15357
15358
15359
15360
15361
15362
15363
15364
15365
15366
15367
15368
15369
15370
15371
15372
15373
15374
15375
15376
15377
15378
15379
15380
15381
15382
15383
15384
15385
15386
15387
15388
15389
15390
15391
15392
15393
15394
15395
15396
15397
15398
15399
15400
15401
15402
15403
15404
15405
15406
15407
15408
15409
15410
15411
15412
15413
15414
15415
15416
15417
15418
15419
15420
15421
15422
15423
15424
15425
15426
15427
15428
15429
15430
15431
15432
15433
15434
15435
15436
15437
15438
15439
15440
15441
15442
15443
15444
15445
15446
15447
15448
15449
15450
15451
15452
15453
15454
15455
15456
15457
15458
15459
15460
15461
15462
15463
15464
15465
15466
15467
15468
15469
15470
15471
15472
15473
15474
15475
15476
15477
15478
15479
15480
15481
15482
15483
15484
15485
15486
15487
15488
15489
15490
15491
15492
15493
15494
15495
15496
15497
15498
15499
15500
15501
15502
15503
15504
15505
15506
15507
15508
15509
15510
15511
15512
15513
15514
15515
15516
15517
15518
15519
15520
15521
15522
15523
15524
15525
15526
15527
15528
15529
15530
15531
15532
15533
15534
15535
15536
15537
15538
15539
15540
15541
15542
15543
15544
15545
15546
15547
15548
15549
15550
15551
15552
15553
15554
15555
15556
15557
15558
15559
15560
15561
15562
15563
15564
15565
15566
15567
15568
15569
15570
15571
15572
15573
15574
15575
15576
15577
15578
15579
15580
15581
15582
15583
15584
15585
15586
15587
15588
15589
15590
15591
15592
15593
15594
15595
15596
15597
15598
15599
15600
15601
15602
15603
15604
15605
15606
15607
15608
15609
15610
15611
15612
15613
15614
15615
15616
15617
15618
15619
15620
15621
15622
15623
15624
15625
15626
15627
15628
15629
15630
15631
15632
15633
15634
15635
15636
15637
15638
15639
15640
15641
15642
15643
15644
15645
15646
15647
15648
15649
15650
15651
15652
15653
15654
15655
15656
15657
15658
15659
15660
15661
15662
15663
15664
15665
15666
15667
15668
15669
15670
15671
15672
15673
15674
15675
15676
15677
15678
15679
15680
15681
15682
15683
15684
15685
15686
15687
15688
15689
15690
15691
15692
15693
15694
15695
15696
15697
15698
15699
15700
15701
15702
15703
15704
15705
15706
15707
15708
15709
15710
15711
15712
15713
15714
15715
15716
15717
15718
15719
15720
15721
15722
15723
15724
15725
15726
15727
15728
15729
15730
15731
15732
15733
15734
15735
15736
15737
15738
15739
15740
15741
15742
15743
15744
15745
15746
15747
15748
15749
15750
15751
15752
15753
15754
15755
15756
15757
15758
15759
15760
15761
15762
15763
15764
15765
15766
15767
15768
15769
15770
15771
15772
15773
15774
15775
15776
15777
15778
15779
15780
15781
15782
15783
15784
15785
15786
15787
15788
15789
15790
15791
15792
15793
15794
15795
15796
15797
15798
15799
15800
15801
15802
15803
15804
15805
15806
15807
15808
15809
15810
15811
15812
15813
15814
15815
15816
15817
15818
15819
15820
15821
15822
15823
15824
15825
15826
15827
15828
15829
15830
15831
15832
15833
15834
15835
15836
15837
15838
15839
15840
15841
15842
15843
15844
15845
15846
15847
15848
15849
15850
15851
15852
15853
15854
15855
15856
15857
15858
15859
15860
15861
15862
15863
15864
15865
15866
15867
15868
15869
15870
15871
15872
15873
15874
15875
15876
15877
15878
15879
15880
15881
15882
15883
15884
15885
15886
15887
15888
15889
15890
15891
15892
15893
15894
15895
15896
15897
15898
15899
15900
15901
15902
15903
15904
15905
15906
15907
15908
15909
15910
15911
15912
15913
15914
15915
15916
15917
15918
15919
15920
15921
15922
15923
15924
15925
15926
15927
15928
15929
15930
15931
15932
15933
15934
15935
15936
15937
15938
15939
15940
15941
15942
15943
15944
15945
15946
15947
15948
15949
15950
15951
15952
15953
15954
15955
15956
15957
15958
15959
15960
15961
15962
15963
15964
15965
15966
15967
15968
15969
15970
15971
15972
15973
15974
15975
15976
15977
15978
15979
15980
15981
15982
15983
15984
15985
15986
15987
15988
15989
15990
15991
15992
15993
15994
15995
15996
15997
15998
15999
16000
16001
16002
16003
16004
16005
16006
16007
16008
16009
16010
16011
16012
16013
16014
16015
16016
16017
16018
16019
16020
16021
16022
16023
16024
16025
16026
16027
16028
16029
16030
16031
16032
16033
16034
16035
16036
16037
16038
16039
16040
16041
16042
16043
16044
16045
16046
16047
16048
16049
16050
16051
16052
16053
16054
16055
16056
16057
16058
16059
16060
16061
16062
16063
16064
16065
16066
16067
16068
16069
16070
16071
16072
16073
16074
16075
16076
16077
16078
16079
16080
16081
16082
16083
16084
16085
16086
16087
16088
16089
16090
16091
16092
16093
16094
16095
16096
16097
16098
16099
16100
16101
16102
16103
16104
16105
16106
16107
16108
16109
16110
16111
16112
16113
16114
16115
16116
16117
16118
16119
16120
16121
16122
16123
16124
16125
16126
16127
16128
16129
16130
16131
16132
16133
16134
16135
16136
16137
16138
16139
16140
16141
16142
16143
16144
16145
16146
16147
16148
16149
16150
16151
16152
16153
16154
16155
16156
16157
16158
16159
16160
16161
16162
16163
16164
16165
16166
16167
16168
16169
16170
16171
16172
16173
16174
16175
16176
16177
16178
16179
16180
16181
16182
16183
16184
16185
16186
16187
16188
16189
16190
16191
16192
16193
16194
16195
16196
16197
16198
16199
16200
16201
16202
16203
16204
16205
16206
16207
16208
16209
16210
16211
16212
16213
16214
16215
16216
16217
16218
16219
16220
16221
16222
16223
16224
16225
16226
16227
16228
16229
16230
16231
16232
16233
16234
16235
16236
16237
16238
16239
16240
16241
16242
16243
16244
16245
16246
16247
16248
16249
16250
16251
16252
16253
16254
16255
16256
16257
16258
16259
16260
16261
16262
16263
16264
16265
16266
16267
16268
16269
16270
16271
16272
16273
16274
16275
16276
16277
16278
16279
16280
16281
16282
16283
16284
16285
16286
16287
16288
16289
16290
16291
16292
16293
16294
16295
16296
16297
16298
16299
16300
16301
16302
16303
16304
16305
16306
16307
16308
16309
16310
16311
16312
16313
16314
16315
16316
16317
16318
16319
16320
16321
16322
16323
16324
16325
16326
16327
16328
16329
16330
16331
16332
16333
16334
16335
16336
16337
16338
16339
16340
16341
16342
16343
16344
16345
16346
16347
16348
16349
16350
16351
16352
16353
16354
16355
16356
16357
16358
16359
16360
16361
16362
16363
16364
16365
16366
16367
16368
16369
16370
16371
16372
16373
16374
16375
16376
16377
16378
16379
16380
16381
16382
16383
16384
16385
16386
16387
16388
16389
16390
16391
16392
16393
16394
16395
16396
16397
16398
16399
16400
16401
16402
16403
16404
16405
16406
16407
16408
16409
16410
16411
16412
16413
16414
16415
16416
16417
16418
16419
16420
16421
16422
16423
16424
16425
16426
16427
16428
16429
16430
16431
16432
16433
16434
16435
16436
16437
16438
16439
16440
16441
16442
16443
16444
16445
16446
16447
16448
16449
16450
16451
16452
16453
16454
16455
16456
16457
16458
16459
16460
16461
16462
16463
16464
16465
16466
16467
16468
16469
16470
16471
16472
16473
16474
16475
16476
16477
16478
16479
16480
16481
16482
16483
16484
16485
16486
16487
16488
16489
16490
16491
16492
16493
16494
16495
16496
16497
16498
16499
16500
16501
16502
16503
16504
16505
16506
16507
16508
16509
16510
16511
16512
16513
16514
16515
16516
16517
16518
16519
16520
16521
16522
16523
16524
16525
16526
16527
16528
16529
16530
16531
16532
16533
16534
16535
16536
16537
16538
16539
16540
16541
16542
16543
16544
16545
16546
16547
16548
16549
16550
16551
16552
16553
16554
16555
16556
16557
16558
16559
16560
16561
16562
16563
16564
16565
16566
16567
16568
16569
16570
16571
16572
16573
16574
16575
16576
16577
16578
16579
16580
16581
16582
16583
16584
16585
16586
16587
16588
16589
16590
16591
16592
16593
16594
16595
16596
16597
16598
16599
16600
16601
16602
16603
16604
16605
16606
16607
16608
16609
16610
16611
16612
16613
16614
16615
16616
16617
16618
16619
16620
16621
16622
16623
16624
16625
16626
16627
16628
16629
16630
16631
16632
16633
16634
16635
16636
16637
16638
16639
16640
16641
16642
16643
16644
16645
16646
16647
16648
16649
16650
16651
16652
16653
16654
16655
16656
16657
16658
16659
16660
16661
16662
16663
16664
16665
16666
16667
16668
16669
16670
16671
16672
16673
16674
16675
16676
16677
16678
16679
16680
16681
16682
16683
16684
16685
16686
16687
16688
16689
16690
16691
16692
16693
16694
16695
16696
16697
16698
16699
16700
16701
16702
16703
16704
16705
16706
16707
16708
16709
16710
16711
16712
16713
16714
16715
16716
16717
16718
16719
16720
16721
16722
16723
16724
16725
16726
16727
16728
16729
16730
16731
16732
16733
16734
16735
16736
16737
16738
16739
16740
16741
16742
16743
16744
16745
16746
16747
16748
16749
16750
16751
16752
16753
16754
16755
16756
16757
16758
16759
16760
16761
16762
16763
16764
16765
16766
16767
16768
16769
16770
16771
16772
16773
16774
16775
16776
16777
16778
16779
16780
16781
16782
16783
16784
16785
16786
16787
16788
16789
16790
16791
16792
16793
16794
16795
16796
16797
16798
16799
16800
16801
16802
16803
16804
16805
16806
16807
16808
16809
16810
16811
16812
16813
16814
16815
16816
16817
16818
16819
16820
16821
16822
16823
16824
16825
16826
16827
16828
16829
16830
16831
16832
16833
16834
16835
16836
16837
16838
16839
16840
16841
16842
16843
16844
16845
16846
16847
16848
16849
16850
16851
16852
16853
16854
16855
16856
16857
16858
16859
16860
16861
16862
16863
16864
16865
16866
16867
16868
16869
16870
16871
16872
16873
16874
16875
16876
16877
16878
16879
16880
16881
16882
16883
16884
16885
16886
16887
16888
16889
16890
16891
16892
16893
16894
16895
16896
16897
16898
16899
16900
16901
16902
16903
16904
16905
16906
16907
16908
16909
16910
16911
16912
16913
16914
16915
16916
16917
16918
16919
16920
16921
16922
16923
16924
16925
16926
16927
16928
16929
16930
16931
16932
16933
16934
16935
16936
16937
16938
16939
16940
16941
16942
16943
16944
16945
16946
16947
16948
16949
16950
16951
16952
16953
16954
16955
16956
16957
16958
16959
16960
16961
16962
16963
16964
16965
16966
16967
16968
16969
16970
16971
16972
16973
16974
16975
16976
16977
16978
16979
16980
16981
16982
16983
16984
16985
16986
16987
16988
16989
16990
16991
16992
16993
16994
16995
16996
16997
16998
16999
17000
17001
17002
17003
17004
17005
17006
17007
17008
17009
17010
17011
17012
17013
17014
17015
17016
17017
17018
17019
17020
17021
17022
17023
17024
17025
17026
17027
17028
17029
17030
17031
17032
17033
17034
17035
17036
17037
17038
17039
17040
17041
17042
17043
17044
17045
17046
17047
17048
17049
17050
17051
17052
17053
17054
17055
17056
17057
17058
17059
17060
17061
17062
17063
17064
17065
17066
17067
17068
17069
17070
17071
17072
17073
17074
17075
17076
17077
17078
17079
17080
17081
17082
17083
17084
17085
17086
17087
17088
17089
17090
17091
17092
17093
17094
17095
17096
17097
17098
17099
17100
17101
17102
17103
17104
17105
17106
17107
17108
17109
17110
17111
17112
17113
17114
17115
17116
17117
17118
17119
17120
17121
17122
17123
17124
17125
17126
17127
17128
17129
17130
17131
17132
17133
17134
17135
17136
17137
17138
17139
17140
17141
17142
17143
17144
17145
17146
17147
17148
17149
17150
17151
17152
17153
17154
17155
17156
17157
17158
17159
17160
17161
17162
17163
17164
17165
17166
17167
17168
17169
17170
17171
17172
17173
17174
17175
17176
17177
17178
17179
17180
17181
17182
17183
17184
17185
17186
17187
17188
17189
17190
17191
17192
17193
17194
17195
17196
17197
17198
17199
17200
17201
17202
17203
17204
17205
17206
17207
17208
17209
17210
17211
17212
17213
17214
17215
17216
17217
17218
17219
17220
17221
17222
17223
17224
17225
17226
17227
17228
17229
17230
17231
17232
17233
17234
17235
17236
17237
17238
17239
17240
17241
17242
17243
17244
17245
17246
17247
17248
17249
17250
17251
17252
17253
17254
17255
17256
17257
17258
17259
17260
17261
17262
17263
17264
17265
17266
17267
17268
17269
17270
17271
17272
17273
17274
17275
17276
17277
17278
17279
17280
17281
17282
17283
17284
17285
17286
17287
17288
17289
17290
17291
17292
17293
17294
17295
17296
17297
17298
17299
17300
17301
17302
17303
17304
17305
17306
17307
17308
17309
17310
17311
17312
17313
17314
17315
17316
17317
17318
17319
17320
17321
17322
17323
17324
17325
17326
17327
17328
17329
17330
17331
17332
17333
17334
17335
17336
17337
17338
17339
17340
17341
17342
17343
17344
17345
17346
17347
17348
17349
17350
17351
17352
17353
17354
17355
17356
17357
17358
17359
17360
17361
17362
17363
17364
17365
17366
17367
17368
17369
17370
17371
17372
17373
17374
17375
17376
17377
17378
17379
17380
17381
17382
17383
17384
17385
17386
17387
17388
17389
17390
17391
17392
17393
17394
17395
17396
17397
17398
17399
17400
17401
17402
17403
17404
17405
17406
17407
17408
17409
17410
17411
17412
17413
17414
17415
17416
17417
17418
17419
17420
17421
17422
17423
17424
17425
17426
17427
17428
17429
17430
17431
17432
17433
17434
17435
17436
17437
17438
17439
17440
17441
17442
17443
17444
17445
17446
17447
17448
17449
17450
17451
17452
17453
17454
17455
17456
17457
17458
17459
17460
17461
17462
17463
17464
17465
17466
17467
17468
17469
17470
17471
17472
17473
17474
17475
17476
17477
17478
17479
17480
17481
17482
17483
17484
17485
17486
17487
17488
17489
17490
17491
17492
17493
17494
17495
17496
17497
17498
17499
17500
17501
17502
17503
17504
17505
17506
17507
17508
17509
17510
17511
17512
17513
17514
17515
17516
17517
17518
17519
17520
17521
17522
17523
17524
17525
17526
17527
17528
17529
17530
17531
17532
17533
17534
17535
17536
17537
17538
17539
17540
17541
17542
17543
17544
17545
17546
17547
17548
17549
17550
17551
17552
17553
17554
17555
17556
17557
17558
17559
17560
17561
17562
17563
17564
17565
17566
17567
17568
17569
17570
17571
17572
17573
17574
17575
17576
17577
17578
17579
17580
17581
17582
17583
17584
17585
17586
17587
17588
17589
17590
17591
17592
17593
17594
17595
17596
17597
17598
17599
17600
17601
17602
17603
17604
17605
17606
17607
17608
17609
17610
17611
17612
17613
17614
17615
17616
17617
17618
17619
17620
17621
17622
17623
17624
17625
17626
17627
17628
17629
17630
17631
17632
17633
17634
17635
17636
17637
17638
17639
17640
17641
17642
17643
17644
17645
17646
17647
17648
17649
17650
17651
17652
17653
17654
17655
17656
17657
17658
17659
17660
17661
17662
17663
17664
17665
17666
17667
17668
17669
17670
17671
17672
17673
17674
17675
17676 | <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<!-- Created by GNU Texinfo 5.1, http://www.gnu.org/software/texinfo/ -->
<head>
<title>Cfengine v2 reference</title>
<meta name="description" content="Cfengine v2 reference">
<meta name="keywords" content="Cfengine v2 reference">
<meta name="resource-type" content="document">
<meta name="distribution" content="global">
<meta name="Generator" content="makeinfo">
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<link href="#Top" rel="start" title="Top">
<link href="#Variable-Index" rel="index" title="Variable Index">
<link href="#SEC_Contents" rel="contents" title="Table of Contents">
<link href="dir.html#Top" rel="up" title="(dir)">
<style type="text/css">
<!--
a.summary-letter {text-decoration: none}
blockquote.smallquotation {font-size: smaller}
div.display {margin-left: 3.2em}
div.example {margin-left: 3.2em}
div.indentedblock {margin-left: 3.2em}
div.lisp {margin-left: 3.2em}
div.smalldisplay {margin-left: 3.2em}
div.smallexample {margin-left: 3.2em}
div.smallindentedblock {margin-left: 3.2em; font-size: smaller}
div.smalllisp {margin-left: 3.2em}
kbd {font-style:oblique}
pre.display {font-family: inherit}
pre.format {font-family: inherit}
pre.menu-comment {font-family: serif}
pre.menu-preformatted {font-family: serif}
pre.smalldisplay {font-family: inherit; font-size: smaller}
pre.smallexample {font-size: smaller}
pre.smallformat {font-family: inherit; font-size: smaller}
pre.smalllisp {font-size: smaller}
span.nocodebreak {white-space:nowrap}
span.nolinebreak {white-space:nowrap}
span.roman {font-family:serif; font-weight:normal}
span.sansserif {font-family:sans-serif; font-weight:normal}
ul.no-bullet {list-style: none}
-->
</style>
</head>
<body lang="en" bgcolor="#FFFFFF" text="#000000" link="#0000FF" vlink="#800080" alink="#FF0000">
<h1 class="settitle" align="center">Cfengine v2 reference</h1>
<a name="Top"></a>
<div class="header">
<p>
Next: <a href="#Reference-introduction" accesskey="n" rel="next">Reference introduction</a>, Previous: <a href="dir.html#Top" accesskey="p" rel="previous">(dir)</a>, Up: <a href="dir.html#Top" accesskey="u" rel="up">(dir)</a> [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Variable-Index" title="Index" rel="index">Index</a>]</p>
</div>
<a name="Cfengine_002dReference"></a>
<h1 class="top">Cfengine-Reference</h1>
<a href="#Contents"><h1>COMPLETE TABLE OF CONTENTS</h1></a>
<p>
This manual is for version 2.2.10 of cfengine and
was last updated on the 21 January 2009.
</p>
<h2>Summary of contents</h2>
<table class="menu" border="0" cellspacing="0">
<tr><td align="left" valign="top">• <a href="#Reference-introduction" accesskey="1">Reference introduction</a>:</td><td> </td><td align="left" valign="top">
</td></tr>
<tr><td align="left" valign="top">• <a href="#Cfkey" accesskey="2">Cfkey</a>:</td><td> </td><td align="left" valign="top">
</td></tr>
<tr><td align="left" valign="top">• <a href="#Cfshow" accesskey="3">Cfshow</a>:</td><td> </td><td align="left" valign="top">
</td></tr>
<tr><td align="left" valign="top">• <a href="#Cfagent-reference" accesskey="4">Cfagent reference</a>:</td><td> </td><td align="left" valign="top">
</td></tr>
<tr><td align="left" valign="top">• <a href="#Cfservd_002econf-and-cfrun-reference" accesskey="5">Cfservd.conf and cfrun reference</a>:</td><td> </td><td align="left" valign="top">
</td></tr>
<tr><td align="left" valign="top">• <a href="#Cfexecd-reference" accesskey="6">Cfexecd reference</a>:</td><td> </td><td align="left" valign="top">
</td></tr>
<tr><td align="left" valign="top">• <a href="#Problem-solving" accesskey="7">Problem solving</a>:</td><td> </td><td align="left" valign="top">
</td></tr>
<tr><td align="left" valign="top">• <a href="#Example-configuration-file" accesskey="8">Example configuration file</a>:</td><td> </td><td align="left" valign="top">
</td></tr>
<tr><td align="left" valign="top">• <a href="#Variable-Index" accesskey="9">Variable Index</a>:</td><td> </td><td align="left" valign="top">
</td></tr>
<tr><td align="left" valign="top">• <a href="#Concept-Index">Concept Index</a>:</td><td> </td><td align="left" valign="top">
</td></tr>
<tr><td align="left" valign="top">• <a href="#FAQ-Index">FAQ Index</a>:</td><td> </td><td align="left" valign="top">
</td></tr>
</table>
<hr>
<a name="Reference-introduction"></a>
<div class="header">
<p>
Next: <a href="#Cfkey" accesskey="n" rel="next">Cfkey</a>, Previous: <a href="#Top" accesskey="p" rel="previous">Top</a>, Up: <a href="#Top" accesskey="u" rel="up">Top</a> [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Variable-Index" title="Index" rel="index">Index</a>]</p>
</div>
<a name="Introduction-to-reference-manual"></a>
<h2 class="chapter">1 Introduction to reference manual</h2>
<p>The purpose of the cfengine reference manual is to collect together and
document the raw facts about the different components of cfengine. Once
you have become proficient in the use of cfengine, you will no longer
have need of the tutorial. The reference manual, on the other hand,
changes with each version of cfengine. You will be able to use it
online, or in printed form to find out the details you require to
implement configurations in practice.
</p>
<table class="menu" border="0" cellspacing="0">
<tr><td align="left" valign="top">• <a href="#Installation" accesskey="1">Installation</a>:</td><td> </td><td align="left" valign="top">
</td></tr>
<tr><td align="left" valign="top">• <a href="#Work-directory" accesskey="2">Work directory</a>:</td><td> </td><td align="left" valign="top">
</td></tr>
<tr><td align="left" valign="top">• <a href="#Hard-classes" accesskey="3">Hard classes</a>:</td><td> </td><td align="left" valign="top">
</td></tr>
<tr><td align="left" valign="top">• <a href="#Filenames-and-paths" accesskey="4">Filenames and paths</a>:</td><td> </td><td align="left" valign="top">
</td></tr>
<tr><td align="left" valign="top">• <a href="#Debugging-with-signals" accesskey="5">Debugging with signals</a>:</td><td> </td><td align="left" valign="top">
</td></tr>
</table>
<hr>
<a name="Installation"></a>
<div class="header">
<p>
Next: <a href="#Work-directory" accesskey="n" rel="next">Work directory</a>, Previous: <a href="#Reference-introduction" accesskey="p" rel="previous">Reference introduction</a>, Up: <a href="#Reference-introduction" accesskey="u" rel="up">Reference introduction</a> [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Variable-Index" title="Index" rel="index">Index</a>]</p>
</div>
<a name="Installation-1"></a>
<h3 class="section">1.1 Installation</h3>
<p>In order to install cfengine, you should first ensure that the following
packages are installed.
</p>
<dl compact="compact">
<dt><span class="roman"><b>OpenSSL</b></span></dt>
<dd><p>Open source Secure Sockets Layer for encryption.<br>URL: <a href="http://www.openssl.org">http://www.openssl.org</a>
</p></dd>
<dt><span class="roman"><b>BerkeleyDB</b> (version 3.2 or later)</span></dt>
<dd><p>Light-weight flat-file database system.<br>URL: <a href="http://www.oracle.com/technology/products/berkeley-db/index.html">http://www.oracle.com/technology/products/berkeley-db/index.html</a>
</p></dd>
</dl>
<p>The preferred method of installation is then
</p>
<div class="smallexample">
<pre class="smallexample">tar zxf cfengine-x.x.x.tar.gz
cd cfengine-x.x.x
./configure
make
make install
</pre></div>
<p>This results in binaries being installed in <samp>/usr/local/sbin</samp>.
Since this is not necessarily a local file system on all hosts, users
are encouraged to keep local copies of the binaries on each host, inside
the cfengine trusted work directory.
</p>
<hr>
<a name="Work-directory"></a>
<div class="header">
<p>
Next: <a href="#Hard-classes" accesskey="n" rel="next">Hard classes</a>, Previous: <a href="#Installation" accesskey="p" rel="previous">Installation</a>, Up: <a href="#Reference-introduction" accesskey="u" rel="up">Reference introduction</a> [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Variable-Index" title="Index" rel="index">Index</a>]</p>
</div>
<a name="Work-directory-1"></a>
<h3 class="section">1.2 Work directory</h3>
<p>In order to achieve the desired simplifications, it was decided to
reserve a private work area for the cfengine tool-set.
In cfengine 1.x, the administrator could choose the locations of
configuration files, locks, and logging data independently. In
cfengine 2.x, this diversity has been simplified to a single directory
which defaults to <samp>/var/cfengine</samp> (similar to <samp>/var/cron</samp>):
</p>
<p><!-- /@w -->
</p><div class="smallexample">
<pre class="smallexample">/var/cfengine
/var/cfengine/bin
/var/cfengine/inputs
/var/cfengine/outputs
</pre></div>
<p>The installation location
<samp>/usr/local/sbin</samp> is not necessarily a local file system, and cannot
therefore be trusted to a) be present, and b) be authentic on an
arbitrary system.
</p>
<p>Similarly, a trusted cache of the input files must now be maintained
in the <samp>inputs</samp> subdirectory. When cfengine is invoked by the
scheduler, it reads only from this directory. It is up to the user to
keep this cache updated, on each host. This simplifies and
consolidates the cfengine resources in a single place. The environment
variable <code>CFINPUTS</code> still overrides this default location, as before,
but in its absence or when called from the scheduler, this becomes the
location of trusted files. A special configuration file <samp>update.conf</samp> is
parsed and run before the main configuration is parsed, which is
used to ensure that the currently caches policy is up-to-date. This has private
classes and variables.
<a name="index-update_002econf"></a>
If no value is set for <code>CFINPUTS</code>, then the default location
is the trusted cfengine directory
<samp>/var/cfengine/inputs</samp>.
</p>
<p>The <samp>outputs</samp> directory is now a record of spooled run-reports. These
are mailed to the administrator, as previously, or can be copied
to another central location and viewed in an alternative browser..
</p>
<hr>
<a name="Hard-classes"></a>
<div class="header">
<p>
Next: <a href="#Filenames-and-paths" accesskey="n" rel="next">Filenames and paths</a>, Previous: <a href="#Work-directory" accesskey="p" rel="previous">Work directory</a>, Up: <a href="#Reference-introduction" accesskey="u" rel="up">Reference introduction</a> [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Variable-Index" title="Index" rel="index">Index</a>]</p>
</div>
<a name="Cfengine-hard-classes"></a>
<h3 class="section">1.3 Cfengine hard classes</h3>
<p>A single class can be one of several things:
</p>
<ul>
<li> The name of an operating system architecture e.g. <code>ultrix</code>, <code>sun4</code>, etc.
This is referred to as a <em>hard class</em>.
</li><li> The unqualified name of a particular host. If your system returns a fully
qualified domain name for your host, cfagent truncates it at the first dot.
</li><li> The name of a user-defined group of hosts.
</li><li> A day of the week (in the form <code>Monday, Tuesday, Wednesday, ..</code>).
</li><li> An hour of the day (in the form <code>Hr00, Hr01 ... Hr23</code>).
</li><li> Minutes in the hour (in the form <code>Min00, Min17 ... Min45</code>).
</li><li> A five minute interval in the hour (in the form <code>Min00_05, Min05_10 ... Min55_00</code>)
</li><li> A day of the month (in the form <code>Day1, Day2, ... Day31</code>).
</li><li> A month (in the form <code>January, February, ... December</code>).
</li><li> A year (in the form <code>Yr1997, Yr2004</code>).
</li><li> An arbitrary user-defined string.
</li><li> The IP address octets of any active interface (in the form <code><span class="nolinebreak">ipv4_192_0_0_1</span><!-- /@w --></code>,
<code><span class="nolinebreak">ipv4_192_0_0</span><!-- /@w --></code>, <code><span class="nolinebreak">ipv4_192_0</span><!-- /@w --></code>, <code><span class="nolinebreak">ipv4_192</span><!-- /@w --></code>).
</li><li> The name of all interfaces Cfengine can find, in the form <code>net_iface_eth0</code>.
</li></ul>
<p>To see all of the classes define on a particular host, run
</p>
<div class="smallexample">
<pre class="smallexample">host# cfagent -p -v
</pre></div>
<p>as a privileged user. Note that some of the classes are set only
if a trusted link can be established with cfenvd, i.e. if both
are running with privilege, and the <samp>/var/cfengine/state/env_data</samp>
file is secure. More information about classes can be found in connection with
<code>allclasses</code>.
</p>
<hr>
<a name="Filenames-and-paths"></a>
<div class="header">
<p>
Next: <a href="#Debugging-with-signals" accesskey="n" rel="next">Debugging with signals</a>, Previous: <a href="#Hard-classes" accesskey="p" rel="previous">Hard classes</a>, Up: <a href="#Reference-introduction" accesskey="u" rel="up">Reference introduction</a> [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Variable-Index" title="Index" rel="index">Index</a>]</p>
</div>
<a name="Filenames-and-paths-1"></a>
<h3 class="section">1.4 Filenames and paths</h3>
<p>Filenames in Unix-like operating systems use for their directory
separator the forward slash ’/’ character. All references to file
locations must be absolute pathnames in cfengine, i.e. they must begin
with a complete specification of which directory they are in. For
example:
</p>
<div class="smallexample">
<pre class="smallexample">/etc/passwd
/usr/local/masterfiles/distfile
</pre></div>
<p>The only place where it makes sense to refer to a file without a complete
directory specification is when searching through directories for different
kinds of file, e.g.
</p>
<div class="smallexample">
<pre class="smallexample">tidy:
/home/user pattern=core age=0 recurse=inf
</pre></div>
<p>Here, one can write <samp>core</samp> without a path, because one is looking for any
file of that name in a number of directories.
</p>
<p>The Windows operating systems traditionally use a different filename
convention. The following are all valid absolute file names under
Windows:
</p>
<div class="smallexample">
<pre class="smallexample"> c:\winnt
c:/winnt
/var/cfengine/inputs
//<var>fileserver</var>/share2/dir
</pre></div>
<p>The ‘drive’ name “C:” in Windows refers to a partition or device. Unlike Unix,
Windows does not integrate these seamlessly into a single file-tree.
This is not a valid absolute filename:
</p>
<div class="smallexample">
<pre class="smallexample">\var\cfengine\inputs
</pre></div>
<p>Paths beginning with a backslash are assumed to be win32 paths. They
must begin with a drive letter or double-slash server name.
</p>
<hr>
<a name="Debugging-with-signals"></a>
<div class="header">
<p>
Previous: <a href="#Filenames-and-paths" accesskey="p" rel="previous">Filenames and paths</a>, Up: <a href="#Reference-introduction" accesskey="u" rel="up">Reference introduction</a> [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Variable-Index" title="Index" rel="index">Index</a>]</p>
</div>
<a name="Debugging-with-signals-1"></a>
<h3 class="section">1.5 Debugging with signals</h3>
<p>It is possible to turn debugging output on or off on a running cfagent. This is
useful for troubleshooting the cause of hangups, or for getting debugging output
from a cfagent launched from cfexecd.
</p>
<p>A running cfagent process that receives a SIGUSR1 will immediately begin to behave
as if it had been invoked with the ’-d2’ option. A SIGUSR2 will cause a running
cfagent to run as if the ’-d2’ option had not been invoked.
</p>
<p>Note that this output is often quite verbose.
</p>
<table class="menu" border="0" cellspacing="0">
<tr><td align="left" valign="top">• <a href="#Cfagent-reference" accesskey="1">Cfagent reference</a>:</td><td> </td><td align="left" valign="top">
</td></tr>
<tr><td align="left" valign="top">• <a href="#Cfservd_002econf-and-cfrun-reference" accesskey="2">Cfservd.conf and cfrun reference</a>:</td><td> </td><td align="left" valign="top">
</td></tr>
<tr><td align="left" valign="top">• <a href="#Cfexecd-reference" accesskey="3">Cfexecd reference</a>:</td><td> </td><td align="left" valign="top">
</td></tr>
<tr><td align="left" valign="top">• <a href="#Problem-solving" accesskey="4">Problem solving</a>:</td><td> </td><td align="left" valign="top">
</td></tr>
<tr><td align="left" valign="top">• <a href="#Example-configuration-file" accesskey="5">Example configuration file</a>:</td><td> </td><td align="left" valign="top">
</td></tr>
<tr><td align="left" valign="top">• <a href="#Variable-Index" accesskey="6">Variable Index</a>:</td><td> </td><td align="left" valign="top">
</td></tr>
<tr><td align="left" valign="top">• <a href="#Concept-Index" accesskey="7">Concept Index</a>:</td><td> </td><td align="left" valign="top">
</td></tr>
<tr><td align="left" valign="top">• <a href="#FAQ-Index" accesskey="8">FAQ Index</a>:</td><td> </td><td align="left" valign="top">
</td></tr>
</table>
<hr>
<a name="Cfkey"></a>
<div class="header">
<p>
Next: <a href="#Cfshow" accesskey="n" rel="next">Cfshow</a>, Previous: <a href="#Reference-introduction" accesskey="p" rel="previous">Reference introduction</a>, Up: <a href="#Top" accesskey="u" rel="up">Top</a> [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Variable-Index" title="Index" rel="index">Index</a>]</p>
</div>
<a name="Cfkey-reference"></a>
<h2 class="chapter">2 Cfkey reference</h2>
<p>The very first thing you should do on every host is to establish a
public-private key pair. To do this, you need to run the program
</p>
<div class="smallexample">
<pre class="smallexample">everyhost# cfkey
</pre></div>
<p>on every host. This program needs to produce random numbers, and needs a
source of randomness. A good strategy is to install and run the
<samp>cfenvd</samp> program for a week or two in advance of deploying cfengine
2, since <samp>cfenvd</samp> collects random events, which are an excellent source
of entropy for random number generation.
<a name="index-Key-entropy-and-cfenvd"></a>
<a name="index-cfenvd-and-key-entropy"></a>
</p>
<p>If you get the error message “PRNG not seeded”, it means that insufficient
data were found in order to make a random key. In that case, run <samp>cfenvd</samp>
for a few days more and try again.
<a name="index-PRNG-not-seeded"></a>
</p>
<table class="menu" border="0" cellspacing="0">
<tr><td align="left" valign="top">• <a href="#Cfagent-reference" accesskey="1">Cfagent reference</a>:</td><td> </td><td align="left" valign="top">
</td></tr>
<tr><td align="left" valign="top">• <a href="#Cfservd_002econf-and-cfrun-reference" accesskey="2">Cfservd.conf and cfrun reference</a>:</td><td> </td><td align="left" valign="top">
</td></tr>
<tr><td align="left" valign="top">• <a href="#Cfexecd-reference" accesskey="3">Cfexecd reference</a>:</td><td> </td><td align="left" valign="top">
</td></tr>
<tr><td align="left" valign="top">• <a href="#Problem-solving" accesskey="4">Problem solving</a>:</td><td> </td><td align="left" valign="top">
</td></tr>
<tr><td align="left" valign="top">• <a href="#Example-configuration-file" accesskey="5">Example configuration file</a>:</td><td> </td><td align="left" valign="top">
</td></tr>
<tr><td align="left" valign="top">• <a href="#Variable-Index" accesskey="6">Variable Index</a>:</td><td> </td><td align="left" valign="top">
</td></tr>
<tr><td align="left" valign="top">• <a href="#Concept-Index" accesskey="7">Concept Index</a>:</td><td> </td><td align="left" valign="top">
</td></tr>
<tr><td align="left" valign="top">• <a href="#FAQ-Index" accesskey="8">FAQ Index</a>:</td><td> </td><td align="left" valign="top">
</td></tr>
</table>
<hr>
<a name="Cfshow"></a>
<div class="header">
<p>
Next: <a href="#Cfagent-reference" accesskey="n" rel="next">Cfagent reference</a>, Previous: <a href="#Cfkey" accesskey="p" rel="previous">Cfkey</a>, Up: <a href="#Top" accesskey="u" rel="up">Top</a> [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Variable-Index" title="Index" rel="index">Index</a>]</p>
</div>
<a name="Cfshow-reference"></a>
<h2 class="chapter">3 Cfshow reference</h2>
<p>The <code>cfshow</code> command was introduced in cfengine 2.1.11 in order to
provide a simple way to show some of the data stored by cfagent for
operational purposes.
</p>
<div class="smallexample">
<pre class="smallexample">everyhost# cfshow -a
everyhost# cfshow -l
everyhost# cfshow -c
everyhost# cfshow -s
everyhost# cfshow -p
everyhost# cfshow -f cfagent.conf -r linux.*
</pre></div>
<p>The command line options are
</p>
<dl compact="compact">
<dt>‘<samp>-a <code>--active</code></samp>’</dt>
<dd><p>This prints a list of any currently active locks, i.e. tasks that cfengine believes
it is currently enagaged in.
</p>
</dd>
<dt>‘<samp>-A <code>--audit</code></samp>’</dt>
<dd><p>This prints a history of cfengine’s behaviour collected if the
Auditing variable is true, See <a href="#Auditing">Auditing</a>. The audit data are best viewed
in html or parsed with xml, using the <code>--html</code> and <code>--xml</code> options.
</p>
</dd>
<dt>‘<samp>-c <code>--checksum</code></samp>’</dt>
<dd><p>This lists all of the files and their current checksum values in the
current checksum database.
</p>
</dd>
<dt>‘<samp>-C <code>--classes</code></samp>’</dt>
<dd><p>This lists all of the classes that have been used on the system over the past
year, with frequency probabilities to show their relative occurrance rates and
last observed times.
</p>
</dd>
<dt>‘<samp>-H <code>--html</code></samp>’</dt>
<dd><p>Generate output in web browser-friendly html.
</p>
</dd>
<dt>‘<samp>-l <code>--locks</code></samp>’</dt>
<dd><p>This prints a list of the locks and the last times an active lock was secured for each
cfengine acivity. This list is potentially very long.
</p></dd>
<dt>‘<samp>-s <code>--last-seen</code></samp>’</dt>
<dd><p>This lists the IP addresses of all known peers and the times they were last engaged in
communication with the current host. The expected interval between communications is also
printed. See FriendStatus. The output format is in a form that can easily be parsed by
user scripts. e.g.
</p>
<div class="smallexample">
<pre class="smallexample">IP + 192.168.1.101 192.168.1.101 [Tue Jan 23 16:13] not seen for (6.42) hrs, Av 0.02 +/- 0.01 hrs
IP - 192.168.1.101 192.168.1.101 [Tue Jan 23 16:13] not seen for (6.42) hrs, Av 0.02 +/- 0.01 hrs
</pre></div>
<p>Lines marked with a + represent successful attempts made by cfagent on
the current host to connect to another host. Lines with a - are
connections attempted (but not necessarily succeeded) into cfservd from another
host’s cfagent or cfrun.
</p>
</dd>
<dt>‘<samp>-r <code>--regex</code> <var>regex</var></samp>’</dt>
<dd><p>Search the cfengine policy file (e.g. <samp>cfagent.conf</samp>) for rules
that belong to classes matching the named regular expression. Note
that the class "any" is not automatically matched and the search is
based on the class text from the file. The output is not related to
which classes are currently defined.
</p>
</dd>
<dt>‘<samp>-s <code>--performance</code></samp>’</dt>
<dd><p>Shows the time in seconds required to complete copies and shell executions.
</p>
<div class="smallexample">
<pre class="smallexample">(0.00 mins Tue Feb 13 19:05) Av 0.00 +/- 0.00 for Copy(localhost:/usr/local/sbin/cfagent > /var/cfengine/bin/cfagent)
(0.00 mins Tue Feb 13 19:05) Av 0.00 +/- 0.00 for Copy(localhost:/usr/local/sbin/cfenvd > /var/cfengine/bin/cfenvd)
(0.02 mins Tue Feb 13 19:05) Av 0.02 +/- 0.00 for Copy(localhost:/usr/local/sbin/cfexecd > /var/cfengine/bin/cfexecd)
(0.00 mins Tue Feb 13 19:05) Av 0.00 +/- 0.00 for Copy(localhost:/usr/local/sbin/cfservd > /var/cfengine/bin/cfservd)
(6.41 mins Tue Feb 13 18:50) Av 0.00 +/- 0.00 for Exec(/usr/bin/updatedb --prunepaths=/media)
(0.00 mins Tue Feb 13 19:05) Av 0.00 +/- 0.00 for Exec(/usr/sbin/ntpdate 128.39.74.16 > /dev/null)
</pre></div>
</dd>
<dt>‘<samp>-X <code>--xml</code></samp>’</dt>
<dd><p>Generate output in xml for parsing by scripts etc.
</p>
</dd>
</dl>
<table class="menu" border="0" cellspacing="0">
<tr><td align="left" valign="top">• <a href="#Cfagent-reference" accesskey="1">Cfagent reference</a>:</td><td> </td><td align="left" valign="top">
</td></tr>
<tr><td align="left" valign="top">• <a href="#Cfservd_002econf-and-cfrun-reference" accesskey="2">Cfservd.conf and cfrun reference</a>:</td><td> </td><td align="left" valign="top">
</td></tr>
<tr><td align="left" valign="top">• <a href="#Cfexecd-reference" accesskey="3">Cfexecd reference</a>:</td><td> </td><td align="left" valign="top">
</td></tr>
<tr><td align="left" valign="top">• <a href="#Problem-solving" accesskey="4">Problem solving</a>:</td><td> </td><td align="left" valign="top">
</td></tr>
<tr><td align="left" valign="top">• <a href="#Example-configuration-file" accesskey="5">Example configuration file</a>:</td><td> </td><td align="left" valign="top">
</td></tr>
<tr><td align="left" valign="top">• <a href="#Variable-Index" accesskey="6">Variable Index</a>:</td><td> </td><td align="left" valign="top">
</td></tr>
<tr><td align="left" valign="top">• <a href="#Concept-Index" accesskey="7">Concept Index</a>:</td><td> </td><td align="left" valign="top">
</td></tr>
<tr><td align="left" valign="top">• <a href="#FAQ-Index" accesskey="8">FAQ Index</a>:</td><td> </td><td align="left" valign="top">
</td></tr>
</table>
<hr>
<a name="Cfagent-reference"></a>
<div class="header">
<p>
Next: <a href="#Cfservd_002econf-and-cfrun-reference" accesskey="n" rel="next">Cfservd.conf and cfrun reference</a>, Previous: <a href="#Cfshow" accesskey="p" rel="previous">Cfshow</a>, Up: <a href="#Top" accesskey="u" rel="up">Top</a> [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Variable-Index" title="Index" rel="index">Index</a>]</p>
</div>
<a name="Cfagent-reference-1"></a>
<h2 class="chapter">4 Cfagent reference</h2>
<table class="menu" border="0" cellspacing="0">
<tr><td align="left" valign="top">• <a href="#Cfagent-intro" accesskey="1">Cfagent intro</a>:</td><td> </td><td align="left" valign="top">
</td></tr>
<tr><td align="left" valign="top">• <a href="#The-file-cfagent_002econf" accesskey="2">The file cfagent.conf</a>:</td><td> </td><td align="left" valign="top">
</td></tr>
<tr><td align="left" valign="top">• <a href="#Cfagent-Runtime-Options" accesskey="3">Cfagent Runtime Options</a>:</td><td> </td><td align="left" valign="top">
</td></tr>
<tr><td align="left" valign="top">• <a href="#Variable-expansion-and-contexts" accesskey="4">Variable expansion and contexts</a>:</td><td> </td><td align="left" valign="top">
</td></tr>
<tr><td align="left" valign="top">• <a href="#Cfengine-classes" accesskey="5">Cfengine classes</a>:</td><td> </td><td align="left" valign="top">
</td></tr>
<tr><td align="left" valign="top">• <a href="#acl" accesskey="6">acl</a>:</td><td> </td><td align="left" valign="top">
</td></tr>
<tr><td align="left" valign="top">• <a href="#alerts" accesskey="7">alerts</a>:</td><td> </td><td align="left" valign="top">
</td></tr>
<tr><td align="left" valign="top">• <a href="#binservers" accesskey="8">binservers</a>:</td><td> </td><td align="left" valign="top">
</td></tr>
<tr><td align="left" valign="top">• <a href="#broadcast" accesskey="9">broadcast</a>:</td><td> </td><td align="left" valign="top">
</td></tr>
<tr><td align="left" valign="top">• <a href="#control">control</a>:</td><td> </td><td align="left" valign="top">
</td></tr>
<tr><td align="left" valign="top">• <a href="#classes">classes</a>:</td><td> </td><td align="left" valign="top">
</td></tr>
<tr><td align="left" valign="top">• <a href="#copy">copy</a>:</td><td> </td><td align="left" valign="top">
</td></tr>
<tr><td align="left" valign="top">• <a href="#defaultroute">defaultroute</a>:</td><td> </td><td align="left" valign="top">
</td></tr>
<tr><td align="left" valign="top">• <a href="#disks">disks</a>:</td><td> </td><td align="left" valign="top">
</td></tr>
<tr><td align="left" valign="top">• <a href="#directories">directories</a>:</td><td> </td><td align="left" valign="top">
</td></tr>
<tr><td align="left" valign="top">• <a href="#disable">disable</a>:</td><td> </td><td align="left" valign="top">
</td></tr>
<tr><td align="left" valign="top">• <a href="#editfiles">editfiles</a>:</td><td> </td><td align="left" valign="top">
</td></tr>
<tr><td align="left" valign="top">• <a href="#Editfiles-on-Binary-Files">Editfiles on Binary Files</a>:</td><td> </td><td align="left" valign="top">
</td></tr>
<tr><td align="left" valign="top">• <a href="#files">files</a>:</td><td> </td><td align="left" valign="top">
</td></tr>
<tr><td align="left" valign="top">• <a href="#filters">filters</a>:</td><td> </td><td align="left" valign="top">
</td></tr>
<tr><td align="left" valign="top">• <a href="#groups">groups</a>:</td><td> </td><td align="left" valign="top">
</td></tr>
<tr><td align="left" valign="top">• <a href="#homeservers">homeservers</a>:</td><td> </td><td align="left" valign="top">
</td></tr>
<tr><td align="left" valign="top">• <a href="#ignore">ignore</a>:</td><td> </td><td align="left" valign="top">
</td></tr>
<tr><td align="left" valign="top">• <a href="#import">import</a>:</td><td> </td><td align="left" valign="top">
</td></tr>
<tr><td align="left" valign="top">• <a href="#interfaces">interfaces</a>:</td><td> </td><td align="left" valign="top">
</td></tr>
<tr><td align="left" valign="top">• <a href="#links">links</a>:</td><td> </td><td align="left" valign="top">
</td></tr>
<tr><td align="left" valign="top">• <a href="#mailserver">mailserver</a>:</td><td> </td><td align="left" valign="top">
</td></tr>
<tr><td align="left" valign="top">• <a href="#methods">methods</a>:</td><td> </td><td align="left" valign="top">
</td></tr>
<tr><td align="left" valign="top">• <a href="#miscmounts">miscmounts</a>:</td><td> </td><td align="left" valign="top">
</td></tr>
<tr><td align="left" valign="top">• <a href="#mountables">mountables</a>:</td><td> </td><td align="left" valign="top">
</td></tr>
<tr><td align="left" valign="top">• <a href="#processes">processes</a>:</td><td> </td><td align="left" valign="top">
</td></tr>
<tr><td align="left" valign="top">• <a href="#packages">packages</a>:</td><td> </td><td align="left" valign="top">
</td></tr>
<tr><td align="left" valign="top">• <a href="#rename">rename</a>:</td><td> </td><td align="left" valign="top">
</td></tr>
<tr><td align="left" valign="top">• <a href="#required">required</a>:</td><td> </td><td align="left" valign="top">
</td></tr>
<tr><td align="left" valign="top">• <a href="#resolve">resolve</a>:</td><td> </td><td align="left" valign="top">
</td></tr>
<tr><td align="left" valign="top">• <a href="#scli">scli</a>:</td><td> </td><td align="left" valign="top">
</td></tr>
<tr><td align="left" valign="top">• <a href="#shellcommands">shellcommands</a>:</td><td> </td><td align="left" valign="top">
</td></tr>
<tr><td align="left" valign="top">• <a href="#strategies">strategies</a>:</td><td> </td><td align="left" valign="top">
</td></tr>
<tr><td align="left" valign="top">• <a href="#tidy">tidy</a>:</td><td> </td><td align="left" valign="top">
</td></tr>
<tr><td align="left" valign="top">• <a href="#unmount">unmount</a>:</td><td> </td><td align="left" valign="top">
</td></tr>
</table>
<hr>
<a name="Cfagent-intro"></a>
<div class="header">
<p>
Next: <a href="#The-file-cfagent_002econf" accesskey="n" rel="next">The file cfagent.conf</a>, Previous: <a href="#Cfagent-reference" accesskey="p" rel="previous">Cfagent reference</a>, Up: <a href="#Cfagent-reference" accesskey="u" rel="up">Cfagent reference</a> [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Variable-Index" title="Index" rel="index">Index</a>]</p>
</div>
<a name="Cfagent-intro-1"></a>
<h3 class="section">4.1 Cfagent intro</h3>
<p>Cfagent is the workhorse of cfengine. It interprets and computes the necessary strategies
for implementing convergent maintenance. In order to carry out work efficiently,
the agent groups similar actions together. The order of these actions is goverened by
a list called the actionsequence.
</p>
<p>In many cases, cfagent will be able to complete all its work in a single
pass of the actionsequence. However, in complex configurations, it is
hard to resolve all of the ordering dependencies automatically in a
single pass. Cfagent keeps track both of all actions that have been
performed and of those that might still need to be performed (given that
some actions depend on the later outcomes of others). If there is a
possibility that an action ordering dilemma might occur, it runs a
second pass of the actionsequence to more quickly resolve the dependency
(avoiding the wait for next scheduled run). No actions are performed
twice however, since the agent checks off actions that have already been
performed to avoid unnecessary duplication.
</p>
<table class="menu" border="0" cellspacing="0">
<tr><td align="left" valign="top">• <a href="#The-file-cfagent_002econf" accesskey="1">The file cfagent.conf</a>:</td><td> </td><td align="left" valign="top">
</td></tr>
<tr><td align="left" valign="top">• <a href="#Cfagent-Runtime-Options" accesskey="2">Cfagent Runtime Options</a>:</td><td> </td><td align="left" valign="top">
</td></tr>
</table>
<hr>
<a name="The-file-cfagent_002econf"></a>
<div class="header">
<p>
Next: <a href="#Cfagent-Runtime-Options" accesskey="n" rel="next">Cfagent Runtime Options</a>, Previous: <a href="#Cfagent-intro" accesskey="p" rel="previous">Cfagent intro</a>, Up: <a href="#Cfagent-reference" accesskey="u" rel="up">Cfagent reference</a> [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Variable-Index" title="Index" rel="index">Index</a>]</p>
</div>
<a name="The-file-cfagent_002econf-1"></a>
<h3 class="section">4.2 The file cfagent.conf</h3>
<table class="cartouche" border="1"><tr><td>
<p><!-- /@w -->
</p><div class="smallexample">
<pre class="smallexample">
control:
<var>classes</var>::
domain = ( <var>DNS-domain-name</var> )
classes:
<var>Class/Group definitions</var>
import:
<var>Files to import</var>
# other items
</pre></div>
</td></tr></table>
<hr>
<a name="Cfagent-Runtime-Options"></a>
<div class="header">
<p>
Next: <a href="#Variable-expansion-and-contexts" accesskey="n" rel="next">Variable expansion and contexts</a>, Previous: <a href="#The-file-cfagent_002econf" accesskey="p" rel="previous">The file cfagent.conf</a>, Up: <a href="#Cfagent-reference" accesskey="u" rel="up">Cfagent reference</a> [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Variable-Index" title="Index" rel="index">Index</a>]</p>
</div>
<a name="Cfagent-runtime-options"></a>
<h3 class="section">4.3 Cfagent runtime options</h3>
<p>Note that GNU long options are available with the syntax
<code>--longoption</code>. The long names are given in brackets.
</p>
<dl compact="compact">
<dt>‘<samp>-a</samp>’</dt>
<dd><p>(<code>--sysadm</code>) Print only the name of the system administrator then quit.
</p>
</dd>
<dt>‘<samp>-A</samp>’</dt>
<dd><p>(<code>--auto</code>) Can be used to signify an automatic run of cfengine, as opposed
to a manual run. The distinction is not predetermined. Use of this option
currently causes cfengine to ignore locks. This option is reserved for future
development.
</p>
</dd>
<dt>‘<samp>-b</samp>’</dt>
<dd><p>(<code>--force-net-copy</code>) Normally cfengine detects attempts to copy
from a server via the network that will loop back to the localhost.
It then avoids using the network to make the copy. This option forces
cfengine to copy using the network. <em>Yes, someone thinks this is useful!</em>
</p>
</dd>
<dt>‘<samp>-c</samp>’</dt>
<dd><p>(<code>--no-check-files</code>) Do not check file systems for ownership / permissions etc.
</p>
</dd>
<dt>‘<samp>-C</samp>’</dt>
<dd><p>(<code>--no-check-mounts</code>) Check mount points for consistency. If this
option is specified then directories which lie in the “mount point”
area are checked to see whether there is anything mounted on them.
Normally this is <em>off</em> since not all machines use mounted file
systems in the same way. e.g. HPUX does not generally operate with
partitions, but nevertheless one might wish to mimick a partition-like
environment there, but it would be irritating to be informed that
nothing was mounted on the mount point.
</p>
</dd>
<dt>‘<samp>-d</samp>’</dt>
<dd><p>(<code>--debug</code>) Enable debugging output. Normally you will want to
send this to a file using the shell script command or a pipe.
-d1 shows only parsing output. -d2 shows only
runtime action output. -d0 shows both levels. Debugging ouput is
intended mainly for the author’s convenience and is not a supported
feature. The details of this output may change at any time.
</p>
</dd>
<dt>‘<samp>-D</samp>’</dt>
<dd><p>(<code>--define</code>) Define a compound class symbol of the form
<em>alpha.beta.gamma</em>.
</p>
</dd>
<dt>‘<samp>-e</samp>’</dt>
<dd><p>(<code>--no-edits</code>) Suppress file editing.
</p>
</dd>
<dt>‘<samp>-E</samp>’</dt>
<dd><p>(<code>--enforce-links</code>) Globally force links to be created where plain
files or links already exist. Since this option
is a big hammer, you have to use it in interactive mode and
answer a yes/no query before cfengine will run like this.
</p>
</dd>
<dt>‘<samp>-f</samp>’</dt>
<dd><p>(<code>--file</code>) Parse filename after this switch. By default cfengine
looks for a file called <em>cfengine.conf</em> in the current directory.
</p>
</dd>
<dt>‘<samp>-h</samp>’</dt>
<dd><p>(<code>--help</code>) Help information. Display version banner and options
summary.
</p>
</dd>
<dt>‘<samp>-H</samp>’</dt>
<dd><p>(<code>--no-hard-classes</code>). Prevents cfengine from generating any built-in
class name information. Can be used for emulation purposes.
<a name="index-Internal-classes_002c-switching-off"></a>
<a name="index-Switching-off-built_002din-classes"></a>
</p>
</dd>
<dt>‘<samp>-i</samp>’</dt>
<dd><p>(<code>--no-ifconfig</code>) Do not attempt to configure the local area
network interface.
</p>
</dd>
<dt>‘<samp>-I</samp>’</dt>
<dd><p>(<code>--inform</code>) Switches on the inform output level, whereby cfengine
reports everything it changes..
</p>
</dd>
<dt>‘<samp>-k</samp>’</dt>
<dd><p>(<code>--no-copy</code>) Do not copy/image any files.
</p>
</dd>
<dt>‘<samp>-K</samp>’</dt>
<dd><p>(<code>--no-lock</code>) Ignore locks when running.
</p>
</dd>
<dt>‘<samp>-l</samp>’</dt>
<dd><p>(<code>--traverse-links</code>) Normally cfengine does not follow symbolic
links when recursively parsing directories. This option will force it
to do so.
</p>
</dd>
<dt>‘<samp>-L</samp>’</dt>
<dd><p>(<code>--delete-stale-links</code>) Delete links which do not point to
existing files (except in user home directories, which are not touched).
</p>
</dd>
<dt>‘<samp>-m</samp>’</dt>
<dd><p>(<code>--no-mount</code>) Do not attempt to mount file systems or edit the
filesystem table.
</p>
</dd>
<dt>‘<samp>-M</samp>’</dt>
<dd><p>(<code>--no-modules</code>)
Ignore modules in actionsequence.
</p>
</dd>
<dt>‘<samp>-n</samp>’</dt>
<dd><p>(<code>--recon</code>,<code>--dry-run</code>,<code>--just-print</code>) No action. Only
print what has to be done without actually doing it.
</p>
</dd>
<dt>‘<samp>-N</samp>’</dt>
<dd><p>(<code>--negate</code>,<code>--undefine</code>) Cancel a set of classes,
or undefine (set value to <em>false</em>) a compound class of the form
<em>alpha.beta.gamma</em>.
</p>
</dd>
<dt>‘<samp>-p</samp>’</dt>
<dd><p>(<code>--parse-only</code>) Parse file and then stop. Used for checking the
syntax of a program. You do not have to be superuser to use this
option.
</p>
</dd>
<dt>‘<samp>-P</samp>’</dt>
<dd><p>(<code>--no-processes</code>) Do not execute the processes action.
</p>
</dd>
<dt>‘<samp>-q</samp>’</dt>
<dd><p>(<code>--no-splay</code>) Switch off host splaying (sleeping).
</p>
</dd>
<dt>‘<samp>-Q</samp>’</dt>
<dd><p>(<code>--quert</code>) Query the values of the comma separated list of variable names.
</p>
</dd>
<dt>‘<samp>-s</samp>’</dt>
<dd><p>(<code>--no-commands</code>) Do not execute scripts or shell commands.
</p>
</dd>
<dt>‘<samp>-S</samp>’</dt>
<dd><p>(<code>--silent</code>) Silence run time warnings.
</p>
</dd>
<dt>‘<samp>-t</samp>’</dt>
<dd><p>(<code>--no-tidy</code>) Do not tidy file systems.
</p>
</dd>
<dt>‘<samp>-u</samp>’</dt>
<dd><p>(<code>--use-env</code>) Causes cfengine to generate an environment variable
‘<samp>CFALLCLASSES</samp>’ which can be read by child processes (scripts). This
variable contains a summary of all the currently defined classes at any
given time. This option causes some System V systems to generate a Bus
Error or segmentation fault. The same information is available from the
cfengine built-in variable <code>$(allclasses)</code> and can be passed as a
parameter to scripts.
<a name="index-Environment-variable-CFALLCLASSES"></a>
<a name="index-CFALLCLASSES-in-a-file"></a>
<a name="index-allclasses-file"></a>
<a name="index-CFALLCLASSES-2"></a>
When this variable grows too large for embedding one can also access a complete
list of current classes in <samp>/var/cfengine/state/allclasses</samp>.
</p>
</dd>
<dt>‘<samp>-U</samp>’</dt>
<dd><p>(<code>--underscore-classes</code>). When this option is set, cfengine adds
an underscore to the beginning of the hard system classes (like <code>_sun4</code>, <code>_linux</code>
etc. The longer compound classes are not underscored, since these are already
complex and would unlikely result in collisions.) This can be used to avoid naming conflicts if you are so
unjudicious as to name a host by the name of a hard class. Other classes
are not affected.
</p>
</dd>
<dt>‘<samp>-v</samp>’</dt>
<dd><p>(<code>--verbose</code>) Verbose mode. Prints detailed information about
actions and state.
</p>
</dd>
<dt>‘<samp>-V</samp>’</dt>
<dd><p>(<code>--version</code>) Print only the version string and then quit.
</p>
</dd>
<dt>‘<samp>-x</samp>’</dt>
<dd><p>(<code>--no-preconf</code>) Do not execute the <samp>cf.preconf</samp> net
configuration file.
</p>
</dd>
<dt>‘<samp>-X</samp>’</dt>
<dd><p>(<code>--no-links</code>) Do not execute the <code>links</code> section of a
program.
</p>
</dd>
<dt>‘<samp>-w</samp>’</dt>
<dd><p>(<code>--no-warn</code>,<code>--quiet</code>) Do not print warning
messages.
</p>
</dd>
<dt>‘<samp>-z</samp>’</dt>
<dd><p>(<code>--schedule</code>) Print the exec schedule for the LAN (used by cfexecd).
</p>
</dd>
</dl>
<p>In version 2.0.4, an abbreviation for actionsequence exclusions was
added:
</p>
<p><!-- /@w -->
</p><div class="smallexample">
<pre class="smallexample">$ cfagent --avoid resolve,copy
$ cfagent --just tidy --just shellcommands
</pre></div>
<hr>
<a name="Variable-expansion-and-contexts"></a>
<div class="header">
<p>
Next: <a href="#Cfengine-classes" accesskey="n" rel="next">Cfengine classes</a>, Previous: <a href="#Cfagent-Runtime-Options" accesskey="p" rel="previous">Cfagent Runtime Options</a>, Up: <a href="#Cfagent-reference" accesskey="u" rel="up">Cfagent reference</a> [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Variable-Index" title="Index" rel="index">Index</a>]</p>
</div>
<a name="Variable-expansion-and-contexts-1"></a>
<h3 class="section">4.4 Variable expansion and contexts</h3>
<p>Variables in cfengine 2 are defined in contexts. Variables in a given context
refer to the different phases of execution of cfengine: global, update and main.
In the "current" context, variables have the form
</p>
<div class="smallexample">
<pre class="smallexample">$(variable) ${variable}
</pre></div>
<p>and are expanded either on parsing or at execution. Variables that cannot be
expanded remain as dollar strings. Variables belonging to a context that is not
the current one may be referred to as
</p>
<div class="smallexample">
<pre class="smallexample">$(<var>context</var>.variable) or ${<var>context</var>.variable}
</pre></div>
<p>Note carefully that cfengine requires parentheses or braces around variable
names. Unlike in the shell, they cannot be omitted. There is no difference
between these forms as far as cfengine is concerned. Some authors like to use
the <code>()</code> form for cfengine variables, to distinguish them with shell
variables in command strings. The <code>()</code> form does not work in function
arguments, except inside quoted strings.
</p>
<p>Consider the example:
</p>
<div class="smallexample">
<pre class="smallexample">$(global.env_time)
</pre></div>
<p>Some variables in cfengine are associative arrays (as made famous by Perl).
Such arrays are referred to by square brackets:
</p>
<div class="smallexample">
<pre class="smallexample">
$(array[key]) $(array[$(key)])
</pre></div>
<table class="menu" border="0" cellspacing="0">
<tr><td align="left" valign="top">• <a href="#Setting-variables-with-functions" accesskey="1">Setting variables with functions</a>:</td><td> </td><td align="left" valign="top">
</td></tr>
<tr><td align="left" valign="top">• <a href="#Special-variables" accesskey="2">Special variables</a>:</td><td> </td><td align="left" valign="top">
</td></tr>
<tr><td align="left" valign="top">• <a href="#Iteration-over-lists" accesskey="3">Iteration over lists</a>:</td><td> </td><td align="left" valign="top">
</td></tr>
</table>
<hr>
<a name="Setting-variables-with-functions"></a>
<div class="header">
<p>
Next: <a href="#Special-variables" accesskey="n" rel="next">Special variables</a>, Previous: <a href="#Variable-expansion-and-contexts" accesskey="p" rel="previous">Variable expansion and contexts</a>, Up: <a href="#Variable-expansion-and-contexts" accesskey="u" rel="up">Variable expansion and contexts</a> [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Variable-Index" title="Index" rel="index">Index</a>]</p>
</div>
<a name="Setting-variables-with-functions-1"></a>
<h4 class="subsection">4.4.1 Setting variables with functions</h4>
<p>A number of special functions can be used to set variables in cfengine.
You can import values from the execution of a shell command
by prefixing a command with the word <code>exec</code>. This method is deprecated
as of cfengine version 2; use the <code>ExecResult</code> function instead.
</p>
<a name="index-Variables_002c-setting-to-result-of-a-shell-command"></a>
<a name="index-exec"></a>
<div class="smallexample">
<pre class="smallexample">
control:
# old method
listing = ( "exec /bin/ls -l" )
# new method
listing = ( ExecResult(/bin/ls -l) )
</pre></div>
<p>This sets the variable ‘listing’ to the output of the command in the
quotes.
<a name="index-Built_002din-functions"></a>
<a name="index-Functions_002c-built_002din"></a>
<a name="index-Random-numbers"></a>
</p>
<p>Some other built-in functions are
</p>
<dl compact="compact">
<dt><code>A(<var>X</var>,<var>Y</var>)</code></dt>
<dd><p>Makes an associative array entry, associating <var>X</var> and <var>Y</var>. For instance:
</p>
<div class="smallexample">
<pre class="smallexample">control:
assoc_array = ( A(B,"is for bird") A(C,"is for cat") )
</pre></div>
<p>results in:
</p>
<div class="smallexample">
<pre class="smallexample">
OBJECT: main
4569 : assoc_array[B]=is for bird
4630 : assoc_array[C]=is for cat
</pre></div>
<a name="index-Associative-arrays_002e"></a>
<p>Another example:
</p>
<div class="smallexample">
<pre class="smallexample">control:
binhost = ( A(linux,machine1) A(solaris,machine2) )
copy:
# Contact machine 1 for linux
# Contact machine 2 for solaris
/etc/source dest=/etc/receve server=$(binhost[$(class)])
</pre></div>
</dd>
<dt><code>ExecResult(<var>command</var>)</code></dt>
<dd><p>Executes the named command without a shell-wrapper and inserts the output into the
variable. Note that, when this is used in cfengine built-in list
variables, any spaces are interpreted as list separators. In other
lists, normal rules for iteration apply.
</p>
</dd>
<dt><code>ExecShellResult(<var>command</var>)</code></dt>
<dd><p>Executes the named command with a shell-wrapper and inserts the output into the
variable. Note that, when this is used in cfengine built-in list
variables, any spaces are interpreted as list separators. In other
lists, normal rules for iteration apply.
</p>
</dd>
<dt><code>RandomInt(<var>a</var>,<var>b</var>)</code></dt>
<dd><p>Generate a random integer between a and b.
</p>
</dd>
<dt><code>ReadArray(<var>filename</var>,<var>fileformat</var>,<var>separator</var>,<var>comment</var>,<var>Max number of bytes</var>)</code></dt>
<dd><p>Reads up to a maximum number of bytes from a properly formatted file
into a one-dimensional associated array. File formats are:
</p><dl compact="compact">
<dt><code>autokey</code></dt>
<dd><p>If this format is specified, <code>ReadArray</code> tries to interpret the
file as a table of items separated with the separator character. Blank
lines and comments (to end of line) are ignored. Items are keyed
numerically starting from 1 to the maximum number in the file. The
newline <code>$(n)</code> is always considered to be a separator, no matter
what the current separator is.
<a name="index-Associative-arrays_002e-1"></a>
</p>
</dd>
<dt><code>textkey</code></dt>
<dd><p>If this format is specified, <code>ReadArray</code> tries to interpret the file as a list
of lines of the form:
</p>
<div class="smallexample">
<pre class="smallexample"> key,value
</pre></div>
</dd>
</dl>
</dd>
<dt><code>ReadFile(<var>filename</var>,<var>Max number of bytes</var>)</code></dt>
<dd><p>Read a maximum number of bytes from a file.
<a name="index-ReadFile"></a>
</p>
</dd>
<dt><code>ReadTable(<var>filename</var>,<var>fileformat</var>,<var>separator</var>,<var>comment</var>,<var>Max number of bytes</var>)</code></dt>
<dd><p>Reads up to a maximum number of bytes from a properly formatted file into a two-dimensional associated array.
</p><dl compact="compact">
<dt><code>autokey</code></dt>
<dd><p>If this format is specified, <code>ReadArray</code> tries to interpret the
file as a table of items separated with the separator character. Blank
lines and comments (to end of line) are ignored. Items are keyed
numerically starting from 1 to the maximum number in the file. Any
lines that do not contain the correct number of separators cause the
function to fail without making any assignment.
<a name="index-ReadTable"></a>
<a name="index-Read-array-from-table"></a>
</p>
</dd>
<dt><code>textkey</code></dt>
<dd><p>If this format is specified, <code>ReadArray</code> tries to interpret the file as a list
of lines of the form:
</p>
<div class="smallexample">
<pre class="smallexample"> key1,key2,value1
key3,key4,value2
</pre></div>
<p>This variable would then be references as $(table[key1][key2]).
</p>
</dd>
</dl>
</dd>
<dt><code>ReadList(<var>filename</var>,<var>fileformat</var>,<var>comment</var>,<var>Max number of bytes</var>)</code></dt>
<dd><p>Reads up to a maximum number of bytes from a properly formatted file into a listvariable. File formats
are:
</p><dl compact="compact">
<dt><code>lines</code></dt>
<dd><p>If this format is specified, <code>ReadList</code> tries to interpret the file as a list of
items on separate lines. The value returned is a list formatted by the <code>Split</code> character.
<a name="index-Associative-arrays_002e-2"></a>
</p></dd>
</dl>
<p><!-- /@w -->
</p><div class="smallexample">
<pre class="smallexample">
hosts = ( ReadList(/var/cfengine/inputs/datafile,lines,#,1000) )
</pre></div>
</dd>
<dt><code>ReadTCP(<var>host/IP</var>,<var>portnumber</var>,<var>send string</var>,<var>Max number of bytes</var>)</code></dt>
<dd><p>Reads up to a maximum number of bytes from a TCP service. Can be used
to test whether certain services are responding to queries. It is
recommended that this be used primarily to check services running on
localhost. Bear in mind that this clause, executed on 100 hosts will produce
the effect of a distributed denial of service attack, so the probe should be
restricted to a single representative tester-host. For example:
</p>
<div class="smallexample">
<pre class="smallexample">
one_host_only::
# USE WITH CAUTION !
probewww = ( ReadTCP(localhost,80,'GET index.html',1000) )
</pre></div>
<p>Or testing a network service:
</p><div class="smallexample">
<pre class="smallexample">control:
checkhost::
probesmtp = ( ReadTCP(localhost,25,"",1024) )
probewww = ( ReadTCP(project.iu.hio.no,80,"GET /viewcvs HTTP/1.0 ${n}${n}",1024) )
classes:
viewcvs_error = ( RegCmp(".*Python Traceback.*","${probewww}") )
alerts:
viewcvs_error::
"Received viewcvs error from web server"
</pre></div>
</dd>
<dt><code>SelectPartitionNeighbours(<var>filename</var>,<var>comment</var>,<var>Policy</var>,<var>group size</var>)</code></dt>
<dd>
<p>This function is for use in peer to peer monitoring applications. It
allows individual hosts to identify themselves as part of a group and
find their peers. The function returns a list variable, delimited by
the list separation character, for use with Split.
<a name="index-SelectPartitionGroup"></a>
<a name="index-Peer-to-peer-methods"></a>
</p>
<p><!-- /@w -->
</p><div class="smallexample">
<pre class="smallexample">
control:
allpeers = ( SelectPartitionNeighbours(/var/cfengine/inputs/cfrun.hosts,#,random,4) )
copy:
/data/file dest=/p2prepository/file server=$(allpeers)
</pre></div>
</dd>
<dt><code>SelectPartitionLeader(<var>filename</var>,<var>comment</var>,<var>Policy</var>,<var>group size</var>)</code></dt>
<dd>
<p>This function is for use in peer to peer monitoring applications. It
allows individual hosts to identify themselves as part of a group and
select a leader. This function reads a text file of hostnames or IP
addresses, one host per line, with blank lines and comments and
partitions it into groups of a fixed size. It then returns picks a
leader for the the group and returns its name as the value of the
function.
<a name="index-SelectPartitionLeader"></a>
<a name="index-Peer-to-peer-methods-1"></a>
</p>
<p><!-- /@w -->
</p><div class="smallexample">
<pre class="smallexample">
control:
leader = ( SelectPartitionLeader(/var/cfengine/inputs/cfrun.hosts,#,random,4) )
copy:
/data/file dest=/p2prepository/file server=$(leader)
</pre></div>
</dd>
</dl>
<p>Note that functions should have no spaces between the function name and the
leading parenthesis, but should themselves be surrounded by white space.
For example:
</p>
<div class="smallexample">
<pre class="smallexample">
control:
variable2 = ( RandomInt(0,23) )
variable3 = ( ExecResult(/bin/ls -a /opt) )
myexcerpt = ( ReadFile("/etc/services",220) )
listvar = ( ReadArray(/tmp/array,textkey,",","#",100) )
</pre></div>
<p>In the latter case, the file could look like this:
</p>
<div class="smallexample">
<pre class="smallexample">host$ more /tmp/array
one,String to tbe read
two,Nothing string
three,Everything comes in threes
</pre></div>
<p>and results in the definition of (verify with <code>cfagent -p -d3</code>):
</p>
<div class="smallexample">
<pre class="smallexample">OBJECT: main
960 : listvar[one]=String to tbe read
259 : listvar[two]=Nothing string
224 : listvar[three]=Everything comes in threes
</pre></div>
<a name="index-Array-example"></a>
<a name="index-Read-array-from-file"></a>
<a name="index-Array-from-file"></a>
<a name="index-ReadArray"></a>
<table class="menu" border="0" cellspacing="0">
<tr><td align="left" valign="top">• <a href="#Special-variables" accesskey="1">Special variables</a>:</td><td> </td><td align="left" valign="top">
</td></tr>
<tr><td align="left" valign="top">• <a href="#Iteration-over-lists" accesskey="2">Iteration over lists</a>:</td><td> </td><td align="left" valign="top">
</td></tr>
</table>
<hr>
<a name="Special-variables"></a>
<div class="header">
<p>
Next: <a href="#Iteration-over-lists" accesskey="n" rel="next">Iteration over lists</a>, Previous: <a href="#Setting-variables-with-functions" accesskey="p" rel="previous">Setting variables with functions</a>, Up: <a href="#Variable-expansion-and-contexts" accesskey="u" rel="up">Variable expansion and contexts</a> [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Variable-Index" title="Index" rel="index">Index</a>]</p>
</div>
<a name="Special-variables-1"></a>
<h4 class="subsection">4.4.2 Special variables</h4>
<p>Variables are referred to in either of two different ways, depending on
your taste. You can use the forms <code>$(variable)</code> or
<code>${variable}</code>. The variable in braces or parentheses can be the
name of any user defined macro, environment variable or one of the
following special built-in variables.
</p>
<dl compact="compact">
<dt><code>AllClasses</code></dt>
<dd><p>A long string in the form ‘<samp>CFALLCLASSES=class1:class2...</samp>’. This
variable is a summary of all the defined classes at any given time. It
is always kept up to date so that scripts can make use of cfengine’s
class data.
<a name="index-CFALLCLASSES"></a>
<a name="index-CFALLCLASSES-3"></a>
<a name="index-Class-data-and-scripts"></a>
<a name="index-Scripts_002c-passing-classes-to"></a>
</p>
</dd>
<dt><code>arch</code></dt>
<dd><p>The current detailed architecture string—an amalgamation of the
information from <em>uname</em>. <em>A constant</em>.
<a name="index-_0024_0028arch_0029"></a>
</p>
</dd>
<dt><code>binserver</code></dt>
<dd><p>The default server for binary data. <em>A constant</em>.
<a name="index-_0024_0028binserver_0029"></a>
</p>
</dd>
<dt><code>cfinputs_version</code></dt>
<dd><p>The version string of the current configuration, used for version control and auditing.
<a name="index-Auditing"></a>
<a name="index-Version-control"></a>
<a name="index-cfinputs_005fversion"></a>
</p>
</dd>
<dt><code>ChecksumDatabase</code></dt>
<dd><p>If set to the name of a file, cfagent will use this to store checksums of important
files, and give ‘tripwire functionality’, See <a href="#ChecksumDatabase-in-cfagent">ChecksumDatabase in cfagent</a>. This option was deprecated in 2.1.22.
</p>
</dd>
<dt><code>ChecksumUpdates</code></dt>
<dd><p>If set to ‘on’, security information is automatically updated.
</p>
</dd>
<dt><code>class</code></dt>
<dd><p>The currently defined system hard-class (e.g. <code>sun4</code>, <code>hpux</code>). <em>A constant</em>.
<a name="index-_0024_0028class_0029"></a>
</p>
</dd>
<dt><code>date</code></dt>
<dd><p>The current date string. Note that if you use this in a shell command it might
be interpreted as a list variable, since it contains the default separator
‘<samp>:</samp>’.
<a name="index-_0024_0028date_0029"></a>
</p>
</dd>
<dt><code>domain</code></dt>
<dd><p>The currently defined domain.
<a name="index-_0024_0028domain_0029"></a>
</p>
</dd>
<dt><code>EmailFrom</code></dt>
<dd><p>The email address from whom email from cfexecd should appear to originate.
</p>
</dd>
<dt><code>EmailMaxLines</code></dt>
<dd><p>Most lines of output to email from a single cfexecd-induced run of
cfagent. If undefined, defaults to 100. If set to 0, no email is sent by
cfexecd. If set to <code>inf</code>, no maximum is enforced.
<a name="index-_0024_007bEmailMaxLines_007d"></a>
</p>
</dd>
<dt><code>EmailTo</code></dt>
<dd><p>The E-mail address to whom mail should be sent (overrides <code>sysadm</code> variable).
</p>
</dd>
<dt><code>faculty</code></dt>
<dd><p>The faculty or site as defined in control (see <code>site</code>).
<a name="index-_0024_0028faculty_0029"></a>
</p>
</dd>
<dt><code>fqhost</code></dt>
<dd><p>The fully qualified hostname of the system.
<a name="index-_0024_0028fqhost_0029"></a>
</p>
</dd>
<dt><code>host</code></dt>
<dd><p>The hostname of the machine running the program.
<a name="index-_0024_0028host_0029"></a>
</p>
</dd>
<dt><code>ipaddress</code></dt>
<dd><p>The numerical form of the Internet address of the host currently running
cfengine found by a reverse lookup in DNS.
<a name="index-_0024_0028ipaddress_0029"></a>
</p>
</dd>
<dt><code>ipv4[<var>interface</var>]</code></dt>
<dd><p>The IPv4 address of the named interface as determined from a probe of the
interfaces. This variable belongs in the global context and refers to
as in the following examples:
</p>
<div class="smallexample">
<pre class="smallexample">
${global.ipv4[hme0]}
${global.ipv4[eth0]}
</pre></div>
</dd>
<dt><code>MaxCfengines</code></dt>
<dd><p>The maximum number of cfengines which should be allowed to
run concurrently on the system. This can prevent excessive
load due to unintentional spamming in situations where several
cfengines are started independently. The default value is unlimited.
<a name="index-MaxCfengines"></a>
</p>
</dd>
<dt><code>ostype</code></dt>
<dd><p>A short for of <code>$(arch)</code>.
</p>
</dd>
<dt><code>OutputPrefix</code></dt>
<dd><p>This quoted string can be used to change the default ‘cfengine:${hostname}’
prefix on output lines to something else. You might wish to shorten
the string, or have a different prefix for different hosts. The default is
equivalent to,
</p>
<div class="smallexample">
<pre class="smallexample"> OutputPrefix = ( "cfengine:$(host):")
</pre></div>
<a name="index-OutputPrefix"></a>
</dd>
<dt><code>RepChar</code></dt>
<dd><p>The character value of the string used by the file repository in
constructing unique filenames from path names. This is the character which
replaces ‘<samp>/</samp>’.
<a name="index-repchar"></a>
</p>
</dd>
<dt><code>site</code></dt>
<dd><p>This variable is identical to <code>$(faculty)</code> and may be used interchangeably.
<a name="index-_0024_0028site_0029"></a>
</p>
</dd>
<dt><code>smtpserver</code></dt>
<dd><p>The name of the host to which mail output should be sent.
</p>
</dd>
<dt><code>split</code></dt>
<dd><p>The character on which list variables are split.
<a name="index-split-2"></a>
</p>
</dd>
<dt><code>sysadm</code></dt>
<dd><p>The name or mail address of the system administrator.
<a name="index-_0024_0028sysadm_0029"></a>
</p>
</dd>
<dt><code>timezone</code></dt>
<dd><p>The current timezone as defined in <code>control</code>.
<a name="index-_0024_0028timezone_0029"></a>
</p>
</dd>
<dt><code>UnderscoreClasses</code></dt>
<dd><p>If this is set to ‘on’ cfengine uses hard classes which begin with
an underscore to avoid name collisions, See <a href="#Cfagent-Runtime-Options">Cfagent Runtime Options</a>.
<a name="index-underscoreclasses-1"></a>
<a name="index-underscoreclasses"></a>
<a name="index-Name-collision"></a>
<a name="index-Hostname-collision"></a>
<a name="index-Hard-class-name-collision"></a>
<a name="index-underscoreclasses-2"></a>
</p>
</dd>
<dt><code>version</code></dt>
<dd><p>The current cfengine version string as defined in the code.
<a name="index-_0024_0028version_0029"></a>
</p>
</dd>
<dt><code>year</code></dt>
<dd><p>The current year.
<a name="index-_0024_0028year_0029"></a>
</p></dd>
</dl>
<p>These variables are kept special because they play a special role in
setting up a system configuration.
You are encouraged to use them to define fully
generalized rules in your programs. Variables can be used to advantage
in defining filenames, directory names and in passing arguments to shell
commands. The judicious use of variables can reduce many definitions to
a single one if you plan carefully.
</p>
<table class="cartouche" border="1"><tr><td>
<p><em>NOTE: the above control variables are not case sensitive, unlike
user macros, so you should not define your own macros with these names.</em>
</p>
</td></tr></table>
<p>The following variables are also reserved and may be used to produce
troublesome special characters in strings.
</p><dl compact="compact">
<dt><code>cr</code></dt>
<dd><p>Expands to the carriage return character.
<a name="index-_0024_0028cr_0029"></a>
</p>
</dd>
<dt><code>colon</code></dt>
<dd><p>Expands to the colon ‘<samp>:</samp>’ character.
<a name="index-_0024_0028colon_0029"></a>
</p>
</dd>
<dt><code>dblquote</code></dt>
<dd><p>Expands to a double quote <code>"</code>
<a name="index-_0024_0028dblquote_0029"></a>
</p>
</dd>
<dt><code>dollar</code></dt>
<dd><p>Expands to ‘<samp>$</samp>’.
<a name="index-_0024_0028dollar_0029"></a>
</p>
</dd>
<dt><code>lf</code></dt>
<dd><p>Expands to a line-feed character (Unix end of line).
<a name="index-_0024_0028lf_0029"></a>
</p>
</dd>
<dt><code>n</code></dt>
<dd><p>Expands to a newline character.
<a name="index-_0024_0028n_0029"></a>
</p>
</dd>
<dt><code>quote</code></dt>
<dd><p>Expands to a single quote <code>'</code>.
<a name="index-_0024_0028quote_0029"></a>
</p>
</dd>
<dt><code>spc</code></dt>
<dd><p>Expands simply to a single space. This can be used to place spaces in
filenames etc.
<a name="index-_0024_0028spc_0029"></a>
</p>
</dd>
<dt><code>tab</code></dt>
<dd><p>Expands to a single tab character.
<a name="index-_0024_0028tab_0029"></a>
</p>
</dd>
</dl>
<hr>
<a name="Iteration-over-lists"></a>
<div class="header">
<p>
Previous: <a href="#Special-variables" accesskey="p" rel="previous">Special variables</a>, Up: <a href="#Variable-expansion-and-contexts" accesskey="u" rel="up">Variable expansion and contexts</a> [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Variable-Index" title="Index" rel="index">Index</a>]</p>
</div>
<a name="Iteration-over-lists-1"></a>
<h4 class="subsection">4.4.3 Iteration over lists</h4>
<p>Variables can be used as iterators in some situations. Iteration over lists
is currently rather limited in cfengine and is something to be improved on
in a future version. When a variable is used as an iterator, a character
is chosen to represent a list separator, as in the shell ‘<samp>IFS</samp>’ variable.
The default separator is the colon ‘<samp>:</samp>’ character:
</p>
<div class="smallexample">
<pre class="smallexample">control:
listvar = ( one:two:three:four )
</pre></div>
<p>The action that contains a variable to be interpreted as a list appears
as separate actions, one for each case:
</p>
<div class="smallexample">
<pre class="smallexample">shellcommand:
"/bin/echo $(listvar)"
</pre></div>
<p>is equivalent to
</p>
<div class="smallexample">
<pre class="smallexample">shellcommand:
"/bin/echo one"
"/bin/echo two"
"/bin/echo three"
"/bin/echo four"
</pre></div>
<p>If multiple iterators are used, these are handled as nested loops:
</p>
<div class="smallexample">
<pre class="smallexample">cfengine::/bin/echo one 1: one 1
cfengine::/bin/echo one 2: one 2
cfengine::/bin/echo one 3: one 3
cfengine::/bin/echo one 4: one 4
cfengine::/bin/echo two 1: two 1
cfengine::/bin/echo two 2: two 2
cfengine::/bin/echo two 3: two 3
cfengine::/bin/echo two 4: two 4
cfengine::/bin/echo three: three 1
cfengine::/bin/echo three: three 2
cfengine::/bin/echo three: three 3
cfengine::/bin/echo three: three 4
cfengine::/bin/echo four : four 1
cfengine::/bin/echo four : four 2
cfengine::/bin/echo four : four 3
cfengine::/bin/echo four : four 4
</pre></div>
<p>Where iterators are not allowed, the implied lists are treated as scalars:
</p>
<div class="smallexample">
<pre class="smallexample">
alerts:
amnexus::
"do $(list1) $(list2)"
</pre></div>
<p>e.g.
</p>
<div class="smallexample">
<pre class="smallexample">
cfengine:: do one:two:three:four 1:2:3:4
</pre></div>
<p>Iterative expansion is currently restricted to:
</p><ul>
<li> In the directory field of the admit/deny server access rules,
</li><li> In the ‘from’ field of a copy action,
</li><li> In the server field of the copy action,
</li><li> In the directory field of the disable action,
</li><li> In the directory field of the files action,
</li><li> In the ‘to’ field of a multiple link action,
</li><li> In the directory field of the required/disk action,
</li><li> In a resolve item.
</li><li> In the directory field of a tidy action,
</li><li> In the arguments, replyto and server attributes of methods.
</li><li> Names in the ignore action.
</li><li> A shellcommands body.
</li><li> In admit/deny path and attributes of cfserver.
</li></ul>
<a name="index-split"></a>
<a name="index-Iteration-over-lists"></a>
<a name="index-Iterating-over-lists"></a>
<a name="index-split-3"></a>
<hr>
<a name="Cfengine-classes"></a>
<div class="header">
<p>
Next: <a href="#acl" accesskey="n" rel="next">acl</a>, Previous: <a href="#Variable-expansion-and-contexts" accesskey="p" rel="previous">Variable expansion and contexts</a>, Up: <a href="#Cfagent-reference" accesskey="u" rel="up">Cfagent reference</a> [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Variable-Index" title="Index" rel="index">Index</a>]</p>
</div>
<a name="Cfengine-classes-1"></a>
<h3 class="section">4.5 Cfengine classes</h3>
<a name="index-classes"></a>
<p>A <em>cfengine action</em> looks like this:
</p>
<div class="smallexample">
<pre class="smallexample">
<var>action-type</var>:
<var>compound-class</var>::
<var>declaration</var>
</pre></div>
<p>A single class is an identifier that may consist of any alphanumeric
character or the underscore, just like identifiers in ordinary programming
languages. Classes that are derived from data like IP addresses or host names
convert any other characters (like ‘<samp>.</samp>’ or ‘<samp>-</samp>’) into underscores.
A single class can be one of several things:
</p>
<ul>
<li> The name of an operating system architecture e.g. <code>ultrix</code>, <code>sun4</code>, etc.
This is referred to as a <em>hard class</em>.
</li><li> The unqualified name of a particular host. If your system returns a fully
qualified domain name for your host, cfagent truncates it at the first dot.
</li><li> The name of a user-defined group of hosts.
</li><li> A day of the week (in the form <code>Monday, Tuesday, Wednesday, ..</code>).
</li><li> An hour of the day (in the form <code>Hr00, Hr01 ... Hr23</code>).
</li><li> Minutes in the hour (in the form <code>Min00, Min17 ... Min45</code>).
</li><li> A five minute interval in the hour (in the form <code>Min00_05, Min05_10 ... Min55_00</code>)
</li><li> A quart hour (in the form <code>Q1, Q2, Q3, Q4</code>)
</li><li> An abbreviated time with quarter hour specified (in the form <code>Hr00_Q1, Hr23_Q4</code> etc.)
</li><li> A day of the month (in the form <code>Day1 ... Day31</code>).
</li><li> A month (in the form <code>January, February, ... December</code>).
</li><li> A year (in the form <code>Yr1997, Yr2004</code>).
</li><li> An arbitrary user-defined string.
</li><li> The IP address octets of any active interface (in the form <code><span class="nolinebreak">ipv4_192_0_0_1</span><!-- /@w --></code>,
<code><span class="nolinebreak">ipv4_192_0_0</span><!-- /@w --></code>, <code><span class="nolinebreak">ipv4_192_0</span><!-- /@w --></code>, <code><span class="nolinebreak">ipv4_192</span><!-- /@w --></code>).
</li></ul>
<p>A compound class is a sequence of simple classes connected by dots or
‘pipe’ symbols (vertical bars). For example:
</p>
<a name="index-Compound-classes"></a>
<a name="index-Classes_002c-compound"></a>
<p><!-- /@w -->
</p><div class="smallexample">
<pre class="smallexample">
myclass.sun4.Monday::
sun4|ultrix|osf::
</pre></div>
<p>A compound class evaluates to ‘true’ if all of the individual classes
are separately true, thus in the above example the actions which follow
<code>compound_class::</code> are only carried out if the host concerned is in
<code>myclass</code>, is of type <code>sun4</code> and the day is Monday!
In the second example, the host parsing the file must be either of
type <code>sun4</code> <em>or</em> <code>ultrix</code> <em>or</em> <code>osf</code>.
In other words, compound classes support two operators: AND and OR,
written ‘<samp>.</samp>’ and ‘<samp>|</samp>’ respectively.
From cfengine version 2.1.1,
I bit the bullet and added ‘<samp>&</samp>’ as a synonym for the AND operator.
Cfengine doesn’t
care how many of these operators you use (since it skips over blank
class names), so you could write either
</p>
<div class="smallexample">
<pre class="smallexample">
solaris|irix::
</pre></div>
<p>or
</p>
<div class="smallexample">
<pre class="smallexample">
solaris||irix::
</pre></div>
<p>depending on your taste. On the other hand, the order in which cfengine
evaluates AND and OR operations <em>does</em> matter, and the rule
is that AND takes priority over OR, so that ‘<samp>.</samp>’ binds classes
together tightly and all AND operations are evaluated before ORing
the final results together. This is the usual behaviour in programming
languages. You can use round parentheses in cfengine classes to
override these preferences.
</p>
<p>Cfengine allows you to define switch on and off dummy classes so that
you can use them to select certain subsets of action. In particular,
note that by defining your own classes, using them to make compound
rules of this type, and then switching them on and off, you can also
switch on and off the corresponding actions in a controlled way. The
command line options <code>-D</code> and <code>-N</code> can be used for this
purpose. See also <code>addclasses</code> in the Reference manual.
<a name="index-_002dN-option"></a>
<a name="index-_002dD-option-1"></a>
<a name="index-Classes_002c-defining-and-undefining"></a>
</p>
<a name="index-NOT-operator"></a>
<a name="index-Logical-NOT"></a>
<a name="index-_0021-1"></a>
<a name="index-_0021"></a>
<p>A logical NOT operator has been added to allow you to exclude
certain specific hosts in a more flexible way. The logical NOT
operator is (as in C and C++) ‘<samp>!</samp>’. For instance, the
following example would allow all hosts except for <code>myhost</code>:
</p>
<div class="smallexample">
<pre class="smallexample"> <var>action</var>:
!myhost::
<var>command</var>
</pre></div>
<p>and similarly, so allow all hosts in a user-defined group <code>mygroup</code>,
<em>except</em> for <code>myhost</code>, you would write
</p>
<p><!-- /@w -->
</p><div class="smallexample">
<pre class="smallexample"> <var>action</var>:
mygroup.!myhost::
<var>command</var>
</pre></div>
<p>which reads ‘mygroup AND NOT myhost’. The NOT operator can also be
combined with OR. For instance
</p>
<div class="smallexample">
<pre class="smallexample">
<var>class1</var>|!<var>class2</var>
</pre></div>
<p>would select hosts which were either in class 1, or those
which were not in class 2.
</p>
<p>Finally, there is a number of reserved classes. The following are hard
classes for various operating system architectures. They do not need to
be defined because each host knows what operating system it is running.
Thus the appropriate one of these will always be defined on each host.
Similarly the day of the week is clearly not open to definition, unless
you are running cfengine from outer space. The reserved classes are:
</p>
<div class="smallexample">
<pre class="smallexample">ultrix, sun4, sun3, hpux, hpux10, aix, solaris, osf, irix4, irix, irix64
sco, freebsd, netbsd, openbsd, bsd4_3, newsos, solarisx86, aos,
nextstep, bsdos, linux, debian, cray, unix_sv, GnU, NT
</pre></div>
<p>If these classes are not sufficient to distinguish the hosts on
your network, cfengine provides more specific classes which
contain the name and release of the operating system. To find out
what these look like for your systems you can run cfengine in
‘parse-only-verbose’ mode:
</p>
<div class="smallexample">
<pre class="smallexample">
cfagent -p -v
</pre></div>
<p>and these will be displayed. For example, Solaris 2.4 systems
generate the additional classes <code>sunos_5_4</code> and <code>sunos_sun4m</code>,
<code>sunos_sun4m_5_4</code>.
</p>
<p>Cfengine uses both the unqualified and fully host names as classes. Some
sites and operating systems use fully qualified names for their
hosts. i.e. <code>uname -n</code> returns to full domain qualified
hostname. This spoils the class matching algorithms for cfengine, so
cfengine automatically truncates names which contain a dot ‘.’ at the
first ‘.’ it encounters. If your hostnames contain dots (which do not
refer to a domain name, then cfengine will be confused. The moral is:
don’t have dots in your host names! <em>NOTE: in order to ensure that
the fully qualified name of the host becomes a class you must define the
domain variable.</em> The dots in this string will be replaced by underscores.
<a name="index-Fully-qualified-names"></a>
<a name="index-Dots-in-hostnames"></a>
<a name="index-Host-name-gets-truncated"></a>
</p>
<p>In summary, the operator ordering in cfengine classes is as follows:
<a name="index-Operator-ordering"></a>
<a name="index-Brackets-_0028parentheses_0029-in-classes_002e"></a>
<a name="index-Parentheses-in-classes_002e"></a>
</p>
<dl compact="compact">
<dt>‘<samp>()</samp>’</dt>
<dd><p>Parentheses override everything.
</p>
</dd>
<dt>‘<samp>!</samp>’</dt>
<dd><p>The NOT operator binds tightest.
</p>
</dd>
<dt>‘<samp>. &</samp>’</dt>
<dd><p>The AND operator binds more tightly than OR.
</p>
</dd>
<dt>‘<samp>|</samp>’</dt>
<dd><p>OR is the weakest operator.
</p>
</dd>
</dl>
<table class="menu" border="0" cellspacing="0">
<tr><td align="left" valign="top">• <a href="#Setting-classes-with-special-functions" accesskey="1">Setting classes with special functions</a>:</td><td> </td><td align="left" valign="top">
</td></tr>
<tr><td align="left" valign="top">• <a href="#AccessedBefore" accesskey="2">AccessedBefore</a>:</td><td> </td><td align="left" valign="top">
</td></tr>
<tr><td align="left" valign="top">• <a href="#ChangedBefore" accesskey="3">ChangedBefore</a>:</td><td> </td><td align="left" valign="top">
</td></tr>
<tr><td align="left" valign="top">• <a href="#ClassMatch" accesskey="4">ClassMatch</a>:</td><td> </td><td align="left" valign="top">
</td></tr>
<tr><td align="left" valign="top">• <a href="#FileExists" accesskey="5">FileExists</a>:</td><td> </td><td align="left" valign="top">
</td></tr>
<tr><td align="left" valign="top">• <a href="#GroupExists" accesskey="6">GroupExists</a>:</td><td> </td><td align="left" valign="top">
</td></tr>
<tr><td align="left" valign="top">• <a href="#HostRange" accesskey="7">HostRange</a>:</td><td> </td><td align="left" valign="top">
</td></tr>
<tr><td align="left" valign="top">• <a href="#IsDefined" accesskey="8">IsDefined</a>:</td><td> </td><td align="left" valign="top">
</td></tr>
<tr><td align="left" valign="top">• <a href="#IsDir" accesskey="9">IsDir</a>:</td><td> </td><td align="left" valign="top">
</td></tr>
<tr><td align="left" valign="top">• <a href="#IsLink">IsLink</a>:</td><td> </td><td align="left" valign="top">
</td></tr>
<tr><td align="left" valign="top">• <a href="#IsPlain">IsPlain</a>:</td><td> </td><td align="left" valign="top">
</td></tr>
<tr><td align="left" valign="top">• <a href="#IsNewerThan">IsNewerThan</a>:</td><td> </td><td align="left" valign="top">
</td></tr>
<tr><td align="left" valign="top">• <a href="#IPRange">IPRange</a>:</td><td> </td><td align="left" valign="top">
</td></tr>
<tr><td align="left" valign="top">• <a href="#PrepModule">PrepModule</a>:</td><td> </td><td align="left" valign="top">
</td></tr>
<tr><td align="left" valign="top">• <a href="#Regcmp">Regcmp</a>:</td><td> </td><td align="left" valign="top">
</td></tr>
<tr><td align="left" valign="top">• <a href="#ReturnsZero">ReturnsZero</a>:</td><td> </td><td align="left" valign="top">
</td></tr>
<tr><td align="left" valign="top">• <a href="#ReturnsZeroShell">ReturnsZeroShell</a>:</td><td> </td><td align="left" valign="top">
</td></tr>
<tr><td align="left" valign="top">• <a href="#Strcmp">Strcmp</a>:</td><td> </td><td align="left" valign="top">
</td></tr>
<tr><td align="left" valign="top">• <a href="#UserExists">UserExists</a>:</td><td> </td><td align="left" valign="top">
</td></tr>
<tr><td align="left" valign="top">• <a href="#IsGreaterThan">IsGreaterThan</a>:</td><td> </td><td align="left" valign="top">
</td></tr>
<tr><td align="left" valign="top">• <a href="#IsLessThan">IsLessThan</a>:</td><td> </td><td align="left" valign="top">
</td></tr>
<tr><td align="left" valign="top">• <a href="#Examples-setting-classes">Examples setting classes</a>:</td><td> </td><td align="left" valign="top">
</td></tr>
</table>
<hr>
<a name="Setting-classes-with-special-functions"></a>
<div class="header">
<p>
Next: <a href="#AccessedBefore" accesskey="n" rel="next">AccessedBefore</a>, Previous: <a href="#Cfengine-classes" accesskey="p" rel="previous">Cfengine classes</a>, Up: <a href="#Cfengine-classes" accesskey="u" rel="up">Cfengine classes</a> [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Variable-Index" title="Index" rel="index">Index</a>]</p>
</div>
<a name="Setting-classes-with-special-functions-1"></a>
<h4 class="subsection">4.5.1 Setting classes with special functions</h4>
<p>Cfengine provides a number of built-in functions for evaluating classes,
based on file tests. Using these built-in functions is quicker than
calling the shell <code>test</code> function. The time functions place their
arguments in chronological order.
</p>
<hr>
<a name="AccessedBefore"></a>
<div class="header">
<p>
Next: <a href="#ChangedBefore" accesskey="n" rel="next">ChangedBefore</a>, Previous: <a href="#Setting-classes-with-special-functions" accesskey="p" rel="previous">Setting classes with special functions</a>, Up: <a href="#Cfengine-classes" accesskey="u" rel="up">Cfengine classes</a> [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Variable-Index" title="Index" rel="index">Index</a>]</p>
</div>
<a name="AccessedBefore-1"></a>
<h4 class="subsection">4.5.2 AccessedBefore</h4>
<div class="smallexample">
<pre class="smallexample">AccessedBefore(<var>f1</var>,<var>f2</var>)
</pre></div>
<p>True if file 1 was accessed more recently than file 2 (UNIX atime)
</p>
<hr>
<a name="ChangedBefore"></a>
<div class="header">
<p>
Next: <a href="#ClassMatch" accesskey="n" rel="next">ClassMatch</a>, Previous: <a href="#AccessedBefore" accesskey="p" rel="previous">AccessedBefore</a>, Up: <a href="#Cfengine-classes" accesskey="u" rel="up">Cfengine classes</a> [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Variable-Index" title="Index" rel="index">Index</a>]</p>
</div>
<a name="ChangedBefore-1"></a>
<h4 class="subsection">4.5.3 ChangedBefore</h4>
<div class="smallexample">
<pre class="smallexample">ChangedBefore(<var>f1</var>,<var>f2</var>)
</pre></div>
<p>True if file 1’s attributes were changed in any way more recently than file 2’s (UNIX ctime)
</p>
<hr>
<a name="ClassMatch"></a>
<div class="header">
<p>
Next: <a href="#FileExists" accesskey="n" rel="next">FileExists</a>, Previous: <a href="#ChangedBefore" accesskey="p" rel="previous">ChangedBefore</a>, Up: <a href="#Cfengine-classes" accesskey="u" rel="up">Cfengine classes</a> [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Variable-Index" title="Index" rel="index">Index</a>]</p>
</div>
<a name="ClassMatch-1"></a>
<h4 class="subsection">4.5.4 ClassMatch</h4>
<div class="smallexample">
<pre class="smallexample">ClassMatch(<var>regexp</var>)
</pre></div>
<p>True if the quoted regular expression matches one of the currently defined classes.
It is wise to place ClassMatch at the end of your parsing in order to capture
as many of the user-defined classes as possible.
</p>
<div class="smallexample">
<pre class="smallexample">classes:
userdef = ( ClassMatch(.*linux.*) )
</pre></div>
<hr>
<a name="FileExists"></a>
<div class="header">
<p>
Next: <a href="#GroupExists" accesskey="n" rel="next">GroupExists</a>, Previous: <a href="#ClassMatch" accesskey="p" rel="previous">ClassMatch</a>, Up: <a href="#Cfengine-classes" accesskey="u" rel="up">Cfengine classes</a> [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Variable-Index" title="Index" rel="index">Index</a>]</p>
</div>
<a name="FileExists-1"></a>
<h4 class="subsection">4.5.5 FileExists</h4>
<div class="smallexample">
<pre class="smallexample">FileExists(<var>file</var>)
</pre></div>
<p>True if the named file object (file/directory or link) exists.
</p>
<hr>
<a name="GroupExists"></a>
<div class="header">
<p>
Next: <a href="#HostRange" accesskey="n" rel="next">HostRange</a>, Previous: <a href="#FileExists" accesskey="p" rel="previous">FileExists</a>, Up: <a href="#Cfengine-classes" accesskey="u" rel="up">Cfengine classes</a> [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Variable-Index" title="Index" rel="index">Index</a>]</p>
</div>
<a name="GroupExists-1"></a>
<h4 class="subsection">4.5.6 GroupExists</h4>
<div class="smallexample">
<pre class="smallexample">GroupExists(<var>groupname</var>|<var>gid</var>)
</pre></div>
<p>True if the groupname or group id is registered on the system.
</p>
<hr>
<a name="HostRange"></a>
<div class="header">
<p>
Next: <a href="#IsDefined" accesskey="n" rel="next">IsDefined</a>, Previous: <a href="#GroupExists" accesskey="p" rel="previous">GroupExists</a>, Up: <a href="#Cfengine-classes" accesskey="u" rel="up">Cfengine classes</a> [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Variable-Index" title="Index" rel="index">Index</a>]</p>
</div>
<a name="HostRange-1"></a>
<h4 class="subsection">4.5.7 HostRange</h4>
<div class="smallexample">
<pre class="smallexample">HostRange(<var>basename</var>,<var>start-stop</var>)
</pre></div>
<p>True if the current relative domain name begins with basename and ends with an integer
between start and stop. Note well: matching is case insensitive (both hostname and basename are converted to all lower case for comparison.)
</p>
<hr>
<a name="IsDefined"></a>
<div class="header">
<p>
Next: <a href="#IsDir" accesskey="n" rel="next">IsDir</a>, Previous: <a href="#HostRange" accesskey="p" rel="previous">HostRange</a>, Up: <a href="#Cfengine-classes" accesskey="u" rel="up">Cfengine classes</a> [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Variable-Index" title="Index" rel="index">Index</a>]</p>
</div>
<a name="IsDefined-1"></a>
<h4 class="subsection">4.5.8 IsDefined</h4>
<div class="smallexample">
<pre class="smallexample">IsDefined(<var>variable-id</var>)
</pre></div>
<p>True if the named variable is defined. Note well: use the variable name, not its contents (that is,
<code>IsDefined(var)</code>, and not <code>IsDefined(${var})</code>)
</p>
<hr>
<a name="IsDir"></a>
<div class="header">
<p>
Next: <a href="#IsLink" accesskey="n" rel="next">IsLink</a>, Previous: <a href="#IsDefined" accesskey="p" rel="previous">IsDefined</a>, Up: <a href="#Cfengine-classes" accesskey="u" rel="up">Cfengine classes</a> [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Variable-Index" title="Index" rel="index">Index</a>]</p>
</div>
<a name="IsDir-1"></a>
<h4 class="subsection">4.5.9 IsDir</h4>
<div class="smallexample">
<pre class="smallexample">IsDir(<var>f</var>)
</pre></div>
<p>True if the file f is a directory
</p>
<hr>
<a name="IsLink"></a>
<div class="header">
<p>
Next: <a href="#IsPlain" accesskey="n" rel="next">IsPlain</a>, Previous: <a href="#IsDir" accesskey="p" rel="previous">IsDir</a>, Up: <a href="#Cfengine-classes" accesskey="u" rel="up">Cfengine classes</a> [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Variable-Index" title="Index" rel="index">Index</a>]</p>
</div>
<a name="IsLink-1"></a>
<h4 class="subsection">4.5.10 IsLink</h4>
<div class="smallexample">
<pre class="smallexample">IsLink(<var>f</var>)
</pre></div>
<p>True if the file f is a symbolic link
</p>
<hr>
<a name="IsPlain"></a>
<div class="header">
<p>
Next: <a href="#IsNewerThan" accesskey="n" rel="next">IsNewerThan</a>, Previous: <a href="#IsLink" accesskey="p" rel="previous">IsLink</a>, Up: <a href="#Cfengine-classes" accesskey="u" rel="up">Cfengine classes</a> [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Variable-Index" title="Index" rel="index">Index</a>]</p>
</div>
<a name="IsPlain-1"></a>
<h4 class="subsection">4.5.11 IsPlain</h4>
<div class="smallexample">
<pre class="smallexample">IsPlain(<var>f</var>)
</pre></div>
<p>True if the file f is a plain file
</p>
<hr>
<a name="IsNewerThan"></a>
<div class="header">
<p>
Next: <a href="#IPRange" accesskey="n" rel="next">IPRange</a>, Previous: <a href="#IsPlain" accesskey="p" rel="previous">IsPlain</a>, Up: <a href="#Cfengine-classes" accesskey="u" rel="up">Cfengine classes</a> [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Variable-Index" title="Index" rel="index">Index</a>]</p>
</div>
<a name="IsNewerThan-1"></a>
<h4 class="subsection">4.5.12 IsNewerThan</h4>
<div class="smallexample">
<pre class="smallexample">IsNewerThan(<var>f1</var>,<var>f2</var>)
</pre></div>
<p>True if file 2 was modified more recently than file 1 (UNIX mtime)
</p>
<hr>
<a name="IPRange"></a>
<div class="header">
<p>
Next: <a href="#PrepModule" accesskey="n" rel="next">PrepModule</a>, Previous: <a href="#IsNewerThan" accesskey="p" rel="previous">IsNewerThan</a>, Up: <a href="#Cfengine-classes" accesskey="u" rel="up">Cfengine classes</a> [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Variable-Index" title="Index" rel="index">Index</a>]</p>
</div>
<a name="IPRange-1"></a>
<h4 class="subsection">4.5.13 IPRange</h4>
<div class="smallexample">
<pre class="smallexample">IPRange(<var>address-range</var>)
</pre></div>
<p>True if the current host lies within the specified IP range
</p>
<hr>
<a name="PrepModule"></a>
<div class="header">
<p>
Next: <a href="#Regcmp" accesskey="n" rel="next">Regcmp</a>, Previous: <a href="#IPRange" accesskey="p" rel="previous">IPRange</a>, Up: <a href="#Cfengine-classes" accesskey="u" rel="up">Cfengine classes</a> [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Variable-Index" title="Index" rel="index">Index</a>]</p>
</div>
<a name="PrepModule-1"></a>
<h4 class="subsection">4.5.14 PrepModule</h4>
<div class="smallexample">
<pre class="smallexample">PrepModule(<var>module</var>,<var>arg1 arg2...</var>)
</pre></div>
<p>True if the named module exists and can be executed. The module is assumed to
follow the standard programming interface for modules (see Writing plugin modules in tutorial).
Unlike actionsequence modules, these modules are evaluated immediately on parsing.
Note that the module should be specified relative to the authorized module directory.
<a name="index-Module-directory"></a>
<a name="index-PrepModule"></a>
<a name="index-Modules-executed-immediately"></a>
</p>
<hr>
<a name="Regcmp"></a>
<div class="header">
<p>
Next: <a href="#ReturnsZero" accesskey="n" rel="next">ReturnsZero</a>, Previous: <a href="#PrepModule" accesskey="p" rel="previous">PrepModule</a>, Up: <a href="#Cfengine-classes" accesskey="u" rel="up">Cfengine classes</a> [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Variable-Index" title="Index" rel="index">Index</a>]</p>
</div>
<a name="Regcmp-1"></a>
<h4 class="subsection">4.5.15 Regcmp</h4>
<div class="smallexample">
<pre class="smallexample">Regcmp(<var>regexp</var>,<var>string or list separated string</var>)
</pre></div>
<p>True if the string matched the regular expression regexp.
</p>
<hr>
<a name="ReturnsZero"></a>
<div class="header">
<p>
Next: <a href="#ReturnsZeroShell" accesskey="n" rel="next">ReturnsZeroShell</a>, Previous: <a href="#Regcmp" accesskey="p" rel="previous">Regcmp</a>, Up: <a href="#Cfengine-classes" accesskey="u" rel="up">Cfengine classes</a> [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Variable-Index" title="Index" rel="index">Index</a>]</p>
</div>
<a name="ReturnsZero-1"></a>
<h4 class="subsection">4.5.16 ReturnsZero</h4>
<div class="smallexample">
<pre class="smallexample">ReturnsZero(<var>command</var>)
</pre></div>
<p>True if the named shell command returns with exit code zero (success).
The command is executed without a shell wrapper.
</p>
<hr>
<a name="ReturnsZeroShell"></a>
<div class="header">
<p>
Next: <a href="#Strcmp" accesskey="n" rel="next">Strcmp</a>, Previous: <a href="#ReturnsZero" accesskey="p" rel="previous">ReturnsZero</a>, Up: <a href="#Cfengine-classes" accesskey="u" rel="up">Cfengine classes</a> [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Variable-Index" title="Index" rel="index">Index</a>]</p>
</div>
<a name="ReturnsZeroShell-1"></a>
<h4 class="subsection">4.5.17 ReturnsZeroShell</h4>
<div class="smallexample">
<pre class="smallexample">ReturnsZeroShell(<var>command</var>)
</pre></div>
<p>True if the named shell command returns with exit code zero (success) when executed
in the environment of a shell wrapper.
</p>
<hr>
<a name="Strcmp"></a>
<div class="header">
<p>
Next: <a href="#UserExists" accesskey="n" rel="next">UserExists</a>, Previous: <a href="#ReturnsZeroShell" accesskey="p" rel="previous">ReturnsZeroShell</a>, Up: <a href="#Cfengine-classes" accesskey="u" rel="up">Cfengine classes</a> [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Variable-Index" title="Index" rel="index">Index</a>]</p>
</div>
<a name="Strcmp-1"></a>
<h4 class="subsection">4.5.18 Strcmp</h4>
<div class="smallexample">
<pre class="smallexample">Strcmp(<var>s1</var>,<var>s2</var>)
</pre></div>
<p>True if the string s1 exactly matches s2
</p>
<hr>
<a name="UserExists"></a>
<div class="header">
<p>
Next: <a href="#IsGreaterThan" accesskey="n" rel="next">IsGreaterThan</a>, Previous: <a href="#Strcmp" accesskey="p" rel="previous">Strcmp</a>, Up: <a href="#Cfengine-classes" accesskey="u" rel="up">Cfengine classes</a> [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Variable-Index" title="Index" rel="index">Index</a>]</p>
</div>
<a name="UserExists-1"></a>
<h4 class="subsection">4.5.19 UserExists</h4>
<div class="smallexample">
<pre class="smallexample">UserExists(<var>username</var>|<var>uid</var>)
</pre></div>
<p>True if the username or user id is registered on the system (this does not imply that
the user can log in or has a home directory).
</p>
<a name="index-IsGreatThan"></a>
<a name="index-IsLessThan"></a>
<a name="index-_003e"></a>
<a name="index-_003c"></a>
<hr>
<a name="IsGreaterThan"></a>
<div class="header">
<p>
Next: <a href="#IsLessThan" accesskey="n" rel="next">IsLessThan</a>, Previous: <a href="#UserExists" accesskey="p" rel="previous">UserExists</a>, Up: <a href="#Cfengine-classes" accesskey="u" rel="up">Cfengine classes</a> [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Variable-Index" title="Index" rel="index">Index</a>]</p>
</div>
<a name="IsGreaterThan-1"></a>
<h4 class="subsection">4.5.20 IsGreaterThan</h4>
<div class="smallexample">
<pre class="smallexample">IsGreaterThan(<var>s1</var>,<var>s2</var>)
</pre></div>
<p>Returns true if the value of s1 is greater than the value of s2. Note
that, if the strings have numerical values, a numerical comparison is
performed, otherwise a string comparison is used.
</p>
<hr>
<a name="IsLessThan"></a>
<div class="header">
<p>
Next: <a href="#Examples-setting-classes" accesskey="n" rel="next">Examples setting classes</a>, Previous: <a href="#IsGreaterThan" accesskey="p" rel="previous">IsGreaterThan</a>, Up: <a href="#Cfengine-classes" accesskey="u" rel="up">Cfengine classes</a> [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Variable-Index" title="Index" rel="index">Index</a>]</p>
</div>
<a name="IsLessThan-1"></a>
<h4 class="subsection">4.5.21 IsLessThan</h4>
<div class="smallexample">
<pre class="smallexample">IsLessThan(<var>s1</var>,<var>s2</var>)
</pre></div>
<p>Returns true if the value of s1 is less than the value of s2. Note
that, if the strings have numerical values, a numerical comparison is
performed, otherwise a string comparison is used.
</p><div class="smallexample">
<pre class="smallexample">
control:
actionsequence = ( files )
a = ( 2.12 )
b = ( 2.11 )
classes:
lt = ( IsLessThan(${a},${b}) )
gt = ( IsGreaterThan(${a},${b}) )
alerts:
lt:: "$(a) LESS THAN $(b)"
gt:: "$(a) GREATER THAN $(b)"
</pre></div>
<hr>
<a name="Examples-setting-classes"></a>
<div class="header">
<p>
Previous: <a href="#IsLessThan" accesskey="p" rel="previous">IsLessThan</a>, Up: <a href="#Cfengine-classes" accesskey="u" rel="up">Cfengine classes</a> [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Variable-Index" title="Index" rel="index">Index</a>]</p>
</div>
<a name="Examples-setting-classes-1"></a>
<h4 class="subsection">4.5.22 Examples setting classes</h4>
<p>For example:
</p>
<div class="smallexample">
<pre class="smallexample">
classes:
access_to_dir = ( ReturnsZero(/bin/cd /mydir) )
compare = ( ChangedBefore(/etc/passwd_master,/etc/passwd) )
isplain = ( IsPlain(/tmp/import) )
inrange = ( IPRange(128.39.89.10-15) )
CIDR = ( IPRange(128.39.89.10/24) )
compute_nodes = ( HostRange(cpu-,01-32)
gotinit = ( PrepModule(startup2,"arg1 arg2") )
</pre></div>
<a name="index-Classes_002c-built_002din-functions"></a>
<a name="index-Testing-files"></a>
<a name="index-File-types"></a>
<a name="index-Comparing-file-objects"></a>
<a name="index-ReturnsZero_0028_0029"></a>
<a name="index-ChangedBefore_0028_0029"></a>
<a name="index-IsPlain_0028_0029"></a>
<a name="index-IsDir_0028_0029"></a>
<a name="index-IsLink_0028_0029"></a>
<a name="index-IsNewerThan_0028_0029"></a>
<a name="index-AccessedBefore_0028_0029"></a>
<hr>
<a name="acl"></a>
<div class="header">
<p>
Next: <a href="#alerts" accesskey="n" rel="next">alerts</a>, Previous: <a href="#Cfengine-classes" accesskey="p" rel="previous">Cfengine classes</a>, Up: <a href="#Cfagent-reference" accesskey="u" rel="up">Cfagent reference</a> [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Variable-Index" title="Index" rel="index">Index</a>]</p>
</div>
<a name="acl-1"></a>
<h3 class="section">4.6 acl</h3>
<a name="index-Access-control-lists"></a>
<a name="index-ACLs"></a>
<table class="cartouche" border="1"><tr><td>
<p><!-- /@w -->
</p><div class="smallexample">
<pre class="smallexample">
acl:
<var>class</var>::
{ <var>acl-alias</var>
<var>action</var>
}
</pre></div>
</td></tr></table>
<p>Cfengine’s <code>ACL</code> feature is a common interface for managing
filesystem access control lists (ACLs). An access control list is an
extended file permission. It allows you to open or close a file to a
named list of users (without having to create a group for those users);
similarly, it allows you to open or close a file for a list of groups.
Several operating systems have access control lists, but each typically
has a different syntax and different user interface to this facility,
making it very awkward to use. This part of a cfengine configuration
simplifies the management of ACLs by providing a more convenient user
interface for controlling them and—as far as possible—a common
syntax.
</p>
<p>An ACL may, by its very nature, contain a lot of information. Normally
you would set ACLs in a <code>files</code> command, See <a href="#files">files</a>, or a
<code>copy</code> command, See <a href="#copy">copy</a>. It would be too cumbersome to repeat
all of the information in every command in your configuration, so
cfengine simplifies this by first associating an alias together with a
complex list of ACL information. This alias is then used to represent
the whole bundle of ACL entries in a <code>files</code> or <code>copy</code>
command. The form of an ACL is similar to the form of an
<code>editfiles</code> command. It is a bundle of information concerning a
file’s permissions.
</p>
<div class="smallexample">
<pre class="smallexample">
{ <var>acl-alias</var>
method:<b>overwrite</b><var>/append</var>
fstype:<var>posix/solaris/dfs/afs/hpux/nt</var>
<var>acl_type</var>:<var>user/group</var>:<var>permissions</var>
<var>acl_type</var>:<var>user/group</var>:<var>permissions</var>
...
}
</pre></div>
<p>The name <var>acl-alias</var> can be any identifier containing alphanumeric
characters and underscores. This is what you will use to refer to the
ACL entries in practice. The method entry tells cfengine how to
interpret the entries: should a file’s ACLs be overwritten or only
adjusted? Since the filesystems from different developers all use
different models for ACLs, you must also tell cfengine what kind of
filesystem the file resides on. Currently only Solaris and DCE/DFS ACLs
are implemented.
</p>
<p>NOTE: if you set both file permissions and ACLs the file permissions
override the ACLs.
</p>
<table class="menu" border="0" cellspacing="0">
<tr><td align="left" valign="top">• <a href="#ACEs" accesskey="1">ACEs</a>:</td><td> </td><td align="left" valign="top">
</td></tr>
<tr><td align="left" valign="top">• <a href="#Solaris-ACLs" accesskey="2">Solaris ACLs</a>:</td><td> </td><td align="left" valign="top">
</td></tr>
<tr><td align="left" valign="top">• <a href="#DFS-ACLs" accesskey="3">DFS ACLs</a>:</td><td> </td><td align="left" valign="top">
</td></tr>
<tr><td align="left" valign="top">• <a href="#NT-ACLs" accesskey="4">NT ACLs</a>:</td><td> </td><td align="left" valign="top">
</td></tr>
<tr><td align="left" valign="top">• <a href="#Windows-ACL-Example" accesskey="5">Windows ACL Example</a>:</td><td> </td><td align="left" valign="top">
</td></tr>
<tr><td align="left" valign="top">• <a href="#Posix-ACL-Example" accesskey="6">Posix ACL Example</a>:</td><td> </td><td align="left" valign="top">
</td></tr>
</table>
<hr>
<a name="ACEs"></a>
<div class="header">
<p>
Next: <a href="#Solaris-ACLs" accesskey="n" rel="next">Solaris ACLs</a>, Previous: <a href="#acl" accesskey="p" rel="previous">acl</a>, Up: <a href="#acl" accesskey="u" rel="up">acl</a> [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Variable-Index" title="Index" rel="index">Index</a>]</p>
</div>
<a name="Access-control-entries"></a>
<h4 class="subsection">4.6.1 Access control entries</h4>
<p>An access control list is build of any number of individual access
control entries (ACEs). The ACEs has the following general syntax:
</p>
<div class="smallexample">
<pre class="smallexample"> <var>acl_type</var>:<var>user/group</var>:<var>permissions</var>
</pre></div>
<p>The user or group is sometimes referred to as a <em>key</em>.
<a name="index-ACL-key"></a>
</p>
<p>For an explanation of ACL types and their use, refer to your local
manual page. However, note that for each type of filesystem, there are
certain entries which must exist in an ACL. If you are creating a new
ACL from scratch, you must specify these. For example, in Solaris ACLs
you must have entries for <code>user</code>, <code>group</code> and <code>other</code>.
Under DFS you need what DFS calls a <code>user_obj</code>, <code>group_obj</code>
and an <code>other_obj</code>, and in some cases <code>mask_obj</code>. In cfengine
syntax these are called <code>user:*:</code>, <code>other:*:</code> and
<code>mask:*:</code>, as described below. If you are appending to an existing
entry, you do not have to re-specify these unless you want to change
them.
</p>
<p>Cfengine can overwrite (replace) or append to one or more ACL
entries.
</p>
<dl compact="compact">
<dt><code>overwrite</code></dt>
<dd><p><code>method:overwrite</code> is the default. This sets the ACL according to
the specified entries which follow. The existing ACL will be
overwritten completely.
</p>
</dd>
<dt><code>append</code></dt>
<dd><p><code>method:append</code> adds or modifies one or more specified ACL entries.
If an entry already exists for the specified type and user/group, the
specified permission bits will be added to the old permissions. If there
is no ACL entry for the given type and user/group, a new entry will be
appended.
</p>
</dd>
</dl>
<p>If the new ACL exactly matches the existing ACL, the ACL is not
replaced.
</p>
<p>The individual bits in an ACE may be either added subtracted or
set equal to a specified mask. The ‘<samp>+</samp>’ symbol means add,
the ‘<samp>-</samp>’ symbol subtract and ‘<samp>=</samp>’ means set equal to.
Here are some examples:
</p>
<div class="smallexample">
<pre class="smallexample">
<var>acltype</var>:<var>id/*</var>:<var>mask</var>
user:mark:+rx,-w
user:ds:=r
user:jacobs:noaccess
user:forgiven:default
user:*:rw
group:*:r
other:*:r
</pre></div>
<p>The keyword <code>noaccess</code> means set all access bits to zero for that
user, i.e. remove all permissions. The keyword <code>default</code> means
remove the named user from the access crontrol list altogether, so that
the default permissions apply. A star/asterisk in the centre field
indicates that the user or group ID is implicitly specified as of the
owner of the file, or that no ID is applicable at all (as is the case for ‘other’).
</p>
<hr>
<a name="Solaris-ACLs"></a>
<div class="header">
<p>
Next: <a href="#DFS-ACLs" accesskey="n" rel="next">DFS ACLs</a>, Previous: <a href="#ACEs" accesskey="p" rel="previous">ACEs</a>, Up: <a href="#acl" accesskey="u" rel="up">acl</a> [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Variable-Index" title="Index" rel="index">Index</a>]</p>
</div>
<a name="Solaris-ACLs-1"></a>
<h4 class="subsection">4.6.2 Solaris ACLs</h4>
<p>Under Solaris, the ACL type can be one of the following:
</p>
<div class="smallexample">
<pre class="smallexample"> user
group
mask
other
default_user
default_group
default_mask
default_other
</pre></div>
<p>A user or group can be specified to the user, group, default_user and
default_group types.
Solaris ACL permissions are the normal UNIX permissions bits ‘<samp>rwx</samp>’,
where:
</p>
<div class="smallexample">
<pre class="smallexample"> <var>
<b>r</b> - Grants read privileges.
<b>w</b> - Grants write privileges.
<b>x</b> - Grants execute privileges.</var>
</pre></div>
<hr>
<a name="DFS-ACLs"></a>
<div class="header">
<p>
Next: <a href="#NT-ACLs" accesskey="n" rel="next">NT ACLs</a>, Previous: <a href="#Solaris-ACLs" accesskey="p" rel="previous">Solaris ACLs</a>, Up: <a href="#acl" accesskey="u" rel="up">acl</a> [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Variable-Index" title="Index" rel="index">Index</a>]</p>
</div>
<a name="DFS-ACLs-1"></a>
<h4 class="subsection">4.6.3 DFS ACLs</h4>
<a name="index-DCE-key"></a>
<a name="index-Key_002c-ACL"></a>
<p>In DCE, the ACL type can be one of the following:
</p>
<div class="smallexample">
<pre class="smallexample"> other
mask
any
unauthenticated
user
group
foreign_other
foreign_user
foreign_group
</pre></div>
<p>The <code>user</code>, <code>group</code>, <code>foreign_user</code> and <code>foreign_group</code>
types require that you specify a user or group. The DCE documentation
refers to types <code>user_obj</code>, <code>group_obj</code> and so on. In the
cfengine implementation, the ugly ‘<samp>_obj</samp>’ suffix has been dropped to
make these more in keeping with the POSIX names. <code>user_obj::</code>, is
equivalent to <code>user:*:</code> is cfengine. The star/asterisk implies that
the ACL applies to the owner of the file object.
</p>
<p>DFS permissions are comprised of the bits
‘<samp>crwxid</samp>’, where:
</p>
<p><!-- /@w -->
</p><div class="smallexample">
<pre class="smallexample"> <b>c</b> - Grants control privileges, to modify an acl.
<b>r</b> - Grants read privileges.
<b>w</b> - Grants write privileges.
<b>x</b> - Grants execute privileges.
<b>i</b> - Grants insert privileges.
<b>d</b> - Grants delete privileges.
</pre></div>
<p>See the DCE/DFS documentation for more information about this.
</p>
<p>It is not possible to set ACLs in foreign cells currently using
cfengine, but you can still have all of your ACL definitions in the same
file. You must however arrange for the file to be executed on the server
for the cell concerned. Note also that you must perform a DCE login
(normally as user ‘<samp>cell_admin</samp>’) in order to set ACLs on files
which are not owned by the owner of the cfengine-process. This is
because you must have a valid security ticket.
</p>
<hr>
<a name="NT-ACLs"></a>
<div class="header">
<p>
Next: <a href="#Windows-ACL-Example" accesskey="n" rel="next">Windows ACL Example</a>, Previous: <a href="#DFS-ACLs" accesskey="p" rel="previous">DFS ACLs</a>, Up: <a href="#acl" accesskey="u" rel="up">acl</a> [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Variable-Index" title="Index" rel="index">Index</a>]</p>
</div>
<a name="NT-ACLs-1"></a>
<h4 class="subsection">4.6.4 NT ACLs</h4>
<a name="index-NT_002c-ACL"></a>
<p>NT ACEs are written as follows:
</p>
<div class="smallexample">
<pre class="smallexample"> acl_type:user/group:permissions:accesstype
</pre></div>
<p>The actual change consists of the extra field containing the access
type. A star/asterisk in the field for <var>user/group</var> would
normally imply that the ACL applies to the owner of the file
object. However this functionality is as of today not yet implemented.
</p>
<p>In NT, the ACL type can be one of the following:
</p>
<div class="smallexample">
<pre class="smallexample"> user
group
</pre></div>
<p>Both types require that you specify the name of a user or a group.
</p>
<p>NT permissions are comprised of the bits ‘<samp>rwxdpo</samp>’, where:
</p>
<div class="smallexample">
<pre class="smallexample"> r - Read privileges
w - Write privileges
x - Execute privileges
d - Delete privileges
p - Privileges to change the permissions on the file
o - Privileges to take ownership of the file
</pre></div>
<p>In addition to any combination of these bits, the word <code>noaccess</code>
or <code>default</code> can be used as explained in the previous section. NT
comes with some standard, predefined permissions. The standards are only
a predefined combination of the different bits specified above and are
provided with cfengine as well. You can use the standards by setting the
permission to <code>read</code>, <code>change</code> or <code>all</code>. The bit
implementation of each standard is as on NT:
</p>
<div class="smallexample">
<pre class="smallexample"> read - rx
change - rwxd
all - rwxdpo
</pre></div>
<p>where the bits follow the earlier definition. The keywords mentioned
above can only be used alone, and not in combination with ‘<samp>+</samp>’,
‘<samp>-</samp>’, ‘<samp>=</samp>’ and/or other permission bits.
</p>
<p>NT defines several different access types, of which only two are used in
connection with the ACL type that is implemented in cfengine for NT. The
access type can be one of the following:
</p>
<div class="smallexample">
<pre class="smallexample"> allowed
denied
</pre></div>
<p>Intuitively, <code>allowed</code> access grants the specified permissions to
the user, whilst <code>denied</code> denies the user the specified
permissions. If no access type is specified, the default is
<code>allowed</code>. This enables cfengine’s behaviour as on UNIX systems
without any changes to the configuration file. If the permissions
<code>noaccess</code> or <code>default</code> is used, the access type will be
irrelevant.
</p>
<hr>
<a name="Windows-ACL-Example"></a>
<div class="header">
<p>
Next: <a href="#Posix-ACL-Example" accesskey="n" rel="next">Posix ACL Example</a>, Previous: <a href="#NT-ACLs" accesskey="p" rel="previous">NT ACLs</a>, Up: <a href="#acl" accesskey="u" rel="up">acl</a> [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Variable-Index" title="Index" rel="index">Index</a>]</p>
</div>
<a name="Windows-ACL-Example-1"></a>
<h4 class="subsection">4.6.5 Windows ACL Example</h4>
<p>Here is an example of a configuration file for an NT ACL:
</p>
<div class="smallexample">
<pre class="smallexample">control:
actionsequence = ( files )
domain = ( iu.hioslo.no )
files:
$(HOME)/tt acl=acl_alias1 action=fixall
acl:
{ acl_alias1
method:overwrite
fstype:nt
user:gustafb:rwx:allowed
user:mark:all:allowed
user:toreo:read:allowed
user:torej:default:allowed
user:ds2:+rwx:allowed
group:dummy:all:denied
group:iu:read:allowed
group:root:all:allowed
group:guest:dpo:denied
}
</pre></div>
<hr>
<a name="Posix-ACL-Example"></a>
<div class="header">
<p>
Previous: <a href="#Windows-ACL-Example" accesskey="p" rel="previous">Windows ACL Example</a>, Up: <a href="#acl" accesskey="u" rel="up">acl</a> [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Variable-Index" title="Index" rel="index">Index</a>]</p>
</div>
<a name="Posix-ACL-Example-1"></a>
<h4 class="subsection">4.6.6 Posix ACL Example</h4>
<p>Here is an example of a configuration file for one Solaris ACL and one DCE/DFS ACL:
</p>
<div class="smallexample">
<pre class="smallexample">control:
actionsequence = ( files )
domain = ( iu.hioslo.no )
files:
$(HOME)/tt acl=acl_alias1 action=fixall
/:/bigfile acl=acl_alias2 action=fixall
acl:
{ acl_alias1
method:overwrite
fstype:posix
user:*:rwx
user:mark:=rwx
user:sowille:=rx
user:toreo:=rx
user:torej:default
user:ds2:+rwx
group:*:rx
group:iu:r
group:root:x
mask:*:rx
other:*:rx
default_user:*:=rw
default_user:mark:+rwx
default_user:ds:=rwx
default_group::=r
default_group:iu:+r
default_mask::w
default_other::rwx
}
{ acl_alias2
method:overwrite
fstype:dfs
user:*:rwxcid
group:*:rxd
other:*:wxir
mask:*:rxw
user:/.../iu.hioslo.no/cell_admin:rc
group:/.../iu.hioslo.no/acct-admin:rwxcid
user:/.../iu.hioslo.no/root:rx
}
</pre></div>
<hr>
<a name="alerts"></a>
<div class="header">
<p>
Next: <a href="#binservers" accesskey="n" rel="next">binservers</a>, Previous: <a href="#acl" accesskey="p" rel="previous">acl</a>, Up: <a href="#Cfagent-reference" accesskey="u" rel="up">Cfagent reference</a> [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Variable-Index" title="Index" rel="index">Index</a>]</p>
</div>
<a name="alerts-1"></a>
<h3 class="section">4.7 alerts</h3>
<a name="index-Alerts"></a>
<a name="index-alerts"></a>
<p>Alerts are normally just messages that are printed when classes become activated
in order to alert the system administrator to some condition that has arisen.
Alerts can also be special functions, like <code>ShowState()</code> that generate
system output.
</p>
<p>Alerts cannot belong to the class <code>any</code>, that would generate a message from
every host. In a huge network this could result in vast amounts of Email. This behaviour
can be forced, however, by creating an alias for the class ‘any’ that is defined on
the affected hosts.
</p>
<div class="smallexample">
<pre class="smallexample">
alerts:
class::
<var>quoted message</var>
ifelapsed=<var>time</var>
audit=<var>true/false</var>
ShowState(<var>parameter</var>)
SysLog(<var>priority</var>,<var>message</var>)
SetState(<var>name</var>,<var>ttl</var>,<var>policy</var>)
UnSetState(<var>name</var>)
FriendStatus(<var>hours</var>)
PrintFile(<samp>filename</samp>,<var>lines</var>)
</pre></div>
<p>For example:
<a name="index-ShowState_0028_0029"></a>
<a name="index-SysLog_0028_0029"></a>
<a name="index-SetState_0028_0029"></a>
<a name="index-UnsetState_0028_0029"></a>
</p>
<p><!-- /@w -->
</p><div class="smallexample">
<pre class="smallexample">
alerts:
myclass::
"Reminder: say hello every hour" ifelapsed=60
nfsd_in_high_dev2::
"High NFS server access rate 2dev at $(host) value $(value_nfsd_in) av $(average_nfsd_in) pm $(stddev_nfsd_in)"
ShowState(incoming.nfs)
# ROOT PROCS
anomaly_hosts.RootProcs_high_dev2::
"RootProc anomaly high 2 dev on $(host) value $(value_rootprocs) av $(average_rootprocs) pm $(stddev_rootprocs)"
ShowState(rootprocs)
</pre></div>
<p>The <code>ShowState()</code> function reports on state gathered by the cfenvd
daemon.
</p>
<div class="smallexample">
<pre class="smallexample">ShowState(incoming.tcpsyn)
ShowState(outgoing.smtp)
ShowState(incoming.www)
ShowState(outgoing.www)
ShowState(procs)
ShowState(rootprocs)
ShowState(otherprocs)
ShowState(users)
</pre></div>
<p>To limit the frequency of alerts, you can set locking times:
</p>
<div class="smallexample">
<pre class="smallexample"> # ROOT PROCS
anomaly_hosts.RootProcs_high_dev2::
"RootProc anomaly high 2 dev on $(host) value $(value_rootprocs) av $(average_rootprocs) pm $(stddev_rootprocs)"
ShowState(rootprocs) ifelapsed=10 expireafter=20
</pre></div>
<p>Alerts can also be channeled directly to syslog, to avoid extraneous console messages or email.
</p>
<div class="smallexample">
<pre class="smallexample">
SysLog(LOG_ERR,"Test syslog message")
</pre></div>
<p>One application for alerts is to pass signals from one cfengine to
another by persistent, shared memory. For example, suppose a short-lived anomaly event
triggers a class that relates to a security alert. The event class might be too short-lived
to be followed up by cfagent in full. One could thus set a long term class that would
trigger up several follow-up checks.
A persistent class could also be used to exclude an operation for an interval of time.
</p>
<p>Persistent class memory can be
added through a system alert functions to give timer behaviour.
For example, consider setting
a class that acts like a non-resettable timer. It is defined for exactly 10
minutes before expiring.
</p>
<div class="smallexample">
<pre class="smallexample">
SetState("preserved_class",10,Preserve)
</pre></div>
<p>Or to set a class that acts as a resettable timer. It is defined for 60 minutes unless
the SetState call is called again to extend its lifetime.
</p>
<div class="smallexample">
<pre class="smallexample">
SetState(non_preserved_class,60,Reset)
</pre></div>
<p>Existing persistent classes can be deleted with:
</p>
<div class="smallexample">
<pre class="smallexample">
UnsetState(myclass)
</pre></div>
<p>The <code>FriendStatus</code> function is available from version 2.1.4 and
displays a message if hosts that normally have a cfengine protocol
connection with the current host have not connected for more than than
specified number of hours. If the number of hours is set to zero,
cfengine uses a machine-learned expectation value for the time and uses
this to report. The friend status of a host is thus the expectation that
there is a problem with a remote peer. Expected contact rates of more than
the variable <code>LastSeenExpireAfter</code> are ignored as spurious, See <a href="#lastseenexpireafter">lastseenexpireafter</a>.
</p>
<a name="index-FriendStatus"></a>
<a name="index-Last-Seen-database"></a>
<a name="index-Peer-watching-_0028FriendStatus_0029"></a>
<a name="index-Monitoring-other-hosts"></a>
<a name="index-PrintFile"></a>
<p>The <code>PrintFile</code> function can be used to display short excerpts from text files.
The arguments are the filename and a maximum number of lines to be printed.
</p>
<hr>
<a name="binservers"></a>
<div class="header">
<p>
Next: <a href="#broadcast" accesskey="n" rel="next">broadcast</a>, Previous: <a href="#alerts" accesskey="p" rel="previous">alerts</a>, Up: <a href="#Cfagent-reference" accesskey="u" rel="up">Cfagent reference</a> [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Variable-Index" title="Index" rel="index">Index</a>]</p>
</div>
<a name="binservers-1"></a>
<h3 class="section">4.8 binservers</h3>
<a name="index-Binary-servers_002c-defining"></a>
<a name="index-Defining-a-binary-server"></a>
<a name="index-binservers"></a>
<p>The <code>binservers</code> declaration need only be used if you are using
cfengine’s model for mounting NFS filesystems. This declaration informs
hosts of which other hosts on the network possess filesystems containing
software (binary files) which client hosts should mount. This includes
resources like programs in <code>/usr/local</code> and so on. A host may have
several binary servers, since there may be several machines to which
disks are physically attached. In most cases, on a well organized
network, there will be only one <em>architecture server</em> per UNIX
platform type, for instance a SunOS server, an ULTRIX server and so on.
</p>
<p>Binary servers are defined as follows:
</p>
<div class="smallexample">
<pre class="smallexample">
binservers:
physics.sun4:: sunserver sunserver2
physics.linux:: linuxserver
</pre></div>
<p>The meaning of this declaration is the following. All hosts of type
<code>sun4</code> which are members of the group <code>physics</code> should mount
any binaries declared in the <code>mountables</code> resource list which
belong to hosts <code>sunserver</code> or <code>sunserver2</code>. Similarly all
<code>linux</code> machines should mount binary filesystems in the mountables
list from <code>linuxserver</code>.
</p>
<p>Cfengine knows the difference between binaries and home directories in
the <code>mountables</code> list, because home directories match the pattern
given by <code>homepattern</code>. See <a href="#homepattern">homepattern</a>. See <a href="#homeservers">homeservers</a>.
</p>
<p>Note that every host is a binary server for itself, so that the first
binary server (and that with highest priority) is always the current
host. This ensures that local filesystems are always used in preference
to NFS mounted filesystems. This is only relevant in connection with
the variable <code>$(binserver)</code>.
<a name="index-Binary-servers_002c-priority"></a>
</p>
<hr>
<a name="broadcast"></a>
<div class="header">
<p>
Next: <a href="#control" accesskey="n" rel="next">control</a>, Previous: <a href="#binservers" accesskey="p" rel="previous">binservers</a>, Up: <a href="#Cfagent-reference" accesskey="u" rel="up">Cfagent reference</a> [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Variable-Index" title="Index" rel="index">Index</a>]</p>
</div>
<a name="broadcast-1"></a>
<h3 class="section">4.9 broadcast</h3>
<a name="index-Broadcast-address"></a>
<a name="index-broadcast"></a>
<p>This information is used to configure the network interface for each host.
</p>
<p>Every local area network has a convention for determining which internet
address is used for broadcast requests. Normally this is an address of
the form <code>aaa.bbb.ccc.255</code> or <code>aaa.bbb.ccc.0</code>. The difference
between these two forms is whether all of the bits in the last number
are ones or zeroes respectively. You must find out which convention is
used at your establishment and tell cfengine using a declaration of the
form:
</p>
<div class="smallexample">
<pre class="smallexample">broadcast:
any::
ones # or zeros, or zeroes
</pre></div>
<a name="index-ones-1"></a>
<a name="index-zeroes"></a>
<a name="index-zeros-1"></a>
<a name="index-ones"></a>
<a name="index-zeros"></a>
<p>In most cases you can use the generic class <code>any</code>, since all of the
hosts on the same subnet have to use the same convention. If your
configuration file encompasses several different subnets with different
conventions then you will need to use a more specific.
</p>
<p>Cfengine computes the actual value of the broadcast address using the
value specified above and the netmask See <a href="#netmask">netmask</a>.
</p>
<hr>
<a name="control"></a>
<div class="header">
<p>
Next: <a href="#classes" accesskey="n" rel="next">classes</a>, Previous: <a href="#broadcast" accesskey="p" rel="previous">broadcast</a>, Up: <a href="#Cfagent-reference" accesskey="u" rel="up">Cfagent reference</a> [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Variable-Index" title="Index" rel="index">Index</a>]</p>
</div>
<a name="control-1"></a>
<h3 class="section">4.10 control</h3>
<a name="index-control-section"></a>
<a name="index-control"></a>
<p>The fundamental piece of any cfengine script or configuration file is
the control section. If you omit this part of a cfengine script, it
will not do anything! The control section is used to define certain
variables, set default values and define the order in which the various
actions you have defined will be carried out. Because cfengine is a
declarative or descriptive language, the order in which actions appear
in the file does not necessarily reflect the order in which they are
executed. The syntax of declarations here is:
</p>
<table class="cartouche" border="1"><tr><td>
<p><!-- /@w -->
</p><div class="smallexample">
<pre class="smallexample"> control:
<var>classes</var>::
<var>variable</var> = ( <var>list or value</var> <var>function</var>(<var>args</var>) )
</pre></div>
</td></tr></table>
<p>The control section is a sequence of declarations which looks something
like the following example:
</p>
<div class="smallexample">
<pre class="smallexample">
control:
site = ( univ )
domain = ( univ.edu )
sysadm = ( admin@computing.univ.edu )
netmask = ( 255.255.252.0 )
timezone = ( EDT )
nfstype = ( nfs )
childlibpath = ( /usr/local:/mylibs )
sensiblesize = ( 1000 )
sensiblecount = ( 2 )
editfilesize = ( 4000 )
actionsequence =
(
links.some
mountall
links.others
files
)
myvariable = ( something )
mymacro = ( somethingelse )
myrandom = ( RandomInt(3,6) )
myexcerpt = ( ReadFile("/etc/services",220))
</pre></div>
<p>Parentheses are required when making a declaring information in cfengine.
Note that a limited number of built-in functions exists:
<a name="index-RandomInt_0028_0029-function"></a>
<a name="index-ReadFile_0028_0029-function"></a>
</p><ul>
<li> <code>ExecResult</code>(<var>command</var>) Executes the named shell command and
inserts the output into the variable. Note that, when this is used in
cfengine built-in list variables, any spaces are interpreted as list
separators. In other lists, normal rules for iteration apply.
</li><li> <code>RandomInt(a,b)</code>
Is substituted for a random number between (a,b).
</li><li> <code>ReadFile</code>(<var>filename</var>,<var>Max number of bytes</var>)
A maximum number of bytes is read from the named file and placed in a variable.
</li></ul>
<p>For more functions, See <a href="#Setting-variables-with-functions">Setting variables with functions</a>.
</p>
<a name="index-site-1"></a>
<a name="index-domain-1"></a>
<a name="index-sysadm-1"></a>
<a name="index-netmask-1"></a>
<a name="index-timezone"></a>
<a name="index-nfstype-1"></a>
<a name="index-sensiblecount"></a>
<a name="index-sensiblesize"></a>
<a name="index-editfilesize"></a>
<a name="index-actionsequence"></a>
<a name="index-LD_005fLIBRARY_005fPATH"></a>
<a name="index-AbortClasses-1"></a>
<p>The meaning of each of these lines is described below.
</p>
<table class="menu" border="0" cellspacing="0">
<tr><td align="left" valign="top">• <a href="#AbortClasses" accesskey="1">AbortClasses</a>:</td><td> </td><td align="left" valign="top">
</td></tr>
<tr><td align="left" valign="top">• <a href="#access" accesskey="2">access</a>:</td><td> </td><td align="left" valign="top">
</td></tr>
<tr><td align="left" valign="top">• <a href="#actionsequence" accesskey="3">actionsequence</a>:</td><td> </td><td align="left" valign="top">
</td></tr>
<tr><td align="left" valign="top">• <a href="#addclasses" accesskey="4">addclasses</a>:</td><td> </td><td align="left" valign="top">
</td></tr>
<tr><td align="left" valign="top">• <a href="#addinstallable" accesskey="5">addinstallable</a>:</td><td> </td><td align="left" valign="top">
</td></tr>
<tr><td align="left" valign="top">• <a href="#AllowRedefinitionOf" accesskey="6">AllowRedefinitionOf</a>:</td><td> </td><td align="left" valign="top">
</td></tr>
<tr><td align="left" valign="top">• <a href="#Auditing" accesskey="7">Auditing</a>:</td><td> </td><td align="left" valign="top">
</td></tr>
<tr><td align="left" valign="top">• <a href="#AutoDefine" accesskey="8">AutoDefine</a>:</td><td> </td><td align="left" valign="top">
</td></tr>
<tr><td align="left" valign="top">• <a href="#BinaryPaddingChar" accesskey="9">BinaryPaddingChar</a>:</td><td> </td><td align="left" valign="top">
</td></tr>
<tr><td align="left" valign="top">• <a href="#BindToInterface-in-cfagent">BindToInterface in cfagent</a>:</td><td> </td><td align="left" valign="top">
</td></tr>
<tr><td align="left" valign="top">• <a href="#ChecksumDatabase-in-cfagent">ChecksumDatabase in cfagent</a>:</td><td> </td><td align="left" valign="top">
</td></tr>
<tr><td align="left" valign="top">• <a href="#ChecksumPurge">ChecksumPurge</a>:</td><td> </td><td align="left" valign="top">
</td></tr>
<tr><td align="left" valign="top">• <a href="#ChecksumUpdates">ChecksumUpdates</a>:</td><td> </td><td align="left" valign="top">
</td></tr>
<tr><td align="left" valign="top">• <a href="#CompressCommand">CompressCommand</a>:</td><td> </td><td align="left" valign="top">
</td></tr>
<tr><td align="left" valign="top">• <a href="#childlibpath">childlibpath</a>:</td><td> </td><td align="left" valign="top">
</td></tr>
<tr><td align="left" valign="top">• <a href="#copylinks">copylinks</a>:</td><td> </td><td align="left" valign="top">
</td></tr>
<tr><td align="left" valign="top">• <a href="#defaultcopytype">defaultcopytype</a>:</td><td> </td><td align="left" valign="top">
</td></tr>
<tr><td align="left" valign="top">• <a href="#defaultpkgmgr">defaultpkgmgr</a>:</td><td> </td><td align="left" valign="top">
</td></tr>
<tr><td align="left" valign="top">• <a href="#deletenonuserfiles">deletenonuserfiles</a>:</td><td> </td><td align="left" valign="top">
</td></tr>
<tr><td align="left" valign="top">• <a href="#deletenonownerfiles">deletenonownerfiles</a>:</td><td> </td><td align="left" valign="top">
</td></tr>
<tr><td align="left" valign="top">• <a href="#deletenonusermail">deletenonusermail</a>:</td><td> </td><td align="left" valign="top">
</td></tr>
<tr><td align="left" valign="top">• <a href="#deletenonownermail">deletenonownermail</a>:</td><td> </td><td align="left" valign="top">
</td></tr>
<tr><td align="left" valign="top">• <a href="#domain">domain</a>:</td><td> </td><td align="left" valign="top">
</td></tr>
<tr><td align="left" valign="top">• <a href="#dpkginstallcommand">dpkginstallcommand</a>:</td><td> </td><td align="left" valign="top">
</td></tr>
<tr><td align="left" valign="top">• <a href="#dryrun">dryrun</a>:</td><td> </td><td align="left" valign="top">
</td></tr>
<tr><td align="left" valign="top">• <a href="#editbinaryfilesize">editbinaryfilesize</a>:</td><td> </td><td align="left" valign="top">
</td></tr>
<tr><td align="left" valign="top">• <a href="#editfilesize">editfilesize</a>:</td><td> </td><td align="left" valign="top">
</td></tr>
<tr><td align="left" valign="top">• <a href="#emptyresolvconf">emptyresolvconf</a>:</td><td> </td><td align="left" valign="top">
</td></tr>
<tr><td align="left" valign="top">• <a href="#exclamation">exclamation</a>:</td><td> </td><td align="left" valign="top">
</td></tr>
<tr><td align="left" valign="top">• <a href="#excludecopy">excludecopy</a>:</td><td> </td><td align="left" valign="top">
</td></tr>
<tr><td align="left" valign="top">• <a href="#excludelinks">excludelinks</a>:</td><td> </td><td align="left" valign="top">
</td></tr>
<tr><td align="left" valign="top">• <a href="#ExpireAfter">ExpireAfter</a>:</td><td> </td><td align="left" valign="top">
</td></tr>
<tr><td align="left" valign="top">• <a href="#FreeBSDInstallCommand">FreeBSDInstallCommand</a>:</td><td> </td><td align="left" valign="top">
</td></tr>
<tr><td align="left" valign="top">• <a href="#FreeBSDRemoveCommand">FreeBSDRemoveCommand</a>:</td><td> </td><td align="left" valign="top">
</td></tr>
<tr><td align="left" valign="top">• <a href="#FullEncryption">FullEncryption</a>:</td><td> </td><td align="left" valign="top">
</td></tr>
<tr><td align="left" valign="top">• <a href="#homepattern">homepattern</a>:</td><td> </td><td align="left" valign="top">
</td></tr>
<tr><td align="left" valign="top">• <a href="#HostnameKeys-in-cfagent">HostnameKeys in cfagent</a>:</td><td> </td><td align="left" valign="top">
</td></tr>
<tr><td align="left" valign="top">• <a href="#IfElapsed-in-cfagent">IfElapsed in cfagent</a>:</td><td> </td><td align="left" valign="top">
</td></tr>
<tr><td align="left" valign="top">• <a href="#IgnoreFriendRegex">IgnoreFriendRegex</a>:</td><td> </td><td align="left" valign="top">
</td></tr>
<tr><td align="left" valign="top">• <a href="#IgnoreInterfaceRegex">IgnoreInterfaceRegex</a>:</td><td> </td><td align="left" valign="top">
</td></tr>
<tr><td align="left" valign="top">• <a href="#Inform">Inform</a>:</td><td> </td><td align="left" valign="top">
</td></tr>
<tr><td align="left" valign="top">• <a href="#interfacename">interfacename</a>:</td><td> </td><td align="left" valign="top">
</td></tr>
<tr><td align="left" valign="top">• <a href="#fileextension">fileextension</a>:</td><td> </td><td align="left" valign="top">
</td></tr>
<tr><td align="left" valign="top">• <a href="#lastseen">lastseen</a>:</td><td> </td><td align="left" valign="top">
</td></tr>
<tr><td align="left" valign="top">• <a href="#lastseenexpireafter">lastseenexpireafter</a>:</td><td> </td><td align="left" valign="top">
</td></tr>
<tr><td align="left" valign="top">• <a href="#linkcopies">linkcopies</a>:</td><td> </td><td align="left" valign="top">
</td></tr>
<tr><td align="left" valign="top">• <a href="#LogDirectory">LogDirectory</a>:</td><td> </td><td align="left" valign="top">
</td></tr>
<tr><td align="left" valign="top">• <a href="#LogTidyHomeFiles">LogTidyHomeFiles</a>:</td><td> </td><td align="left" valign="top">
</td></tr>
<tr><td align="left" valign="top">• <a href="#moduledirectory">moduledirectory</a>:</td><td> </td><td align="left" valign="top">
</td></tr>
<tr><td align="left" valign="top">• <a href="#mountpattern">mountpattern</a>:</td><td> </td><td align="left" valign="top">
</td></tr>
<tr><td align="left" valign="top">• <a href="#netmask">netmask</a>:</td><td> </td><td align="left" valign="top">
</td></tr>
<tr><td align="left" valign="top">• <a href="#nonalphanumfiles">nonalphanumfiles</a>:</td><td> </td><td align="left" valign="top">
</td></tr>
<tr><td align="left" valign="top">• <a href="#nfstype">nfstype</a>:</td><td> </td><td align="left" valign="top">
</td></tr>
<tr><td align="left" valign="top">• <a href="#PortageInstallCommand">PortageInstallCommand</a>:</td><td> </td><td align="left" valign="top">
</td></tr>
<tr><td align="left" valign="top">• <a href="#repchar">repchar</a>:</td><td> </td><td align="left" valign="top">
</td></tr>
<tr><td align="left" valign="top">• <a href="#repository">repository</a>:</td><td> </td><td align="left" valign="top">
</td></tr>
<tr><td align="left" valign="top">• <a href="#RPMcommand">RPMcommand</a>:</td><td> </td><td align="left" valign="top">
</td></tr>
<tr><td align="left" valign="top">• <a href="#rpminstallcommand">rpminstallcommand</a>:</td><td> </td><td align="left" valign="top">
</td></tr>
<tr><td align="left" valign="top">• <a href="#schedule">schedule</a>:</td><td> </td><td align="left" valign="top">
</td></tr>
<tr><td align="left" valign="top">• <a href="#secureinput">secureinput</a>:</td><td> </td><td align="left" valign="top">
</td></tr>
<tr><td align="left" valign="top">• <a href="#sensiblecount">sensiblecount</a>:</td><td> </td><td align="left" valign="top">
</td></tr>
<tr><td align="left" valign="top">• <a href="#sensiblesize">sensiblesize</a>:</td><td> </td><td align="left" valign="top">
</td></tr>
<tr><td align="left" valign="top">• <a href="#showactions">showactions</a>:</td><td> </td><td align="left" valign="top">
</td></tr>
<tr><td align="left" valign="top">• <a href="#singlecopy">singlecopy</a>:</td><td> </td><td align="left" valign="top">
</td></tr>
<tr><td align="left" valign="top">• <a href="#site">site</a>:</td><td> </td><td align="left" valign="top">
</td></tr>
<tr><td align="left" valign="top">• <a href="#SkipIdentify">SkipIdentify</a>:</td><td> </td><td align="left" valign="top">
</td></tr>
<tr><td align="left" valign="top">• <a href="#Smtpserver">Smtpserver</a>:</td><td> </td><td align="left" valign="top">
</td></tr>
<tr><td align="left" valign="top">• <a href="#SplayTime">SplayTime</a>:</td><td> </td><td align="left" valign="top">
</td></tr>
<tr><td align="left" valign="top">• <a href="#split">split</a>:</td><td> </td><td align="left" valign="top">
</td></tr>
<tr><td align="left" valign="top">• <a href="#spooldirectories">spooldirectories</a>:</td><td> </td><td align="left" valign="top">
</td></tr>
<tr><td align="left" valign="top">• <a href="#suninstallcommand">suninstallcommand</a>:</td><td> </td><td align="left" valign="top">
</td></tr>
<tr><td align="left" valign="top">• <a href="#suspiciousnames">suspiciousnames</a>:</td><td> </td><td align="left" valign="top">
</td></tr>
<tr><td align="left" valign="top">• <a href="#sysadm">sysadm</a>:</td><td> </td><td align="left" valign="top">
</td></tr>
<tr><td align="left" valign="top">• <a href="#Syslog">Syslog</a>:</td><td> </td><td align="left" valign="top">
</td></tr>
<tr><td align="left" valign="top">• <a href="#SyslogFacility">SyslogFacility</a>:</td><td> </td><td align="left" valign="top">
</td></tr>
<tr><td align="left" valign="top">• <a href="#timezone">timezone</a>:</td><td> </td><td align="left" valign="top">
</td></tr>
<tr><td align="left" valign="top">• <a href="#TimeOut">TimeOut</a>:</td><td> </td><td align="left" valign="top">
</td></tr>
<tr><td align="left" valign="top">• <a href="#Verbose">Verbose</a>:</td><td> </td><td align="left" valign="top">
</td></tr>
<tr><td align="left" valign="top">• <a href="#Warnings">Warnings</a>:</td><td> </td><td align="left" valign="top">
</td></tr>
<tr><td align="left" valign="top">• <a href="#warnnonuserfiles">warnnonuserfiles</a>:</td><td> </td><td align="left" valign="top">
</td></tr>
<tr><td align="left" valign="top">• <a href="#warnnonownerfiles">warnnonownerfiles</a>:</td><td> </td><td align="left" valign="top">
</td></tr>
<tr><td align="left" valign="top">• <a href="#warnnonusermail">warnnonusermail</a>:</td><td> </td><td align="left" valign="top">
</td></tr>
<tr><td align="left" valign="top">• <a href="#warnnonownermail">warnnonownermail</a>:</td><td> </td><td align="left" valign="top">
</td></tr>
</table>
<hr>
<a name="AbortClasses"></a>
<div class="header">
<p>
Next: <a href="#access" accesskey="n" rel="next">access</a>, Previous: <a href="#control" accesskey="p" rel="previous">control</a>, Up: <a href="#control" accesskey="u" rel="up">control</a> [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Variable-Index" title="Index" rel="index">Index</a>]</p>
</div>
<a name="AbortClasses-1"></a>
<h4 class="subsection">4.10.1 AbortClasses</h4>
<p>The <code>AbortClasses</code> list is a list of class identifiers that will
result in the abortion of the current cfagent instanitation with an error message
containing the name of the offending class.
</p>
<div class="smallexample">
<pre class="smallexample">
AbortClasses = ( emergency nologin_exists )
</pre></div>
<a name="index-Aborting-cfagent"></a>
<a name="index-AbortClasses"></a>
<p>This mechanism allows one to make controlled exceptions at the agent level. For example
</p>
<div class="smallexample">
<pre class="smallexample">control:
actionsequence = ( shellcommands )
AbortClasses = ( danger_will_robinson )
shellcommands:
"shellcom 1"
"shellcom 2" define=ok elsedefine=danger_will_robinson
</pre></div>
<hr>
<a name="access"></a>
<div class="header">
<p>
Next: <a href="#actionsequence" accesskey="n" rel="next">actionsequence</a>, Previous: <a href="#AbortClasses" accesskey="p" rel="previous">AbortClasses</a>, Up: <a href="#control" accesskey="u" rel="up">control</a> [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Variable-Index" title="Index" rel="index">Index</a>]</p>
</div>
<a name="access-1"></a>
<h4 class="subsection">4.10.2 access</h4>
<a name="index-Access-control"></a>
<a name="index-Restricting-access"></a>
<p>The <code>access</code> list is a list of users who are to be allowed to
execute a cfengine program. If the list does not exist then all users
are allowed to run a program.
</p>
<div class="smallexample">
<pre class="smallexample"> access = ( <var>user1</var> <var>user2</var> ... )
</pre></div>
<p>The list may consist of either numerical user identifiers or valid
usernames from the password database. For example:
</p>
<div class="smallexample">
<pre class="smallexample"> access = ( mark aurora 22 456 )
</pre></div>
<p>would restrict a script to users mark, aurora and user id
22 and 456.
</p>
<hr>
<a name="actionsequence"></a>
<div class="header">
<p>
Next: <a href="#addclasses" accesskey="n" rel="next">addclasses</a>, Previous: <a href="#access" accesskey="p" rel="previous">access</a>, Up: <a href="#control" accesskey="u" rel="up">control</a> [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Variable-Index" title="Index" rel="index">Index</a>]</p>
</div>
<a name="actionsequence-1"></a>
<h4 class="subsection">4.10.3 actionsequence</h4>
<a name="index-action-sequence"></a>
<a name="index-actionsequence-1"></a>
<p>The action sequence determines the order in which collective actions are
carried out. Here is an example containing the full list of
possibilities:
</p>
<div class="smallexample">
<pre class="smallexample"> actionsequence =
(
mountall # mount filesystems in fstab
mountinfo # scan mounted filesystems
checktimezone # check timezone
netconfig # check net interface config
resolve # check resolver setup
unmount # unmount any filesystems
packages # install/upgrade/remove packages
shellcommands # execute shell commands
editfiles # edit files
addmounts # add new filesystems to system
directories # make any directories
links # check and maintain links (single and child)
mailcheck # check mailserver
mountall # (again)
required # check required filesystems
tidy # tidy files
disable # disable files
files # check file permissions
copy # make a copy/image of a master file
processes # signal / check processes
module:name # execute a user-defined module
)
</pre></div>
<a name="index-mountall"></a>
<a name="index-mountinfo"></a>
<a name="index-checktimezone"></a>
<a name="index-netconfig"></a>
<a name="index-childlinks"></a>
<a name="index-singlelinks"></a>
<a name="index-resolve"></a>
<a name="index-unmount"></a>
<a name="index-shellcommands"></a>
<a name="index-editfiles"></a>
<a name="index-addmounts"></a>
<a name="index-directories"></a>
<a name="index-links"></a>
<a name="index-mailcheck"></a>
<a name="index-required"></a>
<a name="index-tidy"></a>
<a name="index-disable"></a>
<a name="index-files"></a>
<a name="index-processes"></a>
<a name="index-packages-1"></a>
<a name="index-module"></a>
<p>Here is a more complete description of the meaning of these
keywords.
</p>
<dl compact="compact">
<dt><code>addmounts</code></dt>
<dd><p>causes cfengine to compute which NFS filesystems are missing from the
current host and add them. This includes editing the filesystem table,
creating the mount-directory, if required. This command relies on
information provided by <code>mountinfo</code>, so it should normally only be
called after <code>mountinfo</code>. If the filesystem already appears
to be in the filesystem table, a warning is issued.
</p>
</dd>
<dt><code>checktimezone</code></dt>
<dd><p>runs a check on the timezone defined for the shell running
cfengine.
</p>
</dd>
<dt><code>directories</code></dt>
<dd><p>executes all the commands defined under the <code>directories</code>
section of the program. It builds new directories.
</p>
</dd>
<dt><code>disable</code></dt>
<dd><p>executes all the commands defined under the <code>disable</code>
section of the program.
</p>
</dd>
<dt><code>editfiles</code></dt>
<dd><p>executes all the commands defined under the <code>editfiles</code>
section of the program.
</p>
</dd>
<dt><code>files</code></dt>
<dd><p>executes all the commands defined under the <code>files</code>
section of the program.
</p>
</dd>
<dt><code>links</code></dt>
<dd><p>executes all the commands defined under the <code>links</code>
section of the program.
</p>
</dd>
<dt><code>mailcheck</code></dt>
<dd><p>tests for the presence of the NFS-mounted mail spooling directory on the
current host. The name of the mail spool directory is defined in the
<code>mailserver</code> section of the cfengine program. If the current host
is the same as the mailserver (the host which has the physical spool
directory disk) nothing is done. Otherwise the filesystem table is
edited so as to include the mail directory.
</p>
</dd>
<dt><code>module</code></dt>
<dd><a name="index-Modules_002c-user-defined"></a>
<p>Normally cfengine’s ability to detect the system’s condition is limited
to what it is able to determine while excuting predefined
actions. Classes may be switched on as a result of actions cfengine
takes to correct a problem. To increase the flexibility of cfengine, a
mechanism has been introduced in version 1.5 which allows you to include
a module of your own making in order to define or undefine a number of classes.
The syntax
</p>
<div class="smallexample">
<pre class="smallexample"> module:mytests
"module:mytests arg1 arg2 .."
</pre></div>
<p>declares a user defined module which can potentially set the classes
<var>class1</var> etc. Classes returned by the module must be declared so
that cfengine knows to pay attention to rules which use these classes
when parsing; this is done using <code>AddInstallable</code>. If
arguments are passed to the module, the whole string must be quoted like
a shellcommand. See <a href="cfengine-Tutorial.html#Writing-plugin-modules">(cfengine-Tutorial)Writing plugin modules</a>. Whether or not these
classes become set or not depends on the behaviour of your module. The
classes continue to apply for all actions which occur after the module’s
execution. The module must be owned by the user executing cfengine or
root (for security reasons), it must be named
<samp>module:<var>module-name</var></samp> and must lie in a special directory,
See <a href="#moduledirectory">moduledirectory</a>.
</p>
</dd>
<dt><code>mountall</code></dt>
<dd><p>mounts all filesystems defined in the hosts filesystem table. This
causes new NFS filesystems added by <code>addmounts</code> and
<code>mailcheck</code> to be actually mounted. This should probably be called
both before <code>mountinfo</code> and after <code>addmounts</code> etc. A short
timeout is placed on this operation to avoid hanging RPC connections
when parsing NFS mounted file systems.
</p>
</dd>
<dt><code>mountinfo</code></dt>
<dd><p>builds internal information about which filesystems are presently
mounted on the current host. Cfengine assumes that required-filesystems
which are not found need to be mounted. A short timeout is
placed on this operation to avoid hanging RPC connections
when parsing NFS mounted file systems. If this times out,
no further mount operations are considered reliable and are
summarily cancelled.
</p>
</dd>
<dt><code>netconfig</code></dt>
<dd><p>checks the netmask, hostname, IP address and broadcast address for the
current host. The correct values for the netmask and broadcast address
are set if there is an error. The defaultroute is matched against the
static routing table and added if no default route exists. This does not
apply to DHCP clients, which set a default route automatically.
<a name="index-DHCP"></a>
</p>
</dd>
<dt><code>required</code></dt>
<dd><p>executes all the commands defined under the <code>required</code>
section of the program. It checks for the absence of
important NFS resources.
</p>
</dd>
<dt><code>resolve</code></dt>
<dd><p>checks and corrects the DNS domain name and the order
of nameservers in the file <samp>/etc/resolv.conf</samp>.
</p>
</dd>
<dt><code>packages</code></dt>
<dd><p>executes commands defined under the <code>packages</code> section
of the program. This will query the system’s package database
for the specified packages, at the specified versions, set
classes based on whether or not those packages exist, and
optionally install, upgrade or remove those packages using a
pre-defined package manager command.
</p>
</dd>
<dt><code>shellcommands</code></dt>
<dd><p>executes all the commands defined under the <code>shellcommands</code>
section of the program.
</p>
</dd>
<dt><code>tidy</code></dt>
<dd><p>executes all the commands defined under the <code>tidy</code>
section of the program.
</p>
</dd>
<dt><code>unmount</code></dt>
<dd><p>executes all the commands defined under the <code>unmount</code>
section of the program. The filesystem table is edited
so as to remove the unwanted filesystems and the unmount
operation is executed.
</p>
</dd>
<dt><code>processes</code></dt>
<dd><p>executes commands defined under the <code>processes</code> section
of the program.
</p>
</dd>
</dl>
<p>Under normal circumstances this coarse ordering is enough to suit most
purposes. In some cases you might want to, say, only perform half the
link operations before mounting filesystems and then, say, perform the
remainder. You can do this (and similar things) by using the idea of
defining and undefining classes. See <a href="cfengine-Tutorial.html#Defining-classes">(cfengine-Tutorial)Defining classes</a>.
</p>
<p>The syntax
</p>
<div class="smallexample">
<pre class="smallexample">
actionsequence =
(
links.firstpass.include
...
links.secondpass
)
</pre></div>
<p>means that cfengine first executes <code>links</code> with the classes
<code>firstpass</code> and <code>include</code> <em>defined</em>. Later it executes
<code>links</code> with <code>secondpass</code> defined. You can use this method of
adding classes to distinguish more finely the flow of control in
programs.
<a name="index-Negating-classes"></a>
</p>
<p>A note about style: if you define and undefine lots of classes to do
what you want to do, you might stop and ask yourself if your
<code>groups</code> are defined as well as they should be. See <a href="#groups">groups</a>.
Programming in cfengine is about doing a lot for only a little
writing. If you find yourself writing a lot, you are probably not going
about things in the right way.
</p>
<hr>
<a name="addclasses"></a>
<div class="header">
<p>
Next: <a href="#addinstallable" accesskey="n" rel="next">addinstallable</a>, Previous: <a href="#actionsequence" accesskey="p" rel="previous">actionsequence</a>, Up: <a href="#control" accesskey="u" rel="up">control</a> [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Variable-Index" title="Index" rel="index">Index</a>]</p>
</div>
<a name="AddClasses"></a>
<h4 class="subsection">4.10.4 AddClasses</h4>
<a name="index-Defining-classes"></a>
<a name="index-Adding-defined-classes"></a>
<a name="index-Classes_002c-adding-and-defining"></a>
<a name="index-AddClasses"></a>
<div class="example">
<pre class="example"> AddClasses = ( <var>list of identifiers</var> )
</pre></div>
<p>The <code>AddClasses</code> directive is used to define a list of class
attributes for the current host. Normally only the hard classes defined
by the system are ‘true’ for a given host. It is convenient though to
be able to define classes of your own to label certain actions, mainly
so that they can later be excluded so as to cut short or filter out
certain actions. This can be done in two ways. See <a href="#actionsequence">actionsequence</a>.
</p>
<p>To define a list of classes for the current session, you write:
</p>
<div class="smallexample">
<pre class="smallexample">AddClasses = ( exclude shortversion )
</pre></div>
<p>This is equivalent to (though more permanent than) defining
classes on the command line with the <code>-D</code> option.
<a name="index-_002dD-option-2"></a>
<a name="index-_002dD-option"></a>
<a name="index-Defining-classes-1"></a>
You can now use these to qualify actions. For example
</p>
<div class="smallexample">
<pre class="smallexample">
any.exclude::
...
</pre></div>
<p>Under normal circumstances <code>exclude</code> is always true — because you
have defined it to be so, but you can <em>undefine</em> it in two ways so
as to prevent the action from being carried out. One way is to undefine
a class on the command line when you invoke cfengine:
<a name="index-_002dN-option-1"></a>
<a name="index-Excluding-classes"></a>
</p>
<div class="example">
<table class="cartouche" border="1"><tr><td>
<pre class="example">host# cfengine -N exclude
</pre></td></tr></table>
</div>
<p>or
</p>
<div class="example">
<table class="cartouche" border="1"><tr><td>
<pre class="example">host# cfengine -N exclude.shortversion
host# cfengine -N a.b.c.d
</pre></td></tr></table>
</div>
<p>These commands run cfengine with the named classes <em>undefined</em>.
That means that actions labelled with these classes are excluded during
that run.
</p>
<p>Another way to restrict classes is to add a list of classes to be
undefined in the actionsequence. See next section.
</p>
<hr>
<a name="addinstallable"></a>
<div class="header">
<p>
Next: <a href="#AllowRedefinitionOf" accesskey="n" rel="next">AllowRedefinitionOf</a>, Previous: <a href="#addclasses" accesskey="p" rel="previous">addclasses</a>, Up: <a href="#control" accesskey="u" rel="up">control</a> [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Variable-Index" title="Index" rel="index">Index</a>]</p>
</div>
<a name="AddInstallable"></a>
<h4 class="subsection">4.10.5 AddInstallable</h4>
<a name="index-Declaring-classes"></a>
<a name="index-Defining-before-use"></a>
<a name="index-AddInstallable"></a>
<div class="example">
<pre class="example"> AddInstallable = ( <var>list of identifiers</var> )
</pre></div>
<p>Some actions in your cfengine program will be labelled by classes which
only become defined at run time using a <code>define=</code> option. Cfengine
is not always able to see these classes until it meets them and tries to
save space by only loading actions for classes which is believes will
become defined at some point in the program. This can lead to some
actions being missed if the action is parsed before the place where the
class gets switched on, since cfengine is a one-pass interpreter,. To
help cfengine determine classes which <em>might become defined</em> during
a run, you can declare them in this list. It does no harm to declare
classes here anyway.
Here is an example where you need to declare a class because of the ordering
of the actions.
</p>
<div class="smallexample">
<pre class="smallexample">
control:
AddInstallable = ( myclass )
files:
myclass::
/tmp/test mode=644 action=fixall
copy:
/tmp/foo dest=/tmp/test define=myclass
</pre></div>
<p>If we remove the declaration, then when cfengine meets the files
command, it skips it because it knows nothing about the class
‘<samp>myclass</samp>’—when the copy command follows, it is too late. Remember
that imported files are always parsed after the main program so definitions
made in imported files always come later than things in the main program.
</p>
<hr>
<a name="AllowRedefinitionOf"></a>
<div class="header">
<p>
Next: <a href="#Auditing" accesskey="n" rel="next">Auditing</a>, Previous: <a href="#addinstallable" accesskey="p" rel="previous">addinstallable</a>, Up: <a href="#control" accesskey="u" rel="up">control</a> [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Variable-Index" title="Index" rel="index">Index</a>]</p>
</div>
<a name="AllowRedefinitionOf-1"></a>
<h4 class="subsection">4.10.6 AllowRedefinitionOf</h4>
<p>Normally cfagent warns about redefinitions of variables during parsing.
This is presumed to be a mistake. To avoid this behaviour, add the name
of the variable to this list, and the warning disappears.
</p>
<div class="smallexample">
<pre class="smallexample">control:
actionsequence = ( copy )
AllowRedefinitionOf = ( cfrep )
cfrep = ( bla )
cfrep = ( blo )
</pre></div>
<a name="index-Redefinition-of-macros"></a>
<hr>
<a name="Auditing"></a>
<div class="header">
<p>
Next: <a href="#AutoDefine" accesskey="n" rel="next">AutoDefine</a>, Previous: <a href="#AllowRedefinitionOf" accesskey="p" rel="previous">AllowRedefinitionOf</a>, Up: <a href="#control" accesskey="u" rel="up">control</a> [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Variable-Index" title="Index" rel="index">Index</a>]</p>
</div>
<a name="Auditing-1"></a>
<h4 class="subsection">4.10.7 Auditing</h4>
<a name="index-Audit-log"></a>
<a name="index-Auditing-1"></a>
<p>If this variable is set to true then cfengine conducts extensive auditing
of its actions to a database in the work directory. When rules are
applied, their locations and policy version are recorded also so that it
is possible to see exactly which rule was applied and when. It is
assumed that the version is recorded as below:
</p><div class="smallexample">
<pre class="smallexample">
control:
cfinputs_version = ( 1.2.1 )
Auditing = true
</pre></div>
<p>This variable acts as the global default behaviour and may be
overriden locally by <code>audit=true/false</code> attributes, where applicable.
</p>
<hr>
<a name="AutoDefine"></a>
<div class="header">
<p>
Next: <a href="#BinaryPaddingChar" accesskey="n" rel="next">BinaryPaddingChar</a>, Previous: <a href="#Auditing" accesskey="p" rel="previous">Auditing</a>, Up: <a href="#control" accesskey="u" rel="up">control</a> [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Variable-Index" title="Index" rel="index">Index</a>]</p>
</div>
<a name="AutoDefine-1"></a>
<h4 class="subsection">4.10.8 AutoDefine</h4>
<p><!-- /@w -->
</p><div class="smallexample">
<pre class="smallexample">
control:
hup_syslogd::
autodefine = ( /etc/syslog.c* )
</pre></div>
<p>Referring to the class that prefixes the command, <code>autodefine</code> is
a list of file patterns that will define the said class, if a named file is copied
in any statement. This helps to avoid having to write a large number
of file-specific copy: lines with define=class configured. In the example
above, the class <code>hup_syslogd</code> would be defined if <samp>/etc/syslog.conf</samp>
is copied at any time.
</p>
<hr>
<a name="BinaryPaddingChar"></a>
<div class="header">
<p>
Next: <a href="#BindToInterface-in-cfagent" accesskey="n" rel="next">BindToInterface in cfagent</a>, Previous: <a href="#AutoDefine" accesskey="p" rel="previous">AutoDefine</a>, Up: <a href="#control" accesskey="u" rel="up">control</a> [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Variable-Index" title="Index" rel="index">Index</a>]</p>
</div>
<a name="BinaryPaddingChar-1"></a>
<h4 class="subsection">4.10.9 BinaryPaddingChar</h4>
<p><!-- /@w -->
</p><div class="smallexample">
<pre class="smallexample">BinaryPaddingChar = ( \0 )
</pre></div>
<p>This specifies the type of character used to pad strings of unequal
length in <code>editfiles</code> during binary editing. The default value is
the space character, since this is normally used to edit filenames
or text messages within program code.
</p>
<hr>
<a name="BindToInterface-in-cfagent"></a>
<div class="header">
<p>
Next: <a href="#ChecksumDatabase-in-cfagent" accesskey="n" rel="next">ChecksumDatabase in cfagent</a>, Previous: <a href="#BinaryPaddingChar" accesskey="p" rel="previous">BinaryPaddingChar</a>, Up: <a href="#control" accesskey="u" rel="up">control</a> [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Variable-Index" title="Index" rel="index">Index</a>]</p>
</div>
<a name="BindToInterface-in-cfagent-1"></a>
<h4 class="subsection">4.10.10 BindToInterface in cfagent</h4>
<p>If this is set to a specific IP address of an IP configured interface,
cfagent will use that address for outgoing connections. On Multi-homed
hosts this allows one to restrict the traffic to a known interface. An interface must
be configured with an IP address in order to be bound.
</p>
<p>This feature is not available for old operating systems.
<a name="index-Multihomed-hosts"></a>
<a name="index-BindToInterface"></a>
<a name="index-Binding-to-one-interface-only"></a>
</p>
<hr>
<a name="ChecksumDatabase-in-cfagent"></a>
<div class="header">
<p>
Next: <a href="#ChecksumPurge" accesskey="n" rel="next">ChecksumPurge</a>, Previous: <a href="#BindToInterface-in-cfagent" accesskey="p" rel="previous">BindToInterface in cfagent</a>, Up: <a href="#control" accesskey="u" rel="up">control</a> [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Variable-Index" title="Index" rel="index">Index</a>]</p>
</div>
<a name="ChecksumDatabase-in-cfagent-1"></a>
<h4 class="subsection">4.10.11 ChecksumDatabase in cfagent</h4>
<p><!-- /@w -->
</p><div class="smallexample">
<pre class="smallexample">ChecksumDatabase = ( /var/cfengine/cfdb )
</pre></div>
<a name="index-ChecksumDatabase"></a>
<a name="index-Message-digests"></a>
<a name="index-Hashes-of-files"></a>
<a name="index-Tripwire-functionality"></a>
<a name="index-ChecksumDatabase-1"></a>
<p>If this filename is defined, cfengine will use it to store
message digests (i.e. cryptographic checksums) of files
for security purposes, See <a href="#files">files</a>, <code>checksum=</code>.
</p>
<p>This option was deprecated in 2.1.22.
</p>
<hr>
<a name="ChecksumPurge"></a>
<div class="header">
<p>
Next: <a href="#ChecksumUpdates" accesskey="n" rel="next">ChecksumUpdates</a>, Previous: <a href="#ChecksumDatabase-in-cfagent" accesskey="p" rel="previous">ChecksumDatabase in cfagent</a>, Up: <a href="#control" accesskey="u" rel="up">control</a> [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Variable-Index" title="Index" rel="index">Index</a>]</p>
</div>
<a name="ChecksumPurge-1"></a>
<h4 class="subsection">4.10.12 ChecksumPurge</h4>
<p><!-- /@w -->
</p><div class="smallexample">
<pre class="smallexample">ChecksumPurge = ( on )
</pre></div>
<a name="index-ChecksumPurge"></a>
<a name="index-ChecksumPurge-1"></a>
<p>This variable defaults to ‘off’. If set to true, cfagent will
look at all of the registered files in the database and check
whether thet still exist. If the file no longer exists, it
is removed from the database and a warning is issued.
</p>
<p>To purge files now and then, but at no particular time, one could do
something like this:
</p>
<div class="smallexample">
<pre class="smallexample">
strategies:
{ purging
NowAndThen: 1
ElseWhen: 49
}
control:
NowAndThen::
ChecksumPurge = ( on )
</pre></div>
<hr>
<a name="ChecksumUpdates"></a>
<div class="header">
<p>
Next: <a href="#CompressCommand" accesskey="n" rel="next">CompressCommand</a>, Previous: <a href="#ChecksumPurge" accesskey="p" rel="previous">ChecksumPurge</a>, Up: <a href="#control" accesskey="u" rel="up">control</a> [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Variable-Index" title="Index" rel="index">Index</a>]</p>
</div>
<a name="ChecksumUpdates-1"></a>
<h4 class="subsection">4.10.13 ChecksumUpdates</h4>
<p><!-- /@w -->
</p><div class="smallexample">
<pre class="smallexample">ChecksumUpdates = ( on )
</pre></div>
<a name="index-ChecksumUpdates"></a>
<a name="index-ChecksumUpdates-1"></a>
<p>This variable defaults to ‘off’. If set to true, cfagent will
automatically update the checksum of a file, if it changes on the disk.
This means that a security warning will be issued only once
about files which have changed, and the changed version will be re-registered
as the correct version. This option could be switched on after a
system upgrade, for instance, in order to update the database, and then
switched to ‘off’ again to reduce the risk of missing a security
alert. Alternatively, if you are confident that the first message is
sufficient, it can be left as ‘on’ so that only one message is
given.
</p>
<hr>
<a name="CompressCommand"></a>
<div class="header">
<p>
Next: <a href="#childlibpath" accesskey="n" rel="next">childlibpath</a>, Previous: <a href="#ChecksumUpdates" accesskey="p" rel="previous">ChecksumUpdates</a>, Up: <a href="#control" accesskey="u" rel="up">control</a> [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Variable-Index" title="Index" rel="index">Index</a>]</p>
</div>
<a name="CompressCommand-1"></a>
<h4 class="subsection">4.10.14 CompressCommand</h4>
<p>Specified the name of a program that is used in the files <code>action=compress</code>
attribute.
</p>
<p><!-- /@w -->
</p><div class="smallexample">
<pre class="smallexample">CompressCommand = ( /usr/bin/gzip )
</pre></div>
<a name="index-CompressCommand"></a>
<a name="index-CompressCommand-1"></a>
<hr>
<a name="childlibpath"></a>
<div class="header">
<p>
Next: <a href="#copylinks" accesskey="n" rel="next">copylinks</a>, Previous: <a href="#CompressCommand" accesskey="p" rel="previous">CompressCommand</a>, Up: <a href="#control" accesskey="u" rel="up">control</a> [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Variable-Index" title="Index" rel="index">Index</a>]</p>
</div>
<a name="ChildLibPath"></a>
<h4 class="subsection">4.10.15 ChildLibPath</h4>
<p>Sets a value for LD_LIBRARY_PATH in child processes:
</p><div class="example">
<pre class="example">
childlibpath = ( /usr/local/lib:/local/mysql/lib )
</pre></div>
<p>Note that the variables LD_LIBRARY_PATH is special. This
library path is needed to run processes as children of cfengine.
Often, if the agent is started from cron (which is started by init),
there is no suitable library path set, and shellcommands will
fail with strange errors about not being able to load shared
objects. Setting a library path here is a useful way of
correcting this problem.
</p>
<hr>
<a name="copylinks"></a>
<div class="header">
<p>
Next: <a href="#defaultcopytype" accesskey="n" rel="next">defaultcopytype</a>, Previous: <a href="#childlibpath" accesskey="p" rel="previous">childlibpath</a>, Up: <a href="#control" accesskey="u" rel="up">control</a> [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Variable-Index" title="Index" rel="index">Index</a>]</p>
</div>
<a name="CopyLinks"></a>
<h4 class="subsection">4.10.16 CopyLinks</h4>
<p>This list is used to define a global list of names or patterns
which are to be copied rather than linked symbolically. For example
</p>
<div class="smallexample">
<pre class="smallexample">CopyLinks = ( *.config )
</pre></div>
<p>The same facility can be specified for each individual
link operation using the <code>copy</code> option See <a href="#links">links</a>.
Copying is performed using a file age comparison.
</p>
<p>Note that all entries defined under a specified class
are valid only as long as that class is defined. For instance
</p>
<div class="smallexample">
<pre class="smallexample"> <var>class</var>::
CopyLinks = ( <var>pattern</var> )
</pre></div>
<p>would define a pattern which was only valid when
<var>class</var> is defined.
</p>
<hr>
<a name="defaultcopytype"></a>
<div class="header">
<p>
Next: <a href="#defaultpkgmgr" accesskey="n" rel="next">defaultpkgmgr</a>, Previous: <a href="#copylinks" accesskey="p" rel="previous">copylinks</a>, Up: <a href="#control" accesskey="u" rel="up">control</a> [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Variable-Index" title="Index" rel="index">Index</a>]</p>
</div>
<a name="DefaultCopyType"></a>
<h4 class="subsection">4.10.17 DefaultCopyType</h4>
<p>This parameter determines the default form of copying for all copy operations
parsed after this variable. The legal values are
<code>ctime</code> (intial default), <code>mtime</code>, <code>checksum</code> and <code>binary</code>.
e.g.
</p>
<div class="smallexample">
<pre class="smallexample">
DefaultCopyType = ( mtime )
</pre></div>
<hr>
<a name="defaultpkgmgr"></a>
<div class="header">
<p>
Next: <a href="#deletenonuserfiles" accesskey="n" rel="next">deletenonuserfiles</a>, Previous: <a href="#defaultcopytype" accesskey="p" rel="previous">defaultcopytype</a>, Up: <a href="#control" accesskey="u" rel="up">control</a> [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Variable-Index" title="Index" rel="index">Index</a>]</p>
</div>
<a name="DefaultPkgMgr"></a>
<h4 class="subsection">4.10.18 DefaultPkgMgr</h4>
<p>Sets the default value of the <code>pkgmgr</code> attribute for
<code>packages</code> items.
</p>
<p><!-- /@w -->
</p><div class="smallexample">
<pre class="smallexample">DefaultPkgMgr = ( rpm )
</pre></div>
<p>By default, this variable is not set, meaning there will be no
package manager selected, and each item in the <code>packages</code>
section must specify its own package manager, or it will not be
checked. For information on the values of this variable, See <a href="#packages">packages</a>.
</p>
<hr>
<a name="deletenonuserfiles"></a>
<div class="header">
<p>
Next: <a href="#deletenonownerfiles" accesskey="n" rel="next">deletenonownerfiles</a>, Previous: <a href="#defaultpkgmgr" accesskey="p" rel="previous">defaultpkgmgr</a>, Up: <a href="#control" accesskey="u" rel="up">control</a> [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Variable-Index" title="Index" rel="index">Index</a>]</p>
</div>
<a name="DeleteNonUserFiles"></a>
<h4 class="subsection">4.10.19 DeleteNonUserFiles</h4>
<p>If this parameter is set to true, cfengine will delete files
which do not have a name belonging to a known user id.
</p>
<div class="smallexample">
<pre class="smallexample">DeleteNonUserFiles = ( true )
SpoolDirectories = ( /var/spool/cron/crontabs )
</pre></div>
<a name="index-DeleteNonUserMail-DeleteNonUserFiles"></a>
<p>This is an generalization of DeleteNonUserMail and makes it redundant.
it is formally executed as a part of the “tidy” action.
</p>
<hr>
<a name="deletenonownerfiles"></a>
<div class="header">
<p>
Next: <a href="#deletenonusermail" accesskey="n" rel="next">deletenonusermail</a>, Previous: <a href="#deletenonuserfiles" accesskey="p" rel="previous">deletenonuserfiles</a>, Up: <a href="#control" accesskey="u" rel="up">control</a> [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Variable-Index" title="Index" rel="index">Index</a>]</p>
</div>
<a name="DeleteNonOwnerFiles"></a>
<h4 class="subsection">4.10.20 DeleteNonOwnerFiles</h4>
<p>If this parameter is set to true, cfengine will delete files on mailservers
whose names do not correspond to a known user name, but might be owned by a
known user.
</p>
<div class="smallexample">
<pre class="smallexample">DeleteNonOwnerFiles = ( true )
SpoolDirectories = ( /var/spool/cron/crontabs )
</pre></div>
<a name="index-DeleteNonOwnerMail"></a>
<a name="index-DeleteNonUserFiles"></a>
<p>This is an generalization of DeleteNonOwnerMail and makes it redundant.
</p>
<hr>
<a name="deletenonusermail"></a>
<div class="header">
<p>
Next: <a href="#deletenonownermail" accesskey="n" rel="next">deletenonownermail</a>, Previous: <a href="#deletenonownerfiles" accesskey="p" rel="previous">deletenonownerfiles</a>, Up: <a href="#control" accesskey="u" rel="up">control</a> [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Variable-Index" title="Index" rel="index">Index</a>]</p>
</div>
<a name="DeleteNonUserMail"></a>
<h4 class="subsection">4.10.21 DeleteNonUserMail</h4>
<p>If this parameter is set to true, cfengine will delete mail files on mailservers
which do not have a name belonging to a known user id. This does not
include lock files.
</p>
<hr>
<a name="deletenonownermail"></a>
<div class="header">
<p>
Next: <a href="#domain" accesskey="n" rel="next">domain</a>, Previous: <a href="#deletenonusermail" accesskey="p" rel="previous">deletenonusermail</a>, Up: <a href="#control" accesskey="u" rel="up">control</a> [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Variable-Index" title="Index" rel="index">Index</a>]</p>
</div>
<a name="DeleteNonOwnerMail"></a>
<h4 class="subsection">4.10.22 DeleteNonOwnerMail</h4>
<p>If this parameter is set to true, cfengine will delete files on mailservers
whose names do not correspond to a known user name, but might be owned by a
known user.
</p>
<hr>
<a name="domain"></a>
<div class="header">
<p>
Next: <a href="#dpkginstallcommand" accesskey="n" rel="next">dpkginstallcommand</a>, Previous: <a href="#deletenonownermail" accesskey="p" rel="previous">deletenonownermail</a>, Up: <a href="#control" accesskey="u" rel="up">control</a> [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Variable-Index" title="Index" rel="index">Index</a>]</p>
</div>
<a name="domain-1"></a>
<h4 class="subsection">4.10.23 domain</h4>
<a name="index-domain"></a>
<a name="index-domain-2"></a>
<div class="example">
<pre class="example"> domain = ( <var>domain name</var> )
</pre></div>
<p>This variable defines the domainname for your site. You must define it
here, because your system might not know its domainname when you run
cfengine for the first time. The domainname can be used as a cfengine
variable subsequently by referring to $(domain). The domainname
variable is used by the action <code>resolve</code>. The domain is also used
implicitly by other matching routines. You should define the domain as
early as possible in your configuration file so as to avoid problems,
especially if you have the strange practice of naming hosts with their
fully qualified host names since groups which use fully qualified names
can fail to be defined if cfengine is not able to figure out the domain name.
</p>
<hr>
<a name="dpkginstallcommand"></a>
<div class="header">
<p>
Next: <a href="#dryrun" accesskey="n" rel="next">dryrun</a>, Previous: <a href="#domain" accesskey="p" rel="previous">domain</a>, Up: <a href="#control" accesskey="u" rel="up">control</a> [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Variable-Index" title="Index" rel="index">Index</a>]</p>
</div>
<a name="DPKGInstallCommand"></a>
<h4 class="subsection">4.10.24 DPKGInstallCommand</h4>
<p>Sets the command used to install packages that need to be installed
under the DPKG package manager.
</p>
<div class="smallexample">
<pre class="smallexample">DPKGInstallCommand = ( "/usr/bin/pkgmgr %s" )
</pre></div>
<p>By default, this variable is not set, meaning that any packages with
action=install will NOT be installed if installation is required. Note
the "’s around the string, and the %s is replaced with the name of the
package to be installed.
</p>
<hr>
<a name="dryrun"></a>
<div class="header">
<p>
Next: <a href="#editbinaryfilesize" accesskey="n" rel="next">editbinaryfilesize</a>, Previous: <a href="#dpkginstallcommand" accesskey="p" rel="previous">dpkginstallcommand</a>, Up: <a href="#control" accesskey="u" rel="up">control</a> [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Variable-Index" title="Index" rel="index">Index</a>]</p>
</div>
<a name="DryRun"></a>
<h4 class="subsection">4.10.25 DryRun</h4>
<a name="index-DryRun"></a>
<a name="index-DryRun-1"></a>
<p><!-- /@w -->
</p><div class="smallexample">
<pre class="smallexample">
DryRun = ( <var>on/</var><b>off</b> )
</pre></div>
<p>This variable has the same effect as the command line options
<kbd>--dry-run</kbd> or <kbd>-n</kbd>. It tells cfengine to only report
what it should do without actually doing it.
</p>
<div class="smallexample">
<pre class="smallexample">
<var>classes</var>::
DryRun = ( on )
</pre></div>
<hr>
<a name="editbinaryfilesize"></a>
<div class="header">
<p>
Next: <a href="#editfilesize" accesskey="n" rel="next">editfilesize</a>, Previous: <a href="#dryrun" accesskey="p" rel="previous">dryrun</a>, Up: <a href="#control" accesskey="u" rel="up">control</a> [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Variable-Index" title="Index" rel="index">Index</a>]</p>
</div>
<a name="editbinaryfilesize-1"></a>
<h4 class="subsection">4.10.26 editbinaryfilesize</h4>
<a name="index-Restricting-the-size-of-binary-files-to-be-edited"></a>
<a name="index-editbinaryfilesize"></a>
<div class="example">
<pre class="example"> EditBinaryFileSize = ( <var>size</var> )
</pre></div>
<p>Cfengine will refuse to edit a file which is larger than the value of
<code>editbinaryfilesize</code> in bytes. This is to prevent possible
accidents from occurring. The default value for this variable is 10000000
bytes. If you don’t like this feature, simply set the value to be a
very large number or to zero. If the value is zero, cfengine will
ignore it.
</p>
<hr>
<a name="editfilesize"></a>
<div class="header">
<p>
Next: <a href="#emptyresolvconf" accesskey="n" rel="next">emptyresolvconf</a>, Previous: <a href="#editbinaryfilesize" accesskey="p" rel="previous">editbinaryfilesize</a>, Up: <a href="#control" accesskey="u" rel="up">control</a> [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Variable-Index" title="Index" rel="index">Index</a>]</p>
</div>
<a name="editfilesize-1"></a>
<h4 class="subsection">4.10.27 editfilesize</h4>
<a name="index-Restricting-the-size-of-files-to-be-edited"></a>
<a name="index-editfilesize-1"></a>
<div class="example">
<pre class="example"> EditfileSize = ( <var>size</var> )
</pre></div>
<p>This variable is used by cfengine every time it becomes necessary to
edit a file. Since file editing applies only to text files, the files
are probably going to be relatively small in most cases. Asking to edit
a very large (perhaps binary) file could therefore be the result of an
error.
</p>
<p>A check is therefore made as a security feature. Cfengine will refuse
to edit a file which is larger than the value of <code>editfilesize</code> in
bytes. This is to prevent possible accidents from occurring. The
default value for this variable is 10000 bytes. If you don’t like this
feature, simply set the value to be a very large number or to zero.
If the value is zero, cfengine will ignore it.
</p>
<hr>
<a name="emptyresolvconf"></a>
<div class="header">
<p>
Next: <a href="#exclamation" accesskey="n" rel="next">exclamation</a>, Previous: <a href="#editfilesize" accesskey="p" rel="previous">editfilesize</a>, Up: <a href="#control" accesskey="u" rel="up">control</a> [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Variable-Index" title="Index" rel="index">Index</a>]</p>
</div>
<a name="EmptyResolvConf"></a>
<h4 class="subsection">4.10.28 EmptyResolvConf</h4>
<a name="index-Emptying-old-nameservers-from-_002fetc_002fresolv_002econf"></a>
<a name="index-EmptyResolvConf"></a>
<div class="example">
<pre class="example"> EmptyResolvConf = ( true )
</pre></div>
<p>Normally cfengine does not tidy up old entries in the <samp>/etc/resolv.conf</samp>
file. This option causes cfengine to remove all existing content from the
file.
</p>
<hr>
<a name="exclamation"></a>
<div class="header">
<p>
Next: <a href="#excludecopy" accesskey="n" rel="next">excludecopy</a>, Previous: <a href="#emptyresolvconf" accesskey="p" rel="previous">emptyresolvconf</a>, Up: <a href="#control" accesskey="u" rel="up">control</a> [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Variable-Index" title="Index" rel="index">Index</a>]</p>
</div>
<a name="Exclamation"></a>
<h4 class="subsection">4.10.29 Exclamation</h4>
<p>This variable defaults to “on”. If set to “off”, no exclamation marks
(Br. pling, Am: shriek) are printed during security alerts, e.g. for
checksum violations.
</p>
<div class="example">
<pre class="example"> Exclamation = ( off )
</pre></div>
<a name="index-Exclamation"></a>
<a name="index-Checksum-warning_002c-turning-off-exclamation"></a>
<a name="index-Exclamation-marks_002c-turning-off"></a>
<hr>
<a name="excludecopy"></a>
<div class="header">
<p>
Next: <a href="#excludelinks" accesskey="n" rel="next">excludelinks</a>, Previous: <a href="#exclamation" accesskey="p" rel="previous">exclamation</a>, Up: <a href="#control" accesskey="u" rel="up">control</a> [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Variable-Index" title="Index" rel="index">Index</a>]</p>
</div>
<a name="ExcludeCopy"></a>
<h4 class="subsection">4.10.30 ExcludeCopy</h4>
<p>This list is used to define a global list of names or patterns
which are to be excluded from copy operations. For example
</p>
<div class="smallexample">
<pre class="smallexample"> ExcludeCopy = ( *~ *% core )
</pre></div>
<p>The same facility can be specified for each individual
link operation using the <code>exclude</code> option See <a href="#copy">copy</a>.
</p>
<p>Note that all entries defined under a specified class
are valid only as long as that class is defined. For instance
</p>
<div class="smallexample">
<pre class="smallexample"> <var>class</var>::
ExcludeCopy = ( <var>pattern</var> )
</pre></div>
<p>would define a pattern which was only valid when
<var>class</var> is defined.
</p>
<hr>
<a name="excludelinks"></a>
<div class="header">
<p>
Next: <a href="#ExpireAfter" accesskey="n" rel="next">ExpireAfter</a>, Previous: <a href="#excludecopy" accesskey="p" rel="previous">excludecopy</a>, Up: <a href="#control" accesskey="u" rel="up">control</a> [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Variable-Index" title="Index" rel="index">Index</a>]</p>
</div>
<a name="ExcludeLink"></a>
<h4 class="subsection">4.10.31 ExcludeLink</h4>
<p>This list is used to define a global list of names or patterns
which are to be excluded from linking operations. For example
</p>
<div class="smallexample">
<pre class="smallexample"> ExcludeLink = ( *~ *% core )
</pre></div>
<p>The same facility can be specified for each individual
link operation using the <code>exclude</code> option See <a href="#links">links</a>.
</p>
<p>Note that all entries defined under a specified class
are valid only as long as that class is defined. For instance
</p>
<div class="smallexample">
<pre class="smallexample"> <var>class</var>::
ExcludeLink = ( <var>pattern</var> )
</pre></div>
<p>would define a pattern which was only valid when
<var>class</var> is defined.
</p>
<hr>
<a name="ExpireAfter"></a>
<div class="header">
<p>
Next: <a href="#FreeBSDInstallCommand" accesskey="n" rel="next">FreeBSDInstallCommand</a>, Previous: <a href="#excludelinks" accesskey="p" rel="previous">excludelinks</a>, Up: <a href="#control" accesskey="u" rel="up">control</a> [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Variable-Index" title="Index" rel="index">Index</a>]</p>
</div>
<a name="ExpireAfter-1"></a>
<h4 class="subsection">4.10.32 ExpireAfter</h4>
<p>If you change the value of this parameter, it should be one of the
first things you do in your configuration script.
</p>
<p>This parameter controls the global value of the ExpireAfter parameter.
See <a href="cfengine-Tutorial.html#Spamming-and-security">(cfengine-Tutorial)Spamming and
security</a>. This parameter controls the maximum time
in minutes which a cfengine action is allowed to live. After this time
a second cfengine agent will try to kill the cfengine which seems to
have hung and attempt to restart the action. This is different from a TimeOut,
where an internal alarm interrupt is used.
</p>
<table class="cartouche" border="1"><tr><td>
<p><!-- /@w -->
</p><div class="smallexample">
<pre class="smallexample">
ExpireAfter = ( <var>time-in-minutes</var> )
</pre></div>
</td></tr></table>
<p>This parameter may also be set per action in the action
sequence by appending a pseudo-class called <code>ExpireAfter<var>time</var></code>.
For instance,
</p>
<div class="smallexample">
<pre class="smallexample">
actionsequence = ( copy.ExpireAfter15 )
</pre></div>
<p>sets the expiry time parameter to 15 minutes for this copy command.
This method should be considered old and deprecated however.
As of version 2.1.0, you can define the expiry time on a per-command basis,
as options of the form <code>expireafter=10</code>.
</p>
<hr>
<a name="FreeBSDInstallCommand"></a>
<div class="header">
<p>
Next: <a href="#FreeBSDRemoveCommand" accesskey="n" rel="next">FreeBSDRemoveCommand</a>, Previous: <a href="#ExpireAfter" accesskey="p" rel="previous">ExpireAfter</a>, Up: <a href="#control" accesskey="u" rel="up">control</a> [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Variable-Index" title="Index" rel="index">Index</a>]</p>
</div>
<a name="FreeBSDInstallCommand-1"></a>
<h4 class="subsection">4.10.33 FreeBSDInstallCommand</h4>
<p>Sets the path to ‘pkg_add’ which is used to install packages that need
to be installed under FreeBSD.
</p>
<div class="smallexample">
<pre class="smallexample">
FreeBSDInstallCommand = ( "/usr/sbin/pkg_add -r %s" )
</pre></div>
<p>By default, this variable is not set, meaning that any packages with
action=install will NOT be installed. Note the quotes around the string,
and the <code>%s</code> is replaced with the name of the package to be installed.
</p>
<hr>
<a name="FreeBSDRemoveCommand"></a>
<div class="header">
<p>
Next: <a href="#FullEncryption" accesskey="n" rel="next">FullEncryption</a>, Previous: <a href="#FreeBSDInstallCommand" accesskey="p" rel="previous">FreeBSDInstallCommand</a>, Up: <a href="#control" accesskey="u" rel="up">control</a> [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Variable-Index" title="Index" rel="index">Index</a>]</p>
</div>
<a name="FreeBSDRemoveCommand-1"></a>
<h4 class="subsection">4.10.34 FreeBSDRemoveCommand</h4>
<p>Sets the path to ‘pkg_delete’ which is used to remove packages that need
to be uninstalled under FreeBSD.
</p>
<div class="smallexample">
<pre class="smallexample">
FreeBSDRemoveCommand = ( "/usr/sbin/pkg_delete %s" )
</pre></div>
<p>By default, this variable is set to /usr/sbin/pkg_delete, meaning that any
packages with action=remove will be removed. Note the quotes around the
string, and the <code>%s</code> is replaced with the name of the package to be installed.
</p>
<hr>
<a name="FullEncryption"></a>
<div class="header">
<p>
Next: <a href="#homepattern" accesskey="n" rel="next">homepattern</a>, Previous: <a href="#FreeBSDRemoveCommand" accesskey="p" rel="previous">FreeBSDRemoveCommand</a>, Up: <a href="#control" accesskey="u" rel="up">control</a> [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Variable-Index" title="Index" rel="index">Index</a>]</p>
</div>
<a name="FullEncryption-1"></a>
<h4 class="subsection">4.10.35 FullEncryption</h4>
<p>From version 2.1.22. This is false for protocol compatability with older
servers.
</p>
<p>If this is set to true, directory filenames are encrypted in addition
to file contents. If transferred data are not especially secret or
travel over public networks this is a waste of CPU time. In high
security environments it provides full privacy of data transmission.
</p>
<table class="cartouche" border="1"><tr><td>
<p><!-- /@w -->
</p><div class="smallexample">
<pre class="smallexample">
FullEncryption = ( true )
</pre></div>
</td></tr></table>
<hr>
<a name="homepattern"></a>
<div class="header">
<p>
Next: <a href="#HostnameKeys-in-cfagent" accesskey="n" rel="next">HostnameKeys in cfagent</a>, Previous: <a href="#FullEncryption" accesskey="p" rel="previous">FullEncryption</a>, Up: <a href="#control" accesskey="u" rel="up">control</a> [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Variable-Index" title="Index" rel="index">Index</a>]</p>
</div>
<a name="HomePattern"></a>
<h4 class="subsection">4.10.36 HomePattern</h4>
<a name="index-Home-path"></a>
<a name="index-Path-to-home-directories"></a>
<a name="index-HomePattern"></a>
<div class="example">
<pre class="example"> HomePattern = ( <var>list of patterns</var> )
</pre></div>
<p>The <code>homepattern</code> variable is used by the cfengine model for
mounting nfs filesystems. See <a href="cfengine-Tutorial.html#NFS-resources">(cfengine-Tutorial)NFS
resources</a>. It is also used in the evaluation of the
pseudo variable <code>home</code>, See <a href="#files">files</a>, <a href="#tidy">tidy</a>.
</p>
<p><code>homepattern</code> is in fact a list and is used like a wildcard or
<em>pattern</em> to determine which filesystems in the list of mountables
are home directories. See <a href="#mountables">mountables</a>. This relies on your sticking
to a rigid naming convention as described in the first reference above.
</p>
<p>For example, you might wish to mount (or locate directly if you are not
using a separate partition for home directories) your home directories
under <code>mountpattern</code> in directories <code>u1</code>, <code>u2</code> and so on.
In this case you would define <code>homepattern</code> to match these numbers:
</p>
<a name="index-Wildcards-in-homepattern"></a>
<a name="index-Searching-for-home-directories"></a>
<p><!-- /@w -->
</p><div class="smallexample">
<pre class="smallexample">homepattern = ( u? )
</pre></div>
<p>Cfengine now regards any directory matching
<code>$(mountpattern)/u?</code> as being a user login directory.
</p>
<p>Suppose you want to create mount home directories under
<code>$(mountpattern)/home</code> and make subdirectories for staff and
students. Then you would be tempted to write:
</p>
<div class="smallexample">
<pre class="smallexample"> HomePattern = ( home/staff home/students )
</pre></div>
<p>Unfortunately this is not presently possible. (This is, in principle,
a bug which should be fixed in the future.) What you can do instead is
to achieve the same this as follows:
</p>
<div class="smallexample">
<pre class="smallexample"> MountPattern = ( /$(site)/$(host) /$(site)/$(host)/home )
HomePattern = ( staff students )
</pre></div>
<hr>
<a name="HostnameKeys-in-cfagent"></a>
<div class="header">
<p>
Next: <a href="#IfElapsed-in-cfagent" accesskey="n" rel="next">IfElapsed in cfagent</a>, Previous: <a href="#homepattern" accesskey="p" rel="previous">homepattern</a>, Up: <a href="#control" accesskey="u" rel="up">control</a> [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Variable-Index" title="Index" rel="index">Index</a>]</p>
</div>
<a name="HostnameKeys-in-cfagent-1"></a>
<h4 class="subsection">4.10.37 HostnameKeys in cfagent</h4>
<p>If this variable is set to true/on, it causes cfagent to
lookup and store trusted public keys according to their
DNS fully qualified host name, instead of using the IP address.
This can be useful in environments where hosts do not have fixed
IP addresses, but do have fixed hostnames.
</p>
<div class="smallexample">
<pre class="smallexample">
HostnameKeys = ( on )
</pre></div>
<p>This method of storing keys is not recommended for sites with
fixed IP addresses, since it removes one security barrier
from a potential attacker by potentially allowing DNS spoofing.
</p>
<p>Note that there is a corresponding variable to be set in <samp>cfrun.hosts</samp>
which must be set for consistency.
</p>
<hr>
<a name="IfElapsed-in-cfagent"></a>
<div class="header">
<p>
Next: <a href="#IgnoreFriendRegex" accesskey="n" rel="next">IgnoreFriendRegex</a>, Previous: <a href="#HostnameKeys-in-cfagent" accesskey="p" rel="previous">HostnameKeys in cfagent</a>, Up: <a href="#control" accesskey="u" rel="up">control</a> [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Variable-Index" title="Index" rel="index">Index</a>]</p>
</div>
<a name="IfElapsed-in-cfagent-1"></a>
<h4 class="subsection">4.10.38 IfElapsed in cfagent</h4>
<p>If you change the value of this parameter, it should be one of the
first things you do in your configuration script.
</p>
<p>This parameter controls the global value of the IfElapsed parameter,
See <a href="cfengine-Tutorial.html#Spamming-and-security">(cfengine-Tutorial)Spamming and
security</a>. This parameter controls the minimum time
which must have elapsed for an action in the action sequence before
which it will be executed again.
</p>
<table class="cartouche" border="1"><tr><td>
<p><!-- /@w -->
</p><div class="smallexample">
<pre class="smallexample">
IfElapsed = ( <var>time-in-minutes</var> )
</pre></div>
</td></tr></table>
<p>This parameter may also be set per action in the action
sequence by appending a pseudo-class called <code>IfElapsed<var>time</var></code>.
For instance,
</p>
<div class="smallexample">
<pre class="smallexample">
ActionSequence = ( copy.IfElapsed15 )
</pre></div>
<p>sets the elapsed time parameter to 15 minutes for this copy command.
This method should be considered old and deprecated however.
As of version 2.1.0, you can define the expiry time on a per-command basis,
as options of the form <code>ifelapsed=15</code>.
</p>
<hr>
<a name="IgnoreFriendRegex"></a>
<div class="header">
<p>
Next: <a href="#IgnoreInterfaceRegex" accesskey="n" rel="next">IgnoreInterfaceRegex</a>, Previous: <a href="#IfElapsed-in-cfagent" accesskey="p" rel="previous">IfElapsed in cfagent</a>, Up: <a href="#control" accesskey="u" rel="up">control</a> [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Variable-Index" title="Index" rel="index">Index</a>]</p>
</div>
<a name="FriendIgnoreRegex"></a>
<h4 class="subsection">4.10.39 FriendIgnoreRegex</h4>
<p>Use this regular expression to suppress FriendStatus warnings
for matching hosts. e.g.
</p><div class="smallexample">
<pre class="smallexample">
IgnoreFriendRegex = ( "2001:700:.*|host1|host2" )
</pre></div>
<hr>
<a name="IgnoreInterfaceRegex"></a>
<div class="header">
<p>
Next: <a href="#Inform" accesskey="n" rel="next">Inform</a>, Previous: <a href="#IgnoreFriendRegex" accesskey="p" rel="previous">IgnoreFriendRegex</a>, Up: <a href="#control" accesskey="u" rel="up">control</a> [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Variable-Index" title="Index" rel="index">Index</a>]</p>
</div>
<a name="IgnoreInterfaceRegex-1"></a>
<h4 class="subsection">4.10.40 IgnoreInterfaceRegex</h4>
<p>Use this regular expression to delete class information
about interfaces that you do not want to see on a host.
This is useful for tamig virtual machines and their multitudinous interfaces.
</p>
<div class="smallexample">
<pre class="smallexample">
IgnoreInterfaceRegex = ( "vm.*" )
</pre></div>
<a name="index-Virtual-interfaces"></a>
<a name="index-Interface-classes"></a>
<a name="index-IgnoreInterfaceRegex"></a>
<hr>
<a name="Inform"></a>
<div class="header">
<p>
Next: <a href="#interfacename" accesskey="n" rel="next">interfacename</a>, Previous: <a href="#IgnoreInterfaceRegex" accesskey="p" rel="previous">IgnoreInterfaceRegex</a>, Up: <a href="#control" accesskey="u" rel="up">control</a> [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Variable-Index" title="Index" rel="index">Index</a>]</p>
</div>
<a name="Inform-1"></a>
<h4 class="subsection">4.10.41 Inform</h4>
<p><!-- /@w -->
</p><div class="smallexample">
<pre class="smallexample">
Inform = ( <var>on/</var><b>off</b> )
</pre></div>
<p>This variable switches on the output level whereby cfengine
reports changes it makes during a run. Normally only
urgent messages or clear errors are printed. Setting
<code>Inform</code> to <code>on</code> makes cfengine report on
all actions not explicitly cancelled with a ‘silent’ option.
To set this output level one writes:
</p>
<div class="smallexample">
<pre class="smallexample">
<var>classes</var>::
Inform = ( on )
</pre></div>
<hr>
<a name="interfacename"></a>
<div class="header">
<p>
Next: <a href="#fileextension" accesskey="n" rel="next">fileextension</a>, Previous: <a href="#Inform" accesskey="p" rel="previous">Inform</a>, Up: <a href="#control" accesskey="u" rel="up">control</a> [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Variable-Index" title="Index" rel="index">Index</a>]</p>
</div>
<a name="InterfaceName"></a>
<h4 class="subsection">4.10.42 InterfaceName</h4>
<a name="index-InterfaceName"></a>
<a name="index-InterfaceName-1"></a>
<a name="index-Interface-name_002c-redefining-by-class"></a>
<p>If you have an operating system which is installed on some
non-standard hardware, you might have to specifically set the
name of the network interface. For example:
</p>
<div class="smallexample">
<pre class="smallexample">
control:
nextstep.some::
InterfaceName = ( en0 )
nextstep.others::
InterfaceName = ( ec0 )
</pre></div>
<p>It is only necessary to set the interface name in this fashion
if you have an operating system which is running on special
hardware. Most users will not need this.
The choice set here overrides the system defaults and the
choices made in the <samp>cfrc</samp> file, See <a href="#cfrc-resource-file">cfrc resource file</a>.
</p>
<hr>
<a name="fileextension"></a>
<div class="header">
<p>
Next: <a href="#lastseen" accesskey="n" rel="next">lastseen</a>, Previous: <a href="#interfacename" accesskey="p" rel="previous">interfacename</a>, Up: <a href="#control" accesskey="u" rel="up">control</a> [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Variable-Index" title="Index" rel="index">Index</a>]</p>
</div>
<a name="FileExtensions"></a>
<h4 class="subsection">4.10.43 FileExtensions</h4>
<p>This list may be used to define a number of extensions
which are regarded as being plain files by the system.
As part of the general security checking cfengine will
warn about any directories which have names using
these extensions. They may be used to conceal directories.
</p>
<div class="smallexample">
<pre class="smallexample">
FileExtensions = ( c o gif jpg html )
</pre></div>
<a name="index-FileExtensions"></a>
<a name="index-Directories_002c-hidden"></a>
<hr>
<a name="lastseen"></a>
<div class="header">
<p>
Next: <a href="#lastseenexpireafter" accesskey="n" rel="next">lastseenexpireafter</a>, Previous: <a href="#fileextension" accesskey="p" rel="previous">fileextension</a>, Up: <a href="#control" accesskey="u" rel="up">control</a> [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Variable-Index" title="Index" rel="index">Index</a>]</p>
</div>
<a name="LastSeen"></a>
<h4 class="subsection">4.10.44 LastSeen</h4>
<p>This option is true by default. If set to off or false it prevents cfengine
and/or cfservd from learning about last times hosts were observed
connecting to one another. Some users with broken resolvers (particularly
in view of the change over to IPv6 compatible libraries) might find this
useful when processes appear to hang on connecting.
<a name="index-Broken-resolver"></a>
<a name="index-LastSeen"></a>
<a name="index-Hanging-processes"></a>
</p>
<p><!-- /@w -->
</p><div class="smallexample">
<pre class="smallexample">
LastSeen = ( off )
</pre></div>
<a name="index-LastSeen-1"></a>
<hr>
<a name="lastseenexpireafter"></a>
<div class="header">
<p>
Next: <a href="#linkcopies" accesskey="n" rel="next">linkcopies</a>, Previous: <a href="#lastseen" accesskey="p" rel="previous">lastseen</a>, Up: <a href="#control" accesskey="u" rel="up">control</a> [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Variable-Index" title="Index" rel="index">Index</a>]</p>
</div>
<a name="LastSeenExpireAfter"></a>
<h4 class="subsection">4.10.45 LastSeenExpireAfter</h4>
<p>This value (in days) sets the time after which unseen friend hosts
are purged from the ‘last seen’ database, as viewed by the <code>FriendStatus</code>
function, See <a href="#alerts">alerts</a>.
</p>
<div class="smallexample">
<pre class="smallexample">
LastSeenExpireAfter = ( 2 )
</pre></div>
<a name="index-LastSeenExpireAfter"></a>
<a name="index-Last-Seen-database-1"></a>
<hr>
<a name="linkcopies"></a>
<div class="header">
<p>
Next: <a href="#LogDirectory" accesskey="n" rel="next">LogDirectory</a>, Previous: <a href="#lastseenexpireafter" accesskey="p" rel="previous">lastseenexpireafter</a>, Up: <a href="#control" accesskey="u" rel="up">control</a> [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Variable-Index" title="Index" rel="index">Index</a>]</p>
</div>
<a name="LinkCopies"></a>
<h4 class="subsection">4.10.46 LinkCopies</h4>
<p>This list is used to define a global list of names or patterns
which are to be linked symbolically rather than copied. For example
</p>
<div class="smallexample">
<pre class="smallexample">excludelinks = ( *.gif *.jpg )
</pre></div>
<p>The same facility can be specified for each individual
link operation using the <code>symlink</code> option See <a href="#copy">copy</a>.
</p>
<p>Note that all entries defined under a specified class
are valid only as long as that class is defined. For instance
</p>
<div class="smallexample">
<pre class="smallexample"> <var>class</var>::
LinkCopies = ( <var>pattern</var> )
</pre></div>
<p>would define a pattern which was only valid when
<var>class</var> is defined.
</p>
<hr>
<a name="LogDirectory"></a>
<div class="header">
<p>
Next: <a href="#LogTidyHomeFiles" accesskey="n" rel="next">LogTidyHomeFiles</a>, Previous: <a href="#linkcopies" accesskey="p" rel="previous">linkcopies</a>, Up: <a href="#control" accesskey="u" rel="up">control</a> [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Variable-Index" title="Index" rel="index">Index</a>]</p>
</div>
<a name="LogDirectory-1"></a>
<h4 class="subsection">4.10.47 LogDirectory</h4>
<p>This is now deprecated.
</p>
<p>Specify an alternative directory for keeping cfengine’s
log data. This defaults to <samp>/var/run/cfengine</samp> or
<samp>/var/cfengine</samp>.
</p>
<p><!-- /@w -->
</p><div class="smallexample">
<pre class="smallexample">
LogDirectory = ( /var/cfengine )
</pre></div>
<hr>
<a name="LogTidyHomeFiles"></a>
<div class="header">
<p>
Next: <a href="#moduledirectory" accesskey="n" rel="next">moduledirectory</a>, Previous: <a href="#LogDirectory" accesskey="p" rel="previous">LogDirectory</a>, Up: <a href="#control" accesskey="u" rel="up">control</a> [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Variable-Index" title="Index" rel="index">Index</a>]</p>
</div>
<a name="LogTidyHomeFiles-1"></a>
<h4 class="subsection">4.10.48 LogTidyHomeFiles</h4>
<p><!-- /@w -->
</p><div class="smallexample">
<pre class="smallexample">
LogTidyHomeFiles = ( off )
</pre></div>
<p>If set to “off”, no log is made of user files, in their
home directories, of the files which are tidied by cfengine.
</p>
<a name="index-Tidy-log-files-for-users"></a>
<hr>
<a name="moduledirectory"></a>
<div class="header">
<p>
Next: <a href="#mountpattern" accesskey="n" rel="next">mountpattern</a>, Previous: <a href="#LogTidyHomeFiles" accesskey="p" rel="previous">LogTidyHomeFiles</a>, Up: <a href="#control" accesskey="u" rel="up">control</a> [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Variable-Index" title="Index" rel="index">Index</a>]</p>
</div>
<a name="moduledirectory-1"></a>
<h4 class="subsection">4.10.49 moduledirectory</h4>
<a name="index-Module-directory-1"></a>
<a name="index-Directory-for-cfengine-modules"></a>
<a name="index-moduledirectory"></a>
<div class="example">
<pre class="example"> moduledirectory = ( <var>directory for plugin modules</var> )
</pre></div>
<p>This is the directory where cfengine will look for plug-in modules
for the actionsequence, See <a href="#actionsequence">actionsequence</a>. Plugin modules
may be used to activate classes using special algorithms.
See <a href="cfengine-Tutorial.html#Writing-plugin-modules">(cfengine-Tutorial)Writing plugin modules</a>.
This variable defaults to <samp>/var/cfengine/modules</samp> for privileged users and
to <samp>$HOME)/.cfengine/modules</samp> for non-privileged users.
</p>
<hr>
<a name="mountpattern"></a>
<div class="header">
<p>
Next: <a href="#netmask" accesskey="n" rel="next">netmask</a>, Previous: <a href="#moduledirectory" accesskey="p" rel="previous">moduledirectory</a>, Up: <a href="#control" accesskey="u" rel="up">control</a> [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Variable-Index" title="Index" rel="index">Index</a>]</p>
</div>
<a name="mountpattern-1"></a>
<h4 class="subsection">4.10.50 mountpattern</h4>
<a name="index-Mount-paths"></a>
<a name="index-Path-to-mounted-filesystems"></a>
<a name="index-mountpattern"></a>
<div class="example">
<pre class="example"> mountpattern = ( <var>mount-point</var> )
</pre></div>
<p>The <code>mountpattern</code> list is used by the cfengine model for mounting
nfs filesystems. See <a href="cfengine-Tutorial.html#NFS-resources">(cfengine-Tutorial)NFS
resources</a>. It is also used in the evaluation of the
pseudo variable <code>home</code>, See <a href="#files">files</a>, <a href="#tidy">tidy</a>.
</p>
<p>It is used together with the value of <code>homepattern</code> to locate and
identify what filesystems are local to a given host and which are
mounted over the network. For this list to make sense you need to
stick to a rigid convention for mounting your filesystems under a single
naming scheme as described in the section mentioned above. If you
follow the recommended naming scheme then you will want to set the value
of mountpattern to
</p>
<div class="smallexample">
<pre class="smallexample">mountpattern = ( /$(site)/$(host) )
</pre></div>
<p>which implies that cfengine will look for local disk partitions under a
unique directory given by the name of the host and site. Any
filesystems which are physically located on the current host lie in this
directory. All mounted filesystems should lie elsewhere. If you
insist on keeping mounted file systems in more than one location, you
can make a list like this:
</p>
<div class="smallexample">
<pre class="smallexample">mountpattern = ( /$(site)/users /$(site)/projects )
</pre></div>
<hr>
<a name="netmask"></a>
<div class="header">
<p>
Next: <a href="#nonalphanumfiles" accesskey="n" rel="next">nonalphanumfiles</a>, Previous: <a href="#mountpattern" accesskey="p" rel="previous">mountpattern</a>, Up: <a href="#control" accesskey="u" rel="up">control</a> [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Variable-Index" title="Index" rel="index">Index</a>]</p>
</div>
<a name="netmask-1"></a>
<h4 class="subsection">4.10.51 netmask</h4>
<a name="index-netmask"></a>
<a name="index-netmask-2"></a>
<div class="example">
<pre class="example"> netmask = ( <var>aaa.bbb.ccc.ddd</var> )
</pre></div>
<p>The netmask variable defines the partitioning of the subnet addresses on
your network. Its value is defined by your network administrator. On
most systems it is likely to be <code>255.255.255.0</code>. This is used to
configure the network interface in <code>netconfig</code>.
See <a href="#actionsequence">actionsequence</a>.
</p>
<a name="index-Domain-name"></a>
<a name="index-IP-address"></a>
<a name="index-Internet-address"></a>
<a name="index-Netmask"></a>
<a name="index-Subnet-mask"></a>
<p>Every host on the internet has its own unique address. The addresses
are assigned hierarchically. Each network gets a <em>domain name</em> and
can attach something like 65,000 hosts to that network. Since this is
usually too many to handle in one go, every such network may be divided
up into subnets. The administrator of the network can decide how the
division into subnets is made. The decision is a trade-off between
having many subnets with few hosts, or many hosts on few subnets. This
choice is made by setting the value of a variable called <code>netmask</code>.
The netmask looks like an internet address. It takes the form:
</p>
<div class="example">
<pre class="example">
aaa.bbb.ccc.mmm
</pre></div>
<p>The first two numbers ‘<samp>aaa.bbb</samp>’ are the address of the domain. The
remainder ‘<samp>ccc.mmm</samp>’ specifies both the subnet and the hostname.
The value of <code>netmask</code> tells all hosts on the network: how many of
the bits in the second half label different subnets and how many label
different hosts on each of the subnets?
</p>
<p>The most common value for the netmask is ‘<samp>255.255.255.0</samp>’. It is
most helpful to think of the netmask in terms of bits. Each base-10
number between 0-255 represents 8 bits which are either set or not set.
Every bit which is set is a network address and every bit which is zero
is part of a host address. The first two parts of the address
‘<samp>255.255</samp>’ always takes these values. If the third number is
‘<samp>255</samp>’, it means that the domain is divided up into 256 sub networks
and then the remaining bits which are zero can be used to give 255
different host addresses on each of the subnets.
</p>
<p>If the value had been ‘<samp>255.255.255.254</samp>’, the network would be
divided up into <em>2^15</em> subnets, since fifteen of the sixteen bits
are one. The remaining bit leaves enough room for two addresses 0 and
1. One of those is reserved for <em>broadcasts</em> to all hosts, the
other can be an actual host — there would only be room for one host
per subnet. This is a stupid example of course, the main point with the
subnet mask is that it can be used to trade subnets for hosts per
subnet. A value of ‘<samp>255.255.254.0</samp>’ would allow 128 different
subnets with <em>2*256-1 = 511</em> hosts on each.
</p>
<p>We needn’t be concerned with the details of the netmask here. Suffice
it to say that its value is determined for your entire domain by the
network administrator and each host has to be told what the value is.
</p>
<p>Each host must also know what convention is used for the <em>broadcast
address</em>. This is an address which hosts can send to if they wish to
send a message to every other host on their subnet simultaneously. It is
used a lot by services like NIS to ask if any hosts are willing to
perform a particular service. There are two main conventions for the
broadcast address: address zero (all host bits are zero) and the highest
address on the subnet (all host bits are ones). The convention can be
different on every subnet and it is decided by the network
administrator. When you write a cfengine program you just specify the
convention used on your subnet and cfengine works out the value of the
broadcast address from the netmask and the host address
See <a href="#broadcast">broadcast</a>. Cfengine works out the value of the broadcast address
using the value of the netmask.
</p>
<hr>
<a name="nonalphanumfiles"></a>
<div class="header">
<p>
Next: <a href="#nfstype" accesskey="n" rel="next">nfstype</a>, Previous: <a href="#netmask" accesskey="p" rel="previous">netmask</a>, Up: <a href="#control" accesskey="u" rel="up">control</a> [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Variable-Index" title="Index" rel="index">Index</a>]</p>
</div>
<a name="NonAlphaNumFiles"></a>
<h4 class="subsection">4.10.52 NonAlphaNumFiles</h4>
<p>If enabled, this option causes cfengine to detect and
disable files which have purely non-alphanumeric
filenames, i.e. files which might be accidental or
deliberately concealed. The files are then marked
with a suffix <code>.cf-nonalpha</code> and are rendered
visible.
</p>
<div class="smallexample">
<pre class="smallexample">
NonAlphaNumFiles = ( on )
</pre></div>
<p>These files can then be tidied by searching for
the suffix. Note that alphanumeric means
ascii codes less than 32 and greater than 126.
</p>
<hr>
<a name="nfstype"></a>
<div class="header">
<p>
Next: <a href="#PortageInstallCommand" accesskey="n" rel="next">PortageInstallCommand</a>, Previous: <a href="#nonalphanumfiles" accesskey="p" rel="previous">nonalphanumfiles</a>, Up: <a href="#control" accesskey="u" rel="up">control</a> [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Variable-Index" title="Index" rel="index">Index</a>]</p>
</div>
<a name="nfstype-1"></a>
<h4 class="subsection">4.10.53 nfstype</h4>
<a name="index-nfs"></a>
<a name="index-nfstype"></a>
<a name="index-nfstype-2"></a>
<div class="example">
<pre class="example"> nfstype = ( <var>nfs-type</var> )
</pre></div>
<p>This variable is included only for future expansion. If you do not
define this variable, its value defaults to “nfs”.
</p>
<p>At present cfengine operates only with NFS (the network file system).
When cfengine looks for network file systems to mount, it adds lines in
the filesystem table (‘<samp>/etc/fstab</samp>’,‘<samp>/etc/checklist</samp>’ etc.) to
try to mount filesystems of type “nfs”. In principle you might want
to use a completely different system for mounting filesystems over the
network, in which case the ‘mount type’ would not be “nfs” but
something else.
</p>
<p>At the time of writing certain institutions are replacing NFS with AFS
(the Andrew filesystem) and DFS (from the distributed computing
environment). The use of these filesystems really excludes the need to
use the mount protocol at all. In other words if you are using AFS or
DFS, you don’t need to use cfengine’s mounting commands at all.
<a name="index-AFS"></a>
<a name="index-Andrew-filesystem"></a>
<a name="index-DFS"></a>
</p>
<hr>
<a name="PortageInstallCommand"></a>
<div class="header">
<p>
Next: <a href="#repchar" accesskey="n" rel="next">repchar</a>, Previous: <a href="#nfstype" accesskey="p" rel="previous">nfstype</a>, Up: <a href="#control" accesskey="u" rel="up">control</a> [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Variable-Index" title="Index" rel="index">Index</a>]</p>
</div>
<a name="PortageInstallCommand-1"></a>
<h4 class="subsection">4.10.54 PortageInstallCommand</h4>
<p>Sets the path to ‘emerge’ which is used to install packages that need
to be installed under Gentoo Portage.
</p>
<div class="smallexample">
<pre class="smallexample">
gentoo.some::
DefaultPkgMgr = ( portage )
PortageInstallCommand = ( "/usr/bin/emerge --nocolor %s" )
gentoo.other::
DefaultPkgMgr = ( portage )
PortageInstallCommand = ( "/usr/lib/portage/bin/emerge --color=n %s"
</pre></div>
<p>By default, this variable is not set, meaning that any packages with
action=install will NOT be installed if installation is required. Note
the quotes around the string, and the <code>%s</code> is replaced with the name
of the package to be installed.
</p>
<hr>
<a name="repchar"></a>
<div class="header">
<p>
Next: <a href="#repository" accesskey="n" rel="next">repository</a>, Previous: <a href="#PortageInstallCommand" accesskey="p" rel="previous">PortageInstallCommand</a>, Up: <a href="#control" accesskey="u" rel="up">control</a> [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Variable-Index" title="Index" rel="index">Index</a>]</p>
</div>
<a name="RepChar"></a>
<h4 class="subsection">4.10.55 RepChar</h4>
<div class="example">
<pre class="example"> RepChar = ( <var>character</var> )
</pre></div>
<p>The value of this variable determines the characters which is used by
cfengine in creating the unique filenames in the file
repository. Normally, its value is set to ‘<samp>_</samp>’ and each ‘<samp>/</samp>’ in
the path name of the file is changed to ‘<samp>_</samp>’ and stored in the
repository. If you prefer a different character, define it here. Note
that the character can be quoted with either single or double quotes in
order to encompass spaces etc.
<a name="index-RepChar"></a>
<a name="index-Repository-filenames_002c-changing"></a>
<a name="index-Changing-repository-name-conventions"></a>
</p>
<hr>
<a name="repository"></a>
<div class="header">
<p>
Next: <a href="#RPMcommand" accesskey="n" rel="next">RPMcommand</a>, Previous: <a href="#repchar" accesskey="p" rel="previous">repchar</a>, Up: <a href="#control" accesskey="u" rel="up">control</a> [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Variable-Index" title="Index" rel="index">Index</a>]</p>
</div>
<a name="Repository-1"></a>
<h4 class="subsection">4.10.56 Repository</h4>
<div class="example">
<pre class="example"> Repository = ( <var>directory</var> )
</pre></div>
<p>Defines a special directory where all backup and junk
files are collected. Files are assigned a unique filename
which identifies the path from which they originate.
This affects files saved using <code>disable</code>, <code>copy</code>,
<code>links</code> and <code>editfiles</code> See <a href="cfengine-Tutorial.html#Disabling-and-the-file-repository">(cfengine-Tutorial)Disabling and the file repository</a>.
</p>
<hr>
<a name="RPMcommand"></a>
<div class="header">
<p>
Next: <a href="#rpminstallcommand" accesskey="n" rel="next">rpminstallcommand</a>, Previous: <a href="#repository" accesskey="p" rel="previous">repository</a>, Up: <a href="#control" accesskey="u" rel="up">control</a> [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Variable-Index" title="Index" rel="index">Index</a>]</p>
</div>
<a name="RPMcommand-1"></a>
<h4 class="subsection">4.10.57 RPMcommand</h4>
<p>The default value of the Red Hat Package manager command <samp>/bin/rpm</samp> can be altered
for non-standard systems with this variable.
</p><div class="example">
<pre class="example">RPMcommand = ( /usr/bin/rpm )
</pre></div>
<hr>
<a name="rpminstallcommand"></a>
<div class="header">
<p>
Next: <a href="#schedule" accesskey="n" rel="next">schedule</a>, Previous: <a href="#RPMcommand" accesskey="p" rel="previous">RPMcommand</a>, Up: <a href="#control" accesskey="u" rel="up">control</a> [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Variable-Index" title="Index" rel="index">Index</a>]</p>
</div>
<a name="RPMInstallCommand"></a>
<h4 class="subsection">4.10.58 RPMInstallCommand</h4>
<p>Sets the command used to install packages that need to be installed
under the RPM package manager.
</p>
<div class="smallexample">
<pre class="smallexample">RPMInstallCommand = ( "/usr/bin/pkgmgr %s" )
</pre></div>
<p>By default, this variable is not set, meaning that any packages with
action=install will NOT be installed if installation is required. Note
the quotes around the string, and the <code>%s</code> is replaced with the name
of the package to be installed.
</p>
<div class="smallexample">
<pre class="smallexample">control:
DefaultPkgMgr = ( rpm )
RPMInstallCommand = ( "/usr/bin/yum -d 0 -e 0 -y install %s" )
# This would remove all dependencies (!)
#
# RPMRemoveCommand = ( "/usr/bin/yum -d 0 -e 0 -y remove %s" )
# This might be less drastic
RPMRemoveCommand = ( "/bin/rpm -e --nodeps %s" )
packages:
# this will remove this package regardless of version.
some_rpm_name version=0:0.0 cmp=ge action=remove
</pre></div>
<hr>
<a name="schedule"></a>
<div class="header">
<p>
Next: <a href="#secureinput" accesskey="n" rel="next">secureinput</a>, Previous: <a href="#rpminstallcommand" accesskey="p" rel="previous">rpminstallcommand</a>, Up: <a href="#control" accesskey="u" rel="up">control</a> [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Variable-Index" title="Index" rel="index">Index</a>]</p>
</div>
<a name="Schedule"></a>
<h4 class="subsection">4.10.59 Schedule</h4>
<a name="index-scheduling"></a>
<a name="index-scheduling-1"></a>
<div class="example">
<pre class="example"> schedule = ( Min00_05 Min30_35 <var>time class</var> )
</pre></div>
<p>When <code>cfexecd</code> is used in daemon mode, it defaults to running
once an hour, on the hour, i.e..
</p><div class="example">
<pre class="example"> schedule = ( Min00_05 )
</pre></div>
<p>This can be extended to make the agent run more often. The time
specifiers are cfengine classes, and are written as intervals of time
rather the precise times. Cfengine’s time resolution is purposely
limited to five minutes because the auto-correlation time of user
resources is generally greater than this. Thus, it is assumed that
precision timing is not required and the start time of cfengine, when
scheduled in daemon mode, is not better than a few minutes. The daemon
does not require precision, but offers many other strategic
features for load balancing and security.
</p>
<p>Other time classes can be used in the schedule list, but note
that cfexecd will not run the agent more than once every five minutes.
This is treated as a fundamental granularity.
</p>
<hr>
<a name="secureinput"></a>
<div class="header">
<p>
Next: <a href="#sensiblecount" accesskey="n" rel="next">sensiblecount</a>, Previous: <a href="#schedule" accesskey="p" rel="previous">schedule</a>, Up: <a href="#control" accesskey="u" rel="up">control</a> [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Variable-Index" title="Index" rel="index">Index</a>]</p>
</div>
<a name="SecureInput"></a>
<h4 class="subsection">4.10.60 SecureInput</h4>
<a name="index-Secure-input"></a>
<a name="index-SecureInput"></a>
<div class="example">
<pre class="example"> SecureInput = ( on )
</pre></div>
<p>If this is set cfengine will not import
files which are not owned by the uid running the program, or
which are writable by groups or others.
</p>
<hr>
<a name="sensiblecount"></a>
<div class="header">
<p>
Next: <a href="#sensiblesize" accesskey="n" rel="next">sensiblesize</a>, Previous: <a href="#secureinput" accesskey="p" rel="previous">secureinput</a>, Up: <a href="#control" accesskey="u" rel="up">control</a> [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Variable-Index" title="Index" rel="index">Index</a>]</p>
</div>
<a name="SensibleCount"></a>
<h4 class="subsection">4.10.61 SensibleCount</h4>
<a name="index-Sensible-limits-on-files-in-a-directory"></a>
<a name="index-SensibleCount"></a>
<div class="example">
<pre class="example"> SensibleCount = ( <var>count</var> )
</pre></div>
<p>This variable is used by the action <code>required</code>. It defines for
cfengine what you consider to be the minimum number of files in a
‘required’ directory. If you declare a directory as being required,
cfengine will check to see if it exists. Then, if the directory
contains fewer than the value of <code>sensiblecount</code> files, a warning
is issued. The default value for this variable is 2.
</p>
<hr>
<a name="sensiblesize"></a>
<div class="header">
<p>
Next: <a href="#showactions" accesskey="n" rel="next">showactions</a>, Previous: <a href="#sensiblecount" accesskey="p" rel="previous">sensiblecount</a>, Up: <a href="#control" accesskey="u" rel="up">control</a> [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Variable-Index" title="Index" rel="index">Index</a>]</p>
</div>
<a name="SensibleSize"></a>
<h4 class="subsection">4.10.62 SensibleSize</h4>
<a name="index-Sensible-file-sizes"></a>
<a name="index-SensibleSize"></a>
<div class="example">
<pre class="example"> SensibleSize = ( <var>size</var> )
</pre></div>
<p>This variable is used by the action <code>required</code>. It defines for
cfengine what you consider to be the minimum size for a ‘required’ file.
If you declare a file as being required, cfengine will check to see if
the file exists. Of course, the file may exist but be empty, so the
size of the file is also checked against this constant. If the file is
smaller than the value of <code>sensiblesize</code> a warning is issued. The
default value for this variable is 1000 bytes.
</p>
<hr>
<a name="showactions"></a>
<div class="header">
<p>
Next: <a href="#singlecopy" accesskey="n" rel="next">singlecopy</a>, Previous: <a href="#sensiblesize" accesskey="p" rel="previous">sensiblesize</a>, Up: <a href="#control" accesskey="u" rel="up">control</a> [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Variable-Index" title="Index" rel="index">Index</a>]</p>
</div>
<a name="ShowActions"></a>
<h4 class="subsection">4.10.63 ShowActions</h4>
<a name="index-ShowActions"></a>
<div class="example">
<pre class="example"> ShowActions = ( <var>on</var> )
</pre></div>
<p>This causes cfengine to produce detailed output of what action is
being carried out as part of the prefix information during output.
This is intended only for third party tools which collect and parse
the cfengine output. It will be of little interest to humans.
</p>
<hr>
<a name="singlecopy"></a>
<div class="header">
<p>
Next: <a href="#site" accesskey="n" rel="next">site</a>, Previous: <a href="#showactions" accesskey="p" rel="previous">showactions</a>, Up: <a href="#control" accesskey="u" rel="up">control</a> [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Variable-Index" title="Index" rel="index">Index</a>]</p>
</div>
<a name="SingleCopy"></a>
<h4 class="subsection">4.10.64 SingleCopy</h4>
<div class="smallexample">
<pre class="smallexample">
singlecopy = ( path_and_filename_wildcard )
</pre></div>
<p>If a <code>singlecopy</code> pattern is defined the behavior of copy: is
modified so that a given destination file, matching the pattern, will
only be updated once. In other words, if someone tries to copy more
then one source file to the same location, the destination will not be
overwritten in the same run. If the path name and wildcard is any of ’*’,
’on’ or ’true’, then the list applies to all files.
For example:
</p>
<div class="smallexample">
<pre class="smallexample">control:
actionsequence = ( copy )
singlecopy = ( /tmp/* )
addinstallables = ( zzz )
zzz::
autodefine = ( /tmp/* )
copy:
/etc/passwd dest=/tmp/destination type=binary
/etc/group dest=/tmp/destination type=binary
alerts:
zzz::
"Copied something in /tmp"
</pre></div>
<p>Note (Warning) that this feature has several problems. It assumes an order
dependence that cfengine generally tries to avoid. The first copy that
takes place wins. Also, if files are locked at different times, this
can result in oscillations between several different source files.
e.g.
</p>
<div class="smallexample">
<pre class="smallexample">
copy:
/etc/passwd dest=/tmp/bla type=binary ifelapsed=2
/etc/group dest=/tmp/bla type=binary ifelapsed=1
</pre></div>
<p>In order to avoid explicit looping, cfengine assumes that a file has
been copied even if no actual copy took place – i.e. as long as a
file is apparently up to date, that counts as a valid copy update and the
promise/action is considered done. If this were not the case, then the
following promises would still be in line for execution and cfengine
would loop between the different versions on subsequent invocations.
</p>
<hr>
<a name="site"></a>
<div class="header">
<p>
Next: <a href="#SkipIdentify" accesskey="n" rel="next">SkipIdentify</a>, Previous: <a href="#singlecopy" accesskey="p" rel="previous">singlecopy</a>, Up: <a href="#control" accesskey="u" rel="up">control</a> [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Variable-Index" title="Index" rel="index">Index</a>]</p>
</div>
<a name="site_002ffaculty"></a>
<h4 class="subsection">4.10.65 site/faculty</h4>
<a name="index-site"></a>
<a name="index-site-2"></a>
<div class="example">
<pre class="example"> site = ( <var>sitename</var> )
faculty = ( <var>facultyname</var> )
</pre></div>
<p>This variable defines a convenient name for your site configuration. It
is useful for making generic rules later on, because it means for
instance that you can define the name of a directory to be
</p>
<div class="smallexample">
<pre class="smallexample">/$(site)/$(host)/local
</pre></div>
<p>without having to redefine the rule for a specific site. This is a
handy trick for making generic rules in your files which can be imported
into a configuration for any site.
</p>
<p><code>faculty</code> is a synonym for <code>site</code>. The two names
may be used interchangeably.
</p>
<hr>
<a name="SkipIdentify"></a>
<div class="header">
<p>
Next: <a href="#Smtpserver" accesskey="n" rel="next">Smtpserver</a>, Previous: <a href="#site" accesskey="p" rel="previous">site</a>, Up: <a href="#control" accesskey="u" rel="up">control</a> [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Variable-Index" title="Index" rel="index">Index</a>]</p>
</div>
<a name="SkipIdentify-1"></a>
<h4 class="subsection">4.10.66 SkipIdentify</h4>
<div class="example">
<pre class="example"> SkipIdentify = ( true )
</pre></div>
<p>This is the client side directive corresponding to the server
directive <code>SkipVerify</code>. It tells cfengine not to assume that
the client is registered in the Domain Name Service (DNS). Sometimes
the assumption of DNS registration can break connectivity between hosts,
particularly if firewalls or Network Address Translation is in use.
</p>
<a name="index-SkipIdentify"></a>
<a name="index-Network-Address-Translation"></a>
<hr>
<a name="Smtpserver"></a>
<div class="header">
<p>
Next: <a href="#SplayTime" accesskey="n" rel="next">SplayTime</a>, Previous: <a href="#SkipIdentify" accesskey="p" rel="previous">SkipIdentify</a>, Up: <a href="#control" accesskey="u" rel="up">control</a> [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Variable-Index" title="Index" rel="index">Index</a>]</p>
</div>
<a name="smtpserver"></a>
<h4 class="subsection">4.10.67 smtpserver</h4>
<div class="example">
<pre class="example"> smtpserver = ( <var>mailhost</var> )
</pre></div>
<p>This variable specified the destination for Email sent by cfexecd.
<a name="index-Mailhost"></a>
<a name="index-smtpserver"></a>
</p>
<hr>
<a name="SplayTime"></a>
<div class="header">
<p>
Next: <a href="#split" accesskey="n" rel="next">split</a>, Previous: <a href="#Smtpserver" accesskey="p" rel="previous">Smtpserver</a>, Up: <a href="#control" accesskey="u" rel="up">control</a> [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Variable-Index" title="Index" rel="index">Index</a>]</p>
</div>
<a name="SplayTime-1"></a>
<h4 class="subsection">4.10.68 SplayTime</h4>
<div class="example">
<pre class="example"> SplayTime = ( <var>time-in-minutes</var> )
</pre></div>
<p>This variable is used to set the maximum time over
which cfengine will share its load on a server,
See <a href="cfengine-Tutorial.html#Splaying-host-times">(cfengine-Tutorial)Splaying host times</a>.
</p>
<hr>
<a name="split"></a>
<div class="header">
<p>
Next: <a href="#spooldirectories" accesskey="n" rel="next">spooldirectories</a>, Previous: <a href="#SplayTime" accesskey="p" rel="previous">SplayTime</a>, Up: <a href="#control" accesskey="u" rel="up">control</a> [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Variable-Index" title="Index" rel="index">Index</a>]</p>
</div>
<a name="Split"></a>
<h4 class="subsection">4.10.69 Split</h4>
<div class="example">
<pre class="example"> Split = ( <var>character</var> )
</pre></div>
<p>The value of this variable is used to define the list separator in
variables which are expected to be treated as lists. The default value
of this variable is the colon ‘<samp>:</samp>’. Cfengine treats variables
containing this character as lists to be broken up and iterated over,
See <a href="#Iteration-over-lists">Iteration over lists</a>.
</p>
<p>This typically allows communication with PATH-like
environment variables in the shell.
<a name="index-split-1"></a>
<a name="index-Iteration-over-lists-1"></a>
<a name="index-Iterating-over-lists-1"></a>
<a name="index-split-4"></a>
</p>
<hr>
<a name="spooldirectories"></a>
<div class="header">
<p>
Next: <a href="#suninstallcommand" accesskey="n" rel="next">suninstallcommand</a>, Previous: <a href="#split" accesskey="p" rel="previous">split</a>, Up: <a href="#control" accesskey="u" rel="up">control</a> [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Variable-Index" title="Index" rel="index">Index</a>]</p>
</div>
<a name="SpoolDirectories"></a>
<h4 class="subsection">4.10.70 SpoolDirectories</h4>
<a name="index-SpoolDirectories"></a>
<a name="index-SpoolDirectories-1"></a>
<p>A list of additional spool directories for cfengine to police. In these
directories, filenames should correspond to existing users of the
system. When users lost their accounts, this list plus the mail spool
directory will be checked for files owned by deprecated users.
See also: <code>DeleteNonOwnerFiles</code>, <code>DeleteNonUserFiles</code>.
</p>
<div class="example">
<pre class="example"> SpoolDirectories = ( /var/spool/cron/crontabs /var/spool/cron/atjobs )
</pre></div>
<hr>
<a name="suninstallcommand"></a>
<div class="header">
<p>
Next: <a href="#suspiciousnames" accesskey="n" rel="next">suspiciousnames</a>, Previous: <a href="#spooldirectories" accesskey="p" rel="previous">spooldirectories</a>, Up: <a href="#control" accesskey="u" rel="up">control</a> [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Variable-Index" title="Index" rel="index">Index</a>]</p>
</div>
<a name="SUNInstallCommand"></a>
<h4 class="subsection">4.10.71 SUNInstallCommand</h4>
<p>Sets the command used to install packages that need to be installed
under the SUN package manager.
</p>
<div class="smallexample">
<pre class="smallexample">SUNInstallCommand = ( "/usr/bin/pkgmgr %s" )
</pre></div>
<p>By default, this variable is not set, meaning that any packages with
action=install will NOT be installed if installation is required. Note
the quotes around the string, and the <code>%s</code> is replaced with the name
of the package to be installed.
</p>
<hr>
<a name="suspiciousnames"></a>
<div class="header">
<p>
Next: <a href="#sysadm" accesskey="n" rel="next">sysadm</a>, Previous: <a href="#suninstallcommand" accesskey="p" rel="previous">suninstallcommand</a>, Up: <a href="#control" accesskey="u" rel="up">control</a> [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Variable-Index" title="Index" rel="index">Index</a>]</p>
</div>
<a name="suspiciousnames-1"></a>
<h4 class="subsection">4.10.72 suspiciousnames</h4>
<a name="index-suspiciousnames"></a>
<a name="index-SuspiciousNames"></a>
<div class="example">
<pre class="example"> SuspiciousNames = ( .mo lrk3 )
</pre></div>
<p>Filenames in this list are treated as suspicious and generate a warning
as cfengine scans directories. This might be used to detect hacked systems
or concealed programs. Checks are only made in directories which cfengine
scans in connection with a command such as files, tidy or copy.
</p>
<hr>
<a name="sysadm"></a>
<div class="header">
<p>
Next: <a href="#Syslog" accesskey="n" rel="next">Syslog</a>, Previous: <a href="#suspiciousnames" accesskey="p" rel="previous">suspiciousnames</a>, Up: <a href="#control" accesskey="u" rel="up">control</a> [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Variable-Index" title="Index" rel="index">Index</a>]</p>
</div>
<a name="sysadm-1"></a>
<h4 class="subsection">4.10.73 sysadm</h4>
<a name="index-sysadm"></a>
<a name="index-sysadm-2"></a>
<div class="example">
<pre class="example"> sysadm = ( <var>mail address</var> )
</pre></div>
<p>The mail address of your system administrator should be placed here.
This is used in two instances. If cfengine is invoked with the option
<code>-a</code>, then it simply prints out this value. This is a handy
feature for making scripts.
</p>
<p>The administrators mail address is also written into the personal log
files which cfengine creates for each user after tidying files, so you
should make this an address which users can mail if they have troubles.
</p>
<hr>
<a name="Syslog"></a>
<div class="header">
<p>
Next: <a href="#SyslogFacility" accesskey="n" rel="next">SyslogFacility</a>, Previous: <a href="#sysadm" accesskey="p" rel="previous">sysadm</a>, Up: <a href="#control" accesskey="u" rel="up">control</a> [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Variable-Index" title="Index" rel="index">Index</a>]</p>
</div>
<a name="Syslog-1"></a>
<h4 class="subsection">4.10.74 Syslog</h4>
<p><!-- /@w -->
</p><div class="smallexample">
<pre class="smallexample">
Syslog = ( <var>on/</var><b>off</b> )
</pre></div>
<p>This variable activates syslog logging of cfengine output at
the ‘inform’ level.
</p>
<p>To set this output level one writes:
</p>
<div class="smallexample">
<pre class="smallexample">
<var>classes</var>::
Syslog = ( on )
</pre></div>
<hr>
<a name="SyslogFacility"></a>
<div class="header">
<p>
Next: <a href="#timezone" accesskey="n" rel="next">timezone</a>, Previous: <a href="#Syslog" accesskey="p" rel="previous">Syslog</a>, Up: <a href="#control" accesskey="u" rel="up">control</a> [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Variable-Index" title="Index" rel="index">Index</a>]</p>
</div>
<a name="SyslogFacility-1"></a>
<h4 class="subsection">4.10.75 SyslogFacility</h4>
<p><!-- /@w -->
</p><div class="smallexample">
<pre class="smallexample">
SyslogFacility = ( <var>facility</var> )
</pre></div>
<p>This variable alters the syslog facility level.
e.g.
</p>
<div class="smallexample">
<pre class="smallexample">
SyslogFacility = ( LOG_LOCAL1 )
</pre></div>
<p>Valid arguments are
</p>
<div class="smallexample">
<pre class="smallexample">LOG_USER
LOG_DAEMON
LOG_LOCAL0
LOG_LOCAL1
LOG_LOCAL2
LOG_LOCAL3
LOG_LOCAL4
</pre></div>
<hr>
<a name="timezone"></a>
<div class="header">
<p>
Next: <a href="#TimeOut" accesskey="n" rel="next">TimeOut</a>, Previous: <a href="#SyslogFacility" accesskey="p" rel="previous">SyslogFacility</a>, Up: <a href="#control" accesskey="u" rel="up">control</a> [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Variable-Index" title="Index" rel="index">Index</a>]</p>
</div>
<a name="timezone-1"></a>
<h4 class="subsection">4.10.76 timezone</h4>
<div class="example">
<pre class="example"> timezone = ( <var>3-character timezone</var> )
</pre></div>
<p>The timezone variable is a list of character strings which define your local
timezone. Normally you will only need a single timezone, but sometimes
there are several aliases for a given timezone e.g. MET and CET are synonymous.
Currently only the first three characters of this string are
checked against the timezone which cfengine manages to glean from the
system. If a mismatch is detected a warning message is printed.
cfengine does not attempt to configure the timezone. This feature works
only as a reminder, since the timezone should really be set once and for
all at the time the system is installed. On some systems you can set
the timezone by editing a file, a procedure which you can automate with
cfengine See <a href="#editfiles">editfiles</a>.
</p>
<p>The value of the <code>timezone</code> can be accessed by variable substitution
in the usual way. It expands to the first item in your list.
</p>
<div class="smallexample">
<pre class="smallexample">shellcommands:
"echo ${timezone} | mail ${sysadm}"
</pre></div>
<hr>
<a name="TimeOut"></a>
<div class="header">
<p>
Next: <a href="#Verbose" accesskey="n" rel="next">Verbose</a>, Previous: <a href="#timezone" accesskey="p" rel="previous">timezone</a>, Up: <a href="#control" accesskey="u" rel="up">control</a> [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Variable-Index" title="Index" rel="index">Index</a>]</p>
</div>
<a name="TimeOut-1"></a>
<h4 class="subsection">4.10.77 TimeOut</h4>
<p><!-- /@w -->
</p><div class="smallexample">
<pre class="smallexample">
TimeOut = ( 10 )
</pre></div>
<p>The default timeout for network connections is 10 seconds. This
is too short on some routed networks. It is not permitted to set
this variable smaller than 3 seconds or larger than 60 seconds.
A timeout is generated by an ‘alarm’ interrupt within an executing
agent. This is constrasted with ExpireAfter, in which a second agent
is required to interrupt the activity.
</p>
<hr>
<a name="Verbose"></a>
<div class="header">
<p>
Next: <a href="#Warnings" accesskey="n" rel="next">Warnings</a>, Previous: <a href="#TimeOut" accesskey="p" rel="previous">TimeOut</a>, Up: <a href="#control" accesskey="u" rel="up">control</a> [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Variable-Index" title="Index" rel="index">Index</a>]</p>
</div>
<a name="Verbose-1"></a>
<h4 class="subsection">4.10.78 Verbose</h4>
<p><!-- /@w -->
</p><div class="smallexample">
<pre class="smallexample">
Verbose = ( <var>on/</var><b>off</b> )
</pre></div>
<p>This variable switches on the output level whereby cfengine
reports everything it does during a run in great detail. Normally only
urgent messages or clear errors are printed, See <a href="#Inform">Inform</a>.
This option is almost equivalent to using the <kbd>--verbose</kbd> of <kbd>-v</kbd>
command-line options. The only difference is that system environment reporting
information, which is printed prior to parsing, is not shown.
To set this output level on selected hosts one writes:
</p>
<div class="smallexample">
<pre class="smallexample">
<var>classes</var>::
Verbose = ( on )
</pre></div>
<p>For related more limited output, See <a href="#Inform">Inform</a>.
</p>
<hr>
<a name="Warnings"></a>
<div class="header">
<p>
Next: <a href="#warnnonuserfiles" accesskey="n" rel="next">warnnonuserfiles</a>, Previous: <a href="#Verbose" accesskey="p" rel="previous">Verbose</a>, Up: <a href="#control" accesskey="u" rel="up">control</a> [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Variable-Index" title="Index" rel="index">Index</a>]</p>
</div>
<a name="Warnings-1"></a>
<h4 class="subsection">4.10.79 Warnings</h4>
<p><!-- /@w -->
</p><div class="smallexample">
<pre class="smallexample">
Warnings = ( <var>on/</var><b>off</b> )
</pre></div>
<p>This variable switches on the parser-output level whereby cfengine
reports non-fatal warnings. This is equivalent to setting the command
line switch <kbd>--no-warn</kbd>, or <kbd>-w</kbd>. To set this output level on
selected hosts one writes:
</p>
<div class="smallexample">
<pre class="smallexample">
<var>classes</var>::
Warnings = ( on )
</pre></div>
<hr>
<a name="warnnonuserfiles"></a>
<div class="header">
<p>
Next: <a href="#warnnonownerfiles" accesskey="n" rel="next">warnnonownerfiles</a>, Previous: <a href="#Warnings" accesskey="p" rel="previous">Warnings</a>, Up: <a href="#control" accesskey="u" rel="up">control</a> [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Variable-Index" title="Index" rel="index">Index</a>]</p>
</div>
<a name="WarnNonUserFiles"></a>
<h4 class="subsection">4.10.80 WarnNonUserFiles</h4>
<p>If this parameter is set to true, cfengine will warn about files in
spool directories which do not have a name belonging to a known user id.
</p>
<p>See also <code>DeleteNonUserFiles</code>.
</p>
<hr>
<a name="warnnonownerfiles"></a>
<div class="header">
<p>
Next: <a href="#warnnonusermail" accesskey="n" rel="next">warnnonusermail</a>, Previous: <a href="#warnnonuserfiles" accesskey="p" rel="previous">warnnonuserfiles</a>, Up: <a href="#control" accesskey="u" rel="up">control</a> [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Variable-Index" title="Index" rel="index">Index</a>]</p>
</div>
<a name="WarnNonOwnerFiles"></a>
<h4 class="subsection">4.10.81 WarnNonOwnerFiles</h4>
<p>If this parameter is set to true, cfengine will warn about files on
mailservers whose names do not correspond to a known user name, but
might be owned by a known user.
</p>
<div class="smallexample">
<pre class="smallexample">
SpoolDirectories = ( /var/spool/cron/crontabs )
WarnNonOwnerFiles = ( true )
</pre></div>
<p>See also <code>DeleteNonOwnerFiles</code>. This generalizes and succeeds <code>DeleteNonOwnerMail</code>.
</p>
<hr>
<a name="warnnonusermail"></a>
<div class="header">
<p>
Next: <a href="#warnnonownermail" accesskey="n" rel="next">warnnonownermail</a>, Previous: <a href="#warnnonownerfiles" accesskey="p" rel="previous">warnnonownerfiles</a>, Up: <a href="#control" accesskey="u" rel="up">control</a> [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Variable-Index" title="Index" rel="index">Index</a>]</p>
</div>
<a name="WarnNonUserMail"></a>
<h4 class="subsection">4.10.82 WarnNonUserMail</h4>
<p>If this parameter is set to true, cfengine will warn about mail files on
mailservers which do not have a name belonging to a known user id. This
does not include lock files.
</p>
<hr>
<a name="warnnonownermail"></a>
<div class="header">
<p>
Previous: <a href="#warnnonusermail" accesskey="p" rel="previous">warnnonusermail</a>, Up: <a href="#control" accesskey="u" rel="up">control</a> [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Variable-Index" title="Index" rel="index">Index</a>]</p>
</div>
<a name="WarnNonOwnerMail"></a>
<h4 class="subsection">4.10.83 WarnNonOwnerMail</h4>
<p>If this parameter is set to true, cfengine will warn about files on
mailservers whose names do not correspond to a known user name, but
might be owned by a known user.
</p>
<hr>
<a name="classes"></a>
<div class="header">
<p>
Next: <a href="#copy" accesskey="n" rel="next">copy</a>, Previous: <a href="#control" accesskey="p" rel="previous">control</a>, Up: <a href="#Cfagent-reference" accesskey="u" rel="up">Cfagent reference</a> [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Variable-Index" title="Index" rel="index">Index</a>]</p>
</div>
<a name="classes-1"></a>
<h3 class="section">4.11 classes</h3>
<a name="index-classes-1"></a>
<a name="index-Defining-classes-2"></a>
<a name="index-groups"></a>
<p>The <code>classes</code> keyword is an alias for <code>groups</code> as of
version 1.4.0 of cfengine.
</p>
<hr>
<a name="copy"></a>
<div class="header">
<p>
Next: <a href="#defaultroute" accesskey="n" rel="next">defaultroute</a>, Previous: <a href="#classes" accesskey="p" rel="previous">classes</a>, Up: <a href="#Cfagent-reference" accesskey="u" rel="up">Cfagent reference</a> [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Variable-Index" title="Index" rel="index">Index</a>]</p>
</div>
<a name="copy-1"></a>
<h3 class="section">4.12 copy</h3>
<a name="index-copy"></a>
<a name="index-Copying-files"></a>
<a name="index-File-images-_0028copy_0029"></a>
<p>Cfengine copies files between locally mounted filesystems and via the
network from registered servers. The copy algorithm avoids
race-conditions which can occur due to network and system latencies by
copying first to a file called <samp><var>file</var>.cfnew</samp> on the local
filesystem, and then renaming this quickly into place. The aim of this
roundabout procedure is to avoid situations where the direct rewriting
of a file is interrupted midway, leaving a partially written file to be
read by other processes. Cfengine attempts to preserve hard links to
non-directory file-objects, but see the caution below.
<a name="index-_002ecfnew-files"></a>
</p>
<p><em>Caution should be exercised in copying files which change rapidly in size.
This can lead to file corruption, if the size changes during copying. Cfengine
attempts to prevent this during remote copies.</em>
</p>
<p>The syntax summary is:
</p>
<table class="cartouche" border="1"><tr><td>
<p><!-- /@w -->
</p><div class="smallexample">
<pre class="smallexample">
copy:
<var>class</var>::
<var>master-file</var>
dest=<var>destination-file</var>
mode=<var>mode</var>
owner=<var>owner</var>
group=<var>group</var>
action=<var>warn/silent/fix</var>
backup=<b>true</b><var>/false/timestamp</var>
repository=<var>backup directory</var>
stealth=<var>true/on/<b>false/off</b></var>
checkroot=<var>true/on/<b>false/off</b></var>
timestamps=<b>preserve/keep</b>
symlink=<var>pattern</var>
include=<var>pattern</var>
exclude=<var>pattern</var>
ignore=<var>pattern</var>
filter=<var>filteralias</var>
xdev=<var>true/on</var>/<b>false/off</b>
recurse=<var>number/inf/</var><var>0</var>
type=<b>ctime</b><var>/mtime/checksum/sum/byte/binary/any</var>
linktype=<b>absolute/symbolic</b><var>/relative/hard/none/copy</var>
typecheck=<b>true/on</b>/<var>false/off</var>
define=<var>class-list</var>(,:.)
elsedefine=<var>class-list</var>(,:.)
force=<var>true/on</var>/<b>false/off</b>
forcedirs=<var>true/on</var>/<b>false/off</b>
forceipv4=<var>true/on</var>/<b>false/off</b>
size=<var>size limits</var>
server=<var>server-host</var>
failover=<var>classes</var>
trustkey=<var>true</var>/<b>false</b>
secure=[deprecated]
encrypt=<var>true</var>/<b>false</b>
verify=<var>true</var>/<b>false</b>
oldserver=<var>true</var>/<b>false</b>
purge=<var>true/</var><b>false</b>
syslog=<var>true/on</var>/<var>false/off</var>
inform=<var>true/on</var>/<var>false/off</var>
audit=<var>true/false</var>
findertype=<var>MacOSX finder type</var>
</pre></div>
</td></tr></table>
<p>Note that the <code>$(this)</code> contains the name of the server
used. This variable may be used in the source and destination strings
in order to tailor the filename when downloading from multiple sources
(see below).
</p>
<dl compact="compact">
<dd>
<a name="dest"></a></dd>
<dt><code>dest</code></dt>
<dd><p>The destination file is the only obligatory item. This must be the name
of an object which matches the type of the master object i.e. if the
master is a plain file, the destination must also be the explicit name
of a plain file. An implicit ‘copy file to directory’ syntax is not
allowed. Symbolic links are copied as symbolic links, plain files are
copied as plain files and special files are copied as special files.
The <code>recurse</code> option is required to copy the contents of subdirectories.
</p>
<p>If the destination file name is of the form
<samp>filename/..namedfork/rsrc</samp>, then it is assumed that you are
copying the resource fork of a file to an HFS+ file system on OS X
Jaguar. In the absence of the destination file being in this form (just
dest=filename), cfengine will assume that you are working with the data
fork of the file. See <a href="#dest">dest</a>.
</p>
<p>For a resource fork copy to properly work, the data fork must
have already been copied. Ie the OS will not allow you to copy the
resource fork for a file that does not exist. And, copying a data fork
after the resource fork will overwrite the resource fork. So, order is
important. Copy the data fork, first. Then, copy the resource fork.
</p>
<p>To split the data and resource forks of a file into two parts,
open up a terminal. The following commands will copy MyFile ’s data and
resource forks into two separate files which can then be recombined by
cfengine:
</p>
<div class="smallexample">
<pre class="smallexample"> cp MyFile MyFile-datafork
cp MyFile/..namedfork/rsrc MyFile-rsrcfork
</pre></div>
</dd>
<dt><code>mode, owner, group</code></dt>
<dd><p>The file mode, owner
and group of the images are specified as in the <code>files</code> function
See <a href="#files">files</a>.
</p>
<a name="copyaction"></a></dd>
<dt><code>action</code></dt>
<dd><p>The action may take the values <code>warn</code>, <code>silent</code> or
<code>fix</code>. The default action is <code>fix</code>, i.e. copy files. If
<code>warn</code> is specified, only a warning is issued about files which
require updating. If <code>silent</code> is given, then cfengine will copy
the files but not report the fact.
</p>
<a name="force"></a></dd>
<dt><code>force</code></dt>
<dd><p>If set to ‘true’, this option causes cfengine to copy files regardless
of whether it is up to date.
</p>
<a name="forceipv4"></a></dd>
<dt><code>forceipv4</code></dt>
<dd><p>If you are working on an ipv6 enabled pair of hosts, cfengine will
normally select ipv6 for communication between them. If you wish
to force the use of ipv4 for some reason, set this option to true.
</p>
<a name="forcedirs"></a></dd>
<dt><code>forcedirs</code></dt>
<dd><p>If set to ‘true’, this option causes files or links which block the
creation of directories, during recursive copying, to be moved
aside forcably. A single non-supressable warning is given when this
occurs; the file is moved to filename<samp>.cf-moved</samp>.
</p>
<a name="copybackup"></a></dd>
<dt><code>backup</code></dt>
<dd><p>If the <code>backup</code> option is set to “false”, cfengine
will not make a backup copy of the file before copying. The default value is “true”.
If the option “timestamp” is chosen, a unique timestamp will be appended
to the saved filename.
<a name="index-Backup-of-files-in-copy"></a>
<a name="index-backup_003d"></a>
<a name="index-Switching-off-backup-in-copy"></a>
</p>
<a name="copyrepository"></a></dd>
<dt><code>repository</code></dt>
<dd><p>This allows a local override of the <code>Repository</code> variable, on an item
by item basis. If set to “off” or “none” it cancels the value of a global repository.
</p>
<p>Copy makes a literal image of the master file at the destination,
checking whether the master is newer than the image. If the image needs
updating it is copied. Existing files are saved by appending
<code>.cfsaved</code> to the filename.
</p>
<a name="stealth"></a></dd>
<dt><code>stealth</code></dt>
<dd><p>If set to ‘on’ causes cfengine to preserve atime and mtime
on the source files during <em>local</em>
file copies. File times cannot be preserved on
remote copies. This option should normally only be used
together with a checksum copy, since preserving atime and mtime
implies changing ctime which will force continual copying.
This is a weakness in the Unix file system. Ctime cannot be
preserved. Before version 1.5.0, there was a typo which
made this option active on many file copies.
<a name="index-ctime-copy-doesn_0027t-always-copy-files"></a>
<a name="index-copy-doesn_0027t-always-copy-files"></a>
</p>
<a name="checkroot"></a></dd>
<dt><code>checkroot</code></dt>
<dd><p>Default value <code>false</code>, this option causes cfengine to check the
permissions of the root directory during recursive directory
copies. If not true, cfengine sets its own permissions on the root.
</p>
<a name="timestamps"></a></dd>
<dt><code>timestamps</code></dt>
<dd><p>If this is set to ‘preserve’ or ‘keep’, the times of the source
files are inherited by the destination files during copying. This is
like the ‘p’ option of the <code>tar</code> command.
<a name="index-Preserving-file-times-in-copy"></a>
</p>
<a name="recurse"></a></dd>
<dt><code>recurse</code></dt>
<dd><p>Specifies the depth of recursion when copying whole file-trees
recursively. The value may be a number or the keyword <code>inf</code>.
Cfengine crosses device boundaries or mounted filesystems when
descending recursively through file trees. To prevent
this it is simplest to specify a maximum level of recursion.
<a name="index-Device-boundaries"></a>
<a name="index-Mounted-filesystems"></a>
</p>
<a name="symlink"></a></dd>
<dt><code>symlink</code></dt>
<dd><p>This option may be repeated a number of times to specify the
names of files, or wildcards which match files which are to
be symbolically linked instead of copied. A global list of
patterns can also be defined in the control section of the program
See <a href="#linkcopies">linkcopies</a>.
</p>
<a name="copyignore"></a></dd>
<dt><code>ignore</code></dt>
<dd><p>This works like the global ignore directive but here you may
provide a private list of ignorable directories and files.
Unlike include, exclude this affects the way cfengine parses
directory trees.
</p>
<a name="copyinclude"></a></dd>
<dt><code>include</code></dt>
<dd><p>This option may be repeated a number of times to specify the names of
files, or wildcards which match files which are to be included in a copy
operation. Specifying one of these automatically excludes everything
else except further include patterns. A global list of patterns can
also be defined in the control section of the program.
</p>
<a name="index-Purge_002c-excluding-files"></a>
<p>If the <code>purge</code> option is used in copying, then the <code>ignore</code> option
has the effect of the excluding files from the purge, i.e. <code>ignore</code> means
‘keep’ the named files.
</p>
<a name="copyexclude"></a></dd>
<dt><code>exclude</code></dt>
<dd><p>This option may be repeated a number of times to specify the
names of files, or wildcards which match files which are to
be excluded from a copy operation. A global list of
patterns can also be defined in the control section of the program
‘excludes’ override ‘includes’.
See <a href="#excludelinks">excludelinks</a>.
</p>
<a name="copyxdev"></a></dd>
<dt><code>xdev</code></dt>
<dd><p>Prevents cfengine from descending into file systems that are not on the
same device as the root of the rescurion path.
<a name="index-xdev"></a>
</p>
<a name="copytype"></a></dd>
<dt><code>type</code></dt>
<dd><p>Normally cfengine uses the ctime date-stamps on files to determine
whether a file needs to be copied: a file is only copied if the master
is newer than the copy or if the copy doesn’t exist. If the type is set
to ‘<samp>checksum</samp>’ or ‘<samp>sum</samp>’, then a secure MD5 checksum is used to
determine whether the source and destination files are identical. If
‘<samp>byte</samp>’ or ‘<samp>binary</samp>’ is specified, a byte by byte comparison is
initiated. An ‘<samp>mtime</samp>’ comparison does not take into account
changes of file permissions, only modifications to the contents of the
files.
</p>
<a name="findertype"></a></dd>
<dt><code>findertype</code></dt>
<dd><p>Sets the four letter file type code in an HFS+ file system on Mac OS X
Jaguar. For example, the four letter code APPL indicates the file is an
Application (and will be executed when double-clicked). The four letter
code TEXT indicates the file is a text file and will be opened by the
default text editor.
</p>
<p>If the file also has an extension (for example <code>.txt</code>),
then if setting the finder type code, you should make sure your finder
type code does not conflict with the file extension.
</p>
<p>Files both without extensions and finder type codes are mostly useless
to OS X, so be sure to do one or the other!
</p>
<p>Also note that finder type codes should not be applied to the resource
forks of files.
</p>
<a name="server"></a></dd>
<dt><code>server</code></dt>
<dd><p>If you want to copy a file remotely from a server, you specify the
name of the server here. This must be the name of a host which is
running the <code>cfservd</code> daemon, and you must make sure that you
have defined the variable <code>domain</code> in the control section
of the <samp>cfagent.conf</samp> file. If you don’t define a domain
you will probably receive an error of the form ‘cfengine: Hey! cannot
stat file’. If the server name is ‘localhost’, cfengine will perform a local
copy, without using a connection to cfservd.
<a name="index-Hey_0021-Cannot-stat-file-error"></a>
<a name="index-Remote-copy-problems_002c-can_0027t-stat"></a>
<a name="index-locahost-in-copy"></a>
</p>
<a name="failover"></a></dd>
<dt><code>failover</code></dt>
<dd><p>If a file copy fails due to an error, the classes in this assignment
will become active, allowing failover rules to become active.
<a name="index-failover"></a>
</p>
<a name="oldserver"></a></dd>
<dt><code>oldserver</code></dt>
<dd><p>If this is true, cfengine uses the old protocol specification for
temporary compatibility with early version 2 alphas.
</p>
<a name="trustkey"></a></dd>
<dt><code>trustkey</code></dt>
<dd><p>This option defaults to ’no’ or ’false’. If set to true, cfagent will
accept a public key from a server whose public key is presently unknown
to the agent, on trust. This option should be used to bootstrap public
key transfer between hosts. Once a public key has been accepted, it will
not be replaced automatically. Dated public keys must be removed
by hand.
<a name="index-Public-keys"></a>
<a name="index-Trusted-hosts"></a>
</p>
<a name="encrypt"></a></dd>
<dt><code>encrypt</code></dt>
<dd><p>Has an effect only when used in conjuction with copy from a remote file
server. This causes cfengine to use encryption and one-time keys on
transferred data. (This requires RSA keys to be installed on both client
and server hosts, and provides strong authentication and encryption,
using random session keys.) The preferred algorithm is Blowfish, with a
128 bit key. Generally speaking the only case in which this function
makes sense is in transferring shadow password files. Encrypting the
transfer of system binaries makes little sense. Note: the
encryption keys required to get files from cfservd are those for the
user under which cfservd is running (normally root).
</p>
<a name="verify"></a></dd>
<dt><code>verify</code></dt>
<dd><p>If verify is true, cfagent attempts to verify the integrity of a remote
file transfer before the new file is installed. This takes time, since
an MD5 computation and transaction must take place.
</p>
<a name="size"></a></dd>
<dt><code>size</code></dt>
<dd><p>With this option you can specify that a file is only to be copied if the
source file meets a size critereon. This could be used to avoid
installing a corrupted file (the copying of an empty password file, for
instance). Sizes are in bytes by default, but may also be quoted in
kilobytes or megabytes using the notation:
</p>
<div class="smallexample">
<pre class="smallexample">
<var>number</var>bytes
<var>number</var>kbytes
<var>number</var>mbytes
</pre></div>
<p>Only the first characters of these strings are significant, so they may
be written however is convenient: e.g. <kbd>14kB</kbd>, <kbd>14k</kbd>,
<kbd>14kilobytes</kbd> etc.
Examples are:
</p>
<div class="smallexample">
<pre class="smallexample">
size=<400 # copy if file size is < 400 bytes
size=400 # copy if file size is equal to 400 bytes
size=>400 # copy if file size > 400 bytes
</pre></div>
<a name="linktype"></a></dd>
<dt><code>linktype</code></dt>
<dd><p>This option determines the type of link used to make links. This only
applies if the file is linked rather than copied because it matches
a pattern set by <code>symlink</code>. The default type is a direct symbolic
link. The values ‘<samp>relative</samp>’ or ‘<samp>absolute</samp>’ may be used, but
hard links may not be created in place of copied files, since hard links
must normally reside on the same filesystem as their files, and it
is assumed that most links will be between filesystems. If this value
is set to <code>copy</code> or <code>none</code>, symbolic links will be replaced
by actual copies of the files they point to. Note that for directories,
this option is ignored.
</p>
<a name="typecheck"></a></dd>
<dt><code>typecheck</code></dt>
<dd><p>Controls whether cfengine allows files of one type to overwrite files of
another type, i.e. switches on/off errors if source and existing
destination files do not match in type, e.g. if a file would overwrite a
directory or link. The default is on for safety reasons.
</p>
<a name="copydefine"></a></dd>
<dt><code>define</code></dt>
<dd><p>This option is followed by a list of classes which are to be ‘switched on’
if and only if the named file was copied. In multiple (recursive) copy
operations the classes become defined if any of the files in the file
tree were copied. This feature is useful for switching on other actions
which are to be performed after the installation of key files (e.g.
package installation scripts etc).
</p>
<a name="purge"></a></dd>
<dt><code>purge</code></dt>
<dd><p>If this option is set to true, cfengine will remove files in the
destination directory which are not also in the source directory. This
allows exact images of filesystems to be mantained. Note that if the
copy command has includes or excludes or ignored files, cfengine will
purge only those files on the client machine which are also on the
server. Included files are not purged.
This means that some files (such as system specific work files)
can be excluded from copies without them being destroyed.
<a name="index-purge_003d"></a>
<a name="index-Copy_002c-exact-filetree-images"></a>
<a name="index-File-tree-images"></a>
<a name="index-Tree-copying_002c-exact"></a>
Note that purging is disallowed if contact with a remote server fails.
This means that local files will not be destroyed by a denial of service
attack. <em>You should not use this option to synchronize NFS mounted
file systems. If the NFS server goes down, cfengine cannot then tell the
difference between a valid empty directory and a missing NFS file system.
If you use purge, use a remote copy also.</em>
If we specify purge, then the following options will also be set and
cannot be altered: <code>forcedirs=true</code>, <code>typecheck=false</code>, since
other defaults could be very destructive.
</p>
</dd>
</dl>
<table class="menu" border="0" cellspacing="0">
<tr><td align="left" valign="top">• <a href="#copy-example" accesskey="1">copy example</a>:</td><td> </td><td align="left" valign="top">
</td></tr>
<tr><td align="left" valign="top">• <a href="#hard-links-in-copy" accesskey="2">hard links in copy</a>:</td><td> </td><td align="left" valign="top">
</td></tr>
<tr><td align="left" valign="top">• <a href="#Too-many-open-files" accesskey="3">Too many open files</a>:</td><td> </td><td align="left" valign="top">
</td></tr>
</table>
<hr>
<a name="copy-example"></a>
<div class="header">
<p>
Next: <a href="#hard-links-in-copy" accesskey="n" rel="next">hard links in copy</a>, Previous: <a href="#copy" accesskey="p" rel="previous">copy</a>, Up: <a href="#copy" accesskey="u" rel="up">copy</a> [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Variable-Index" title="Index" rel="index">Index</a>]</p>
</div>
<a name="copy-example-1"></a>
<h4 class="subsection">4.12.1 copy example</h4>
<p>Example:
</p>
<div class="smallexample">
<pre class="smallexample">
copy:
/local/etc/aliases dest=/etc/aliases m=644 o=root g=other
/local/backup-etc dest=/etc
solaris::
/local/etc/nsswitch.conf dest=/etc/nsswitch.conf
</pre></div>
<p>In the first example, a global aliases file is copied from the master
site file <samp>/local/etc/aliases</samp> to <samp>/etc/aliases</samp>, setting the
owner and protection as specified. The file gets installed if
<samp>/etc/aliases</samp> doesn’t exist and updated if <samp>/local/etc/aliases</samp>
is newer than <samp>/etc/aliases</samp>. In the second example, <samp>backup-etc</samp>
is a directory containing master configuration files (for instance, <samp>services</samp>,
<samp>aliases</samp>, <samp>passwd</samp>...). Each of the files in <samp>backup-etc</samp>
is installed or updated under <samp>/etc</samp>. Finally, a global
<samp>nsswitch.conf</samp> file is kept up to date for Solaris systems.
</p>
<p>The <code>home</code> directive can be used as a destination, in which
case cfengine will copy files to every user on the system. This is
handy for distributing setup files and keeping them updated:
</p>
<div class="smallexample">
<pre class="smallexample">
copy:
/local/masterfiles/.cshrc dest=home/.cshrc mode=0600
</pre></div>
<p>You can force the copying of files, regardless of the date stamps
by setting the option <code>force=true</code> or <code>force=on</code>. The default
is <code>force=false</code> or <code>force=off</code>.
<a name="index-Force-copying"></a>
<a name="index-force_003d"></a>
</p>
<table class="menu" border="0" cellspacing="0">
<tr><td align="left" valign="top">• <a href="#hard-links-in-copy" accesskey="1">hard links in copy</a>:</td><td> </td><td align="left" valign="top">
</td></tr>
<tr><td align="left" valign="top">• <a href="#Too-many-open-files" accesskey="2">Too many open files</a>:</td><td> </td><td align="left" valign="top">
</td></tr>
</table>
<hr>
<a name="hard-links-in-copy"></a>
<div class="header">
<p>
Next: <a href="#Too-many-open-files" accesskey="n" rel="next">Too many open files</a>, Previous: <a href="#copy-example" accesskey="p" rel="previous">copy example</a>, Up: <a href="#copy" accesskey="u" rel="up">copy</a> [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Variable-Index" title="Index" rel="index">Index</a>]</p>
</div>
<a name="Hard-links-in-copying"></a>
<h4 class="subsection">4.12.2 Hard links in copying</h4>
<p>Hard links are not like symbolic links, they are not merely pointers to
other files, but alternative names for the same file. The name of every
file is a hard link, the first so to speak. You can add additional names
which <em>really are</em> the file, they are not just pointers. For the
technically minded, they are not separate inodes, they are additional
directory references to the same inode. When you perform a copy
operation on multiple files, cfengine attempts to preserve hard links
but this is a difficult task.
</p>
<p>Because a hard link just looks like an ordinary file (it cannot be
distingiushed from the original, the way a symbolic link can)
there is a danger that any copy operation will copy two hard links to
the same file as two separate copies of the same file. The difference
is that changes a hard-linked file propagate to the links, whereas
two copies of a file are completely independent thereafter.
In order to faithfully reproduce all hardlinks to all files, cfengine
needs to examine every file on the same filesystem and check whether
they have the same inode-number. This would be an enourmous overhead, so it
is not done. Instead what happens is that cfengine keeps track of only
the files which it is asked to examine, for each atomic copy-command,
and makes a note of any repeated inodes within this restricted set.
It does not try to go off, wandering around file systems looking to
other files which might be hardlinks.
</p>
<p>To summarize, cfengine preserves hardlinks during copying, only
within the scope of the present search. No backups are made of
hard links, only of the first link or name of the file is backed
up. This is a necessary precaution to avoid dangling references
in the inode table. As a general rule, hard links are to be avoided
because they are difficult to keep track of.
</p>
<hr>
<a name="Too-many-open-files"></a>
<div class="header">
<p>
Previous: <a href="#hard-links-in-copy" accesskey="p" rel="previous">hard links in copy</a>, Up: <a href="#copy" accesskey="u" rel="up">copy</a> [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Variable-Index" title="Index" rel="index">Index</a>]</p>
</div>
<a name="Too-many-open-files-1"></a>
<h4 class="subsection">4.12.3 Too many open files</h4>
<a name="index-Too-many-open-files-error"></a>
<a name="index-Too-many-open-files-error-1"></a>
<p>In long recursive copies, where you descend into many levels of diretories,
you can quickly run out of file descriptors. The number of file descriptors
is a resource which you can often set in the shell. It is a good idea
to set this limit to a large number on a host which will be copying
a lot of files. For instance, in the C shell you would write,
</p>
<div class="smallexample">
<pre class="smallexample">
limit descriptors 1024
</pre></div>
<p>Most systems should have adequate defaults for this parameter, but
on some systems it appears to be set to a low value such as 64, which is
not sufficient for large recursive tree searches.
</p>
<hr>
<a name="defaultroute"></a>
<div class="header">
<p>
Next: <a href="#disks" accesskey="n" rel="next">disks</a>, Previous: <a href="#copy" accesskey="p" rel="previous">copy</a>, Up: <a href="#Cfagent-reference" accesskey="u" rel="up">Cfagent reference</a> [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Variable-Index" title="Index" rel="index">Index</a>]</p>
</div>
<a name="defaultroute-1"></a>
<h3 class="section">4.13 defaultroute</h3>
<p>Dynamical routing is not configurable in cfengine, but for machines with
static routing tables it is useful to check that a default route is
configured to point to the nearest gateway or router. The syntax for
this statement is simply:
</p>
<div class="smallexample">
<pre class="smallexample">
defaultroute:
<var>class</var>::
my_gateway
</pre></div>
<p>For example:
</p>
<div class="smallexample">
<pre class="smallexample">
defaultroute:
most::
129.240.22.1
rest::
small_gw
no_default_route::
192.168.1.1
</pre></div>
<p>Gateways and routers usually have internet address <code>aaa.bbb.ccc.1</code>
— i.e. the first address on the subnet. You may use the numerical
form or a hostname for the gateway.
</p>
<p>The class <code>no_default_route</code> is defined if the current host does not have a currently
defined default route, but specifies one in its configuration.
<a name="index-no_005fdefault_005froute-class"></a>
</p>
<hr>
<a name="disks"></a>
<div class="header">
<p>
Next: <a href="#directories" accesskey="n" rel="next">directories</a>, Previous: <a href="#defaultroute" accesskey="p" rel="previous">defaultroute</a>, Up: <a href="#Cfagent-reference" accesskey="u" rel="up">Cfagent reference</a> [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Variable-Index" title="Index" rel="index">Index</a>]</p>
</div>
<a name="disks-1"></a>
<h3 class="section">4.14 disks</h3>
<p>This is a synonyn for <code>required</code>, See <a href="#required">required</a>.
<a name="index-disks-actions"></a>
This action tests for the existence of a file or filesystem. It should
be called after all NFS filesystems have been mounted. You may use the
special variable <code>$(binserver)</code> here.
</p>
<table class="cartouche" border="1"><tr><td>
<p><!-- /@w -->
</p><div class="smallexample">
<pre class="smallexample">
disks:
/<var>filesystem</var> freespace=<var>size-limit</var> define=<var>class-list</var>(,:.)
inform=<var>true</var>
log=<var>true</var>
audit=<var>true/false</var>
scanarrivals=<var>true</var>
force=<var>true</var>
ifelapsed=<var>mins</var>
expireafter=<var>mins</var>
</pre></div>
</td></tr></table>
<p>Files or filesystems which you consider to be essential to the operation
of the system can be declared as ‘required’. Cfengine will warn
if such files are not found, or if they look funny.
</p>
<p>Suppose you mount your filesystem <code>/usr/local</code> via NFS from some
binary server. You might want to check that this filesystem is not
empty! This might occur if the filesystem was actually <em>not</em>
mounted as expected, but failed for some reason. It is therefore not
enough to check whether the directory <code>/usr/local</code> exists, one must
also check whether it contains anything sensible.
</p>
<p>Cfengine uses two variables: <code>sensiblesize</code> and
<code>sensiblecount</code> to figure out whether a file or filesystem is
sensible or not. You can change the default values of these variables
(which are 1000 and 2 respectively) in the <code>control</code> section.
See <a href="#control">control</a>.
</p>
<p>If a file is smaller than <code>sensiblesize</code> or does not exist, it
fails the ‘required’ test. If a directory does not exist, or contains
fewer than <code>sensiblecount</code> files, then it also fails the test and a
warning is issued.
</p>
<div class="smallexample">
<pre class="smallexample">
disks:
any::
/$(site)/$(binserver)/local
</pre></div>
<p>If you set the <code>freespace</code> variable to a value and set <code>inform=true</code>,
cfagent issues warnings when free disk space falls below this threshold.
Any define-classes also become defined in this instance.
(the default units are kilobytes,
but you may specify bytes or megabytes), e.g.
<a name="index-freespace_003d-1"></a>
<a name="index-freespace_003d"></a>
<a name="index-Warning-about-full-disks"></a>
<a name="index-Full-disk-warnings"></a>
</p>
<p><!-- /@w -->
</p><div class="smallexample">
<pre class="smallexample">
required:
/site/host/home1 freespace=50mb define=dotidy
/site/host/home2 freespace=10% define=dotidy
</pre></div>
<a name="index-Percentage-disk-space"></a>
<p>then cfengine will warn when the filesystem concerned has less than this
amount of free space. By adding a <code>define</code> tag, you can switch on
any number of classes if this happens. This allows you to activate special
measures for dealing with a filesystem which is in danger of becoming
full.
</p>
<p>If the option <code>force=true</code> is used, cfengine will parse filesystems
even on NFS mounted filesystems. Normally it does not make sense to
check filesystems that are not native to the local host, but occasionally
ne would like to force such a check in order to set a class, based on the
result, for instance.
<a name="index-force_003d-1"></a>
<a name="index-NFS-filesystems-and-disk-checking"></a>
<a name="index-Setting-classes-based-on-non_002dlocal-disks"></a>
</p>
<a name="index-scanarrivals_003d-1"></a>
<a name="index-scanarrivals_003d"></a>
<p>If the <code>scanarrivals</code> option is set, the agent will recursively descend
through the file system building a database of file modification times. This
data is used for research purposes and will eventually be used to trigger
classes that determine optimal times for backup of filesystem.
</p>
<hr>
<a name="directories"></a>
<div class="header">
<p>
Next: <a href="#disable" accesskey="n" rel="next">disable</a>, Previous: <a href="#disks" accesskey="p" rel="previous">disks</a>, Up: <a href="#Cfagent-reference" accesskey="u" rel="up">Cfagent reference</a> [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Variable-Index" title="Index" rel="index">Index</a>]</p>
</div>
<a name="directories-1"></a>
<h3 class="section">4.15 directories</h3>
<a name="index-Directories_002c-making"></a>
<a name="index-Paths_002c-making"></a>
<a name="index-Making-directories"></a>
<a name="index-Making-paths"></a>
<p>Directories declarations consist of a number of directories to be
created. Directories and files may also be checked and created using
the <code>touch</code> option in the <code>files</code> actions. See <a href="#files">files</a>.
</p>
<p>The form of a declaration is:
</p>
<table class="cartouche" border="1"><tr><td>
<p><!-- /@w -->
</p><div class="smallexample">
<pre class="smallexample">
directories:
<var>classes</var>::
/<var>directory</var>
mode=<var>mode</var>
owner=<var>uid</var>
group=<var>gid</var>
rxdirs=<var>true/on</var>/<var>false/off</var>
define=<var>classlist</var>
elsedefine=<var>classlist</var>
syslog=<var>true/on</var>/<var>false/off</var>
inform=<var>true/on</var>/<var>false/off</var>
audit=<var>true/on</var>/<var>false/off</var>
ifelapsed=<var>mins</var>
expireafter=<var>mins</var>
</pre></div>
</td></tr></table>
<p>For example
</p>
<div class="smallexample">
<pre class="smallexample">
directories:
<var>class</var>::
/usr/local/bin mode=755 owner=root group=wheel
</pre></div>
<p>The form of the command is similar to that of <code>files</code> but this
command is only used to create new directories. Valid options are
<code>mode</code>, <code>owner</code>, <code>group</code> and <code>rxdirs</code>; these are described under
<code>files</code> See <a href="#files">files</a>. This interface is only for convenience.
It is strictly a part of the ‘files’ functionality and is performed
together with other ‘files’ actions at run time.
</p>
<p>The creation of a path will fail if one of the links in the path is a
plain file or device node. A list of classes may optionally be defined
here if a directory is created.
</p>
<p>If the <code>owner</code> value is set to the literal "LastNode", then the
owner will be exchanged for the last node of the path. This allows the
creation of home directories owned by users.
</p>
<a name="index-Home-directories_002c-creating"></a>
<a name="index-LastNode-literal"></a>
<div class="smallexample">
<pre class="smallexample">
control:
homedirs = ( mark:simen:luke:aeleen )
directories:
/home/$(listcontent) owner=LastNode
</pre></div>
<hr>
<a name="disable"></a>
<div class="header">
<p>
Next: <a href="#editfiles" accesskey="n" rel="next">editfiles</a>, Previous: <a href="#directories" accesskey="p" rel="previous">directories</a>, Up: <a href="#Cfagent-reference" accesskey="u" rel="up">Cfagent reference</a> [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Variable-Index" title="Index" rel="index">Index</a>]</p>
</div>
<a name="disable-1"></a>
<h3 class="section">4.16 disable</h3>
<a name="index-Disabling-files"></a>
<a name="index-Renaming-files"></a>
<a name="index-disable-1"></a>
<p>Disabling a file means renaming it so that it becomes harmless. This
feature is useful if you want to prevent certain dangerous files from
being around, but you don’t want to delete them— a deleted file cannot
be examined later. The syntax is
</p>
<table class="cartouche" border="1"><tr><td>
<p><!-- /@w -->
</p><div class="smallexample">
<pre class="smallexample">
disable:
<var>class</var>::
/<var>filename</var>
dest=<var>filename</var>
type=<var>plain/file/link/links</var>
rotate=<var>empty/truncate/numerical-value</var>
size=<var>numerical-value</var>
define=<var>classlist</var>
syslog=<var>true/on</var>/<b>false/off</b>
inform=<var>true/on</var>/<b>false/off</b>
audit=<var>true/on</var>/<var>false/off</var>
repository=<var>destination directory</var>
action=<b>disable</b>/<var>warn</var>
ifelapsed=<var>mins</var>
expireafter=<var>mins</var>
</pre></div>
</td></tr></table>
<p>If a destination filename is specified, cfagent renames the source file
to the destination, where possible (renaming across filesystems is not
allowed). If no destination is given, cfagent renames a given file by
appending the name of the file with the suffix <samp>.cfdisabled</samp>. Note
that directories are only renamed if they have a specific destination
specified.
</p>
<p>A typical example of a file you would probably want to disable would be
the <code>/etc/hosts.equiv</code> file which is often found with the ‘<samp>+</samp>’
symbol written in it, opening the system concerned to the entire NIS
universe without password protection!
<a name="index-_002fetc_002fhosts_002eequiv"></a>
<a name="index-_002ecfdisabled"></a>
Here is an example:
</p>
<div class="smallexample">
<pre class="smallexample">
disable:
/etc/hosts.equiv
/etc/nologin
/usr/lib/sendmail.fc
sun4::
/var/spool/cron/at.allow
</pre></div>
<p>Hint: The last example disables a file which restricts access to the
<code>at</code> utility. Such a command could be followed by a file action,
See <a href="#files">files</a>,
</p>
<p><!-- /@w -->
</p><div class="smallexample">
<pre class="smallexample">files:
some::
/var/spool/cron/at.allow =0644 N owner=root group=wheel touch
</pre></div>
<p>which would create an empty security file <samp>at.allow</samp>.
See also your system manual pages for the <code>at</code> command if you don’t
understand why this could be useful.
</p>
<p>Disabling a link deletes the link. If you wish you may use the
optional syntax
</p>
<div class="smallexample">
<pre class="smallexample">
disable:
/directory/name type=file
</pre></div>
<p>to specify that a file object should only be disabled if it is a plain
file. The optional element <code>type=</code> can take the values
<code>plain</code>, <code>file</code>, <code>link</code> or <code>links</code>. If one of
these is specified, cfengine checks the type and only disables
the object if there is a match. This allows you to disable a file
and replace it by a link to another file for instance.
<a name="index-Replacing-file-by-link"></a>
<a name="index-type_003d"></a>
<a name="index-Disabling-file-types"></a>
</p>
<p>NOTE that if you regularly disable a file which then gets recreated by
some process, the disabled file <samp><var>filename</var>.cfdisabled</samp> will
be overwritten each time cfengine disables the file and therefore the
contents of the original are lost each time. The <code>rotate</code> facility
was created for just this contingency.
<a name="index-Truncating-log-files"></a>
<a name="index-Controlling-the-size-of-log-files"></a>
<a name="index-Log-files_002c-controlling-the-size-of"></a>
<a name="index-Rotating-log-files"></a>
</p>
<p>The disable feature can be used to control the size of system log files,
such as <samp>/var/adm/messages</samp> using a further option <code>rotate</code>.
<a name="index-rotate_003d"></a>
<a name="index-empty"></a>
<a name="index-truncate"></a>
If the value rotate is set to 4, say,
</p>
<div class="smallexample">
<pre class="smallexample">
disable:
<var>filename</var> rotate=4
</pre></div>
<p>then cfengine renames
the file concerned by appending ‘.1’ to it and a new, empty file is
created in its place with the same owner and permissions. The next time
disable is executed ‘.1’ is renamed to ‘.2’ and the file
is renamed ‘.1’ and a new empty file is created with the same
permissions. Cfengine continues to rotate the files like this
keeping a maximum of four files. This is similar to the behaviour
of syslog.
</p>
<p>If you simply want to empty the contents of a log file, without
retaining a copy then you can use <code>rotate=empty</code> or
<code>rotate=truncate</code>. For instance,
to keep control of your World Wide Web server logs:
</p>
<div class="smallexample">
<pre class="smallexample">disable:
Sunday|Wednesday::
/usr/local/httpd/logs/access_log rotate=empty
</pre></div>
<p>This keeps a running log which is emptied each Sunday and Wednesday.
<a name="index-WWW-server-logs"></a>
</p>
<p>The <code>size=</code> option in disable allows you to carry out a disable
operation only if the size of the file is less than, equal to or greater
than some specified size. Sizes are in bytes by default, but
may also be quoted in kilobytes or megabytes using the notation:
</p>
<div class="smallexample">
<pre class="smallexample">
<var>number</var>bytes
<var>number</var>kbytes
<var>number</var>mbytes
</pre></div>
<p>Only the first characters of these strings are significant, so they may
be written however is convenient: e.g. <kbd>14kB</kbd>, <kbd>14k</kbd>,
<kbd>14kilobytes</kbd> etc.
Examples are:
</p>
<div class="smallexample">
<pre class="smallexample">
size=<400 # disable if file size is < 400 bytes
size=400 # disable if file size is equal to 400 bytes
size=>400 # disable if file size > 400 bytes
</pre></div>
<p>This options works with <code>rotate</code> or normal disabling; it is just
an extra condition which must be satisfied.
<a name="index-size-field-in-disable"></a>
</p>
<p>If a disable command results in action being taken by cfengine, an optional
list of classes becomes can be switched on with the aid of a statement
<code>define=<var>classlist</var></code> in order to trigger knock-on actions.
</p>
<p>The <code>repository</code> declaration allows a local override of the
<code>Repository</code> variable, on an item by item basis. If set to “off” or
“none” it cancels the value of a global repository and leaves the disabled
file in the same directory.
</p>
<hr>
<a name="editfiles"></a>
<div class="header">
<p>
Next: <a href="#Editfiles-on-Binary-Files" accesskey="n" rel="next">Editfiles on Binary Files</a>, Previous: <a href="#disable" accesskey="p" rel="previous">disable</a>, Up: <a href="#Cfagent-reference" accesskey="u" rel="up">Cfagent reference</a> [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Variable-Index" title="Index" rel="index">Index</a>]</p>
</div>
<a name="editfiles-1"></a>
<h3 class="section">4.17 editfiles</h3>
<p>Performs ascii (line-based) editing on text-files or limited binary
editing of files. If editing a file which has hard links to it, be
aware that editing the file will destroy the hard link references. This
is also the case with shell commands. You should avoid hard links
whenever possible.
<a name="index-awk_002c-editing"></a>
<a name="index-sed_002c-editing"></a>
The form of an editing command is
<code>editfiles</code> can also search directories recursively through directories
and edit all files matching a pattern, using <code>Include</code>, <code>Exclude</code>, and
<code>Ignore</code> (see Recursive File Sweeps in the tutorial).
</p>
<table class="cartouche" border="1"><tr><td>
<p><!-- /@w -->
</p><div class="smallexample">
<pre class="smallexample">
editfiles:
<var>class</var>::
{ <var>file-to-be-edited</var>
<var>action</var> "<var>quoted-string...</var>"
}
{ <var>directory-to-be-edited</var>
Recurse "inf" # iterated over all files
Filter "filteralias"
Include ".cshrc"
Ignore "bin"
Ignore ".netscape"
<var>action</var> "<var>quoted-string...</var>"
}
</pre></div>
</td></tr></table>
<p>Here are some examples:
</p>
<div class="smallexample">
<pre class="smallexample">editfiles:
sun4::
{ /etc/netmasks
DeleteLinesContaining "255.255.254.0"
AppendIfNoSuchLine "128.39 255.255.255.0"
}
PrintServers::
{ /etc/hosts.lpd
AppendIfNoSuchLine "tor"
AppendIfNoSuchLine "odin"
AppendIfNoSuchLine "borg"
}
</pre></div>
<p>The first of these affects the file <samp>/etc/netmasks</samp> on all SunOS 4
systems, deleting any lines containing the string “255.255.254.0” and
Appending a single line to the file containing “128.39 255.255.255.0”
if none exists already. The second affects only hosts in the class
‘PrintServers’ and adds the names of three hosts: tor, odin and borg to
the file <samp>/etc/hosts.lpd</samp> which specifies that they are allowed to
connect to the printer services on any host in the class ‘PrintServers’.
</p>
<a name="index-Quoted-strings"></a>
<a name="index-Single-quotes"></a>
<a name="index-Double-quotes"></a>
<p>Note that single or double quotes may be used to enclose strings
in cfengine. If you use single quotes, your strings may contain
double quotes and vice-versa. Otherwise a double quoted string
may not currently contain double quotes and likewise for
single quoted strings.
</p>
<p>As of version 2.0.6 quoted strings may contain escaped quotes
using <code>\"</code>.
</p>
<p>As of version 1.3.0, you can use the ‘<samp>home</samp>’ directive in
edit filenames, enabling you to edit files for every user
on the system, provided they exist. For example, to edit
every user’s login files, you would write
</p>
<div class="smallexample">
<pre class="smallexample">
{ home/.cshrc
AppendIfNoSuchLine "setenv PRINTER default-printer"
AppendIfNoSuchLine "set path = ( $path /new/directory )"
}
</pre></div>
<p>If a user does not possess the named file, cfengine just skips
that user. A new file is not created.
</p>
<p>The meanings of the file-editing actions should be self-explanatory.
Commands containing the word ’comment’ are used to ‘comment out’ certain
lines in a file rather than deleting them. <code>Hash</code> implies a shell
comment of the type
</p>
<div class="smallexample">
<pre class="smallexample"># comment
</pre></div>
<p><code>Slash</code> implies a comment of the C++ type:
</p>
<p><!-- /@w -->
</p><div class="smallexample">
<pre class="smallexample">// comment
</pre></div>
<p><code>Percent</code> implies a comment of the type:
</p>
<p><!-- /@w -->
</p><div class="smallexample">
<pre class="smallexample">% comment
</pre></div>
<p>More general comment types may be defined using the
<code>SetCommentStart</code>, <code>SetCommentEnd</code> and
<code>CommentLinesMatching</code>, <code>CommentLinesStarting</code>
functions.
</p>
<p>A special group of editing commands is based on the POSIX Regular
Expression package. These use regular expressions to search line by
line through text and perform various editing functions. Searches are of two
different types: “LineMatching” and “LineContaining”. In the first case
the regular expression must match the entire line exactly; in the latter,
a substring is searched for in the file.
</p>
<p>Some of these commands are based on the concept of a file pointer. The
pointer starts at line one of the file and can be reset by ’locating’ a
certain line, or by using the reset-pointer commands. The current
position of the pointer is used by commands such as <code>InsertLine</code> to
allow a flexible way of editing the middle of files.
</p>
<p>A simple decision mechanism is incorporated to allow certain editing
actions to be excluded. For instance, to insert a number of lines
in a file once only, you could write:
</p>
<div class="smallexample">
<pre class="smallexample">
{ <var>file</var>
LocateLineMatching "<var>insert point...</var>"
IncrementPointer "1"
BeginGroupIfNoMatch "# cfengine - 2/Jan/95"
IncrementPointer "-1"
InsertLine "# cfengine - 2/Jan/95"
InsertLine "/local/bin/start-xdm"
DefineInGroup "AddedXDM"
EndGroup
}
</pre></div>
<p>Since the first inserted line matches the predicate on subsequent calls,
the grouped lines will only be carried out once. When the grouped
lines are run, the ‘<samp>AddedXDM</samp>’ class will be activated for use by
a later part of the script.
</p>
<p>The full list of editing actions is given below in alphabetical order.
Note that some commands refer to regular expressions and some refer to
’literal strings’ (i.e. any string which is not a regular
expression). Variable substitution is performed on all strings. Be
aware that symbols such as ‘<samp>.</samp>’, ‘<samp>*</samp>’ and so on are
meta-characters in regular expressions and a backslash must be used to
make them literal. The regular expression matching functions are
POSIX extended regular expressions.
See <a href="cfengine-Tutorial.html#Regular-expressions">(cfengine-Tutorial)Regular
expressions</a>.
</p>
<table class="cartouche" border="1"><tr><td>
<p><b>Editfile caution.</b>
It is suggested that you use these editing functions with
caution. Although all possible safeguards have been incorporated into
them, it is still possible through carelessness to do damage to
important files on your system. Always test editing programs carefully
before committing them to your global site configuration.
</p></td></tr></table>
<table class="menu" border="0" cellspacing="0">
<tr><td align="left" valign="top">• <a href="#AbortAtLineMatching" accesskey="1">AbortAtLineMatching</a>:</td><td> </td><td align="left" valign="top">
</td></tr>
<tr><td align="left" valign="top">• <a href="#Append" accesskey="2">Append</a>:</td><td> </td><td align="left" valign="top">
</td></tr>
<tr><td align="left" valign="top">• <a href="#AppendIfNoLineMatching" accesskey="3">AppendIfNoLineMatching</a>:</td><td> </td><td align="left" valign="top">
</td></tr>
<tr><td align="left" valign="top">• <a href="#AppendIfNoSuchLine" accesskey="4">AppendIfNoSuchLine</a>:</td><td> </td><td align="left" valign="top">
</td></tr>
<tr><td align="left" valign="top">• <a href="#AppendIfNoSuchLinesFromFile" accesskey="5">AppendIfNoSuchLinesFromFile</a>:</td><td> </td><td align="left" valign="top">
</td></tr>
<tr><td align="left" valign="top">• <a href="#AppendToLineIfNotContains" accesskey="6">AppendToLineIfNotContains</a>:</td><td> </td><td align="left" valign="top">
</td></tr>
<tr><td align="left" valign="top">• <a href="#Audit" accesskey="7">Audit</a>:</td><td> </td><td align="left" valign="top">
</td></tr>
<tr><td align="left" valign="top">• <a href="#AutoCreate" accesskey="8">AutoCreate</a>:</td><td> </td><td align="left" valign="top">
</td></tr>
<tr><td align="left" valign="top">• <a href="#AutomountDirectResources" accesskey="9">AutomountDirectResources</a>:</td><td> </td><td align="left" valign="top">
</td></tr>
<tr><td align="left" valign="top">• <a href="#Backup-in-editfiles">Backup in editfiles</a>:</td><td> </td><td align="left" valign="top">
</td></tr>
<tr><td align="left" valign="top">• <a href="#BeginGroupIfDefined">BeginGroupIfDefined</a>:</td><td> </td><td align="left" valign="top">
</td></tr>
<tr><td align="left" valign="top">• <a href="#BeginGroupIfNotDefined">BeginGroupIfNotDefined</a>:</td><td> </td><td align="left" valign="top">
</td></tr>
<tr><td align="left" valign="top">• <a href="#BeginGroupIfFileExists">BeginGroupIfFileExists</a>:</td><td> </td><td align="left" valign="top">
</td></tr>
<tr><td align="left" valign="top">• <a href="#BeginGroupIfFileIsNewer">BeginGroupIfFileIsNewer</a>:</td><td> </td><td align="left" valign="top">
</td></tr>
<tr><td align="left" valign="top">• <a href="#BeginGroupIfLineContaining">BeginGroupIfLineContaining</a>:</td><td> </td><td align="left" valign="top">
</td></tr>
<tr><td align="left" valign="top">• <a href="#BeginGroupIfLineMatching">BeginGroupIfLineMatching</a>:</td><td> </td><td align="left" valign="top">
</td></tr>
<tr><td align="left" valign="top">• <a href="#BeginGroupIfMatch">BeginGroupIfMatch</a>:</td><td> </td><td align="left" valign="top">
</td></tr>
<tr><td align="left" valign="top">• <a href="#BeginGroupIfNoLineContaining">BeginGroupIfNoLineContaining</a>:</td><td> </td><td align="left" valign="top">
</td></tr>
<tr><td align="left" valign="top">• <a href="#BeginGroupIfNoLineMatching">BeginGroupIfNoLineMatching</a>:</td><td> </td><td align="left" valign="top">
</td></tr>
<tr><td align="left" valign="top">• <a href="#BeginGroupIfNoMatch">BeginGroupIfNoMatch</a>:</td><td> </td><td align="left" valign="top">
</td></tr>
<tr><td align="left" valign="top">• <a href="#BeginGroupIfNoSuchLine">BeginGroupIfNoSuchLine</a>:</td><td> </td><td align="left" valign="top">
</td></tr>
<tr><td align="left" valign="top">• <a href="#BreakIfLineMatches">BreakIfLineMatches</a>:</td><td> </td><td align="left" valign="top">
</td></tr>
<tr><td align="left" valign="top">• <a href="#CatchAbort">CatchAbort</a>:</td><td> </td><td align="left" valign="top">
</td></tr>
<tr><td align="left" valign="top">• <a href="#CommentLinesMatching">CommentLinesMatching</a>:</td><td> </td><td align="left" valign="top">
</td></tr>
<tr><td align="left" valign="top">• <a href="#CommentLinesStarting">CommentLinesStarting</a>:</td><td> </td><td align="left" valign="top">
</td></tr>
<tr><td align="left" valign="top">• <a href="#CommentNLines">CommentNLines</a>:</td><td> </td><td align="left" valign="top">
</td></tr>
<tr><td align="left" valign="top">• <a href="#CommentToLineMatching">CommentToLineMatching</a>:</td><td> </td><td align="left" valign="top">
</td></tr>
<tr><td align="left" valign="top">• <a href="#DefineClasses">DefineClasses</a>:</td><td> </td><td align="left" valign="top">
</td></tr>
<tr><td align="left" valign="top">• <a href="#DefineInGroup">DefineInGroup</a>:</td><td> </td><td align="left" valign="top">
</td></tr>
<tr><td align="left" valign="top">• <a href="#DeleteLinesAfterThisMatching">DeleteLinesAfterThisMatching</a>:</td><td> </td><td align="left" valign="top">
</td></tr>
<tr><td align="left" valign="top">• <a href="#DeleteLinesContaining">DeleteLinesContaining</a>:</td><td> </td><td align="left" valign="top">
</td></tr>
<tr><td align="left" valign="top">• <a href="#DeleteLinesMatching">DeleteLinesMatching</a>:</td><td> </td><td align="left" valign="top">
</td></tr>
<tr><td align="left" valign="top">• <a href="#DeleteLinesStarting">DeleteLinesStarting</a>:</td><td> </td><td align="left" valign="top">
</td></tr>
<tr><td align="left" valign="top">• <a href="#DeleteLinesNotContaining">DeleteLinesNotContaining</a>:</td><td> </td><td align="left" valign="top">
</td></tr>
<tr><td align="left" valign="top">• <a href="#DeleteLinesNotMatchingFileItems">DeleteLinesNotMatchingFileItems</a>:</td><td> </td><td align="left" valign="top">
</td></tr>
<tr><td align="left" valign="top">• <a href="#DeleteLinesNotStartingFileItems">DeleteLinesNotStartingFileItems</a>:</td><td> </td><td align="left" valign="top">
</td></tr>
<tr><td align="left" valign="top">• <a href="#DeleteNLines">DeleteNLines</a>:</td><td> </td><td align="left" valign="top">
</td></tr>
<tr><td align="left" valign="top">• <a href="#DeleteToLineMatching">DeleteToLineMatching</a>:</td><td> </td><td align="left" valign="top">
</td></tr>
<tr><td align="left" valign="top">• <a href="#EditMode-_0028binary_0029">EditMode (binary)</a>:</td><td> </td><td align="left" valign="top">
</td></tr>
<tr><td align="left" valign="top">• <a href="#EditSplit">EditSplit</a>:</td><td> </td><td align="left" valign="top">
</td></tr>
<tr><td align="left" valign="top">• <a href="#EmptyEntireFilePlease">EmptyEntireFilePlease</a>:</td><td> </td><td align="left" valign="top">
</td></tr>
<tr><td align="left" valign="top">• <a href="#ElseDefineClasses">ElseDefineClasses</a>:</td><td> </td><td align="left" valign="top">
</td></tr>
<tr><td align="left" valign="top">• <a href="#EndGroup">EndGroup</a>:</td><td> </td><td align="left" valign="top">
</td></tr>
<tr><td align="left" valign="top">• <a href="#EndLoop">EndLoop</a>:</td><td> </td><td align="left" valign="top">
</td></tr>
<tr><td align="left" valign="top">• <a href="#ExpandVariables">ExpandVariables</a>:</td><td> </td><td align="left" valign="top">
</td></tr>
<tr><td align="left" valign="top">• <a href="#ExpireAfter-editfiles">ExpireAfter editfiles</a>:</td><td> </td><td align="left" valign="top">
</td></tr>
<tr><td align="left" valign="top">• <a href="#Filter">Filter</a>:</td><td> </td><td align="left" valign="top">
</td></tr>
<tr><td align="left" valign="top">• <a href="#FixEndOfLine">FixEndOfLine</a>:</td><td> </td><td align="left" valign="top">
</td></tr>
<tr><td align="left" valign="top">• <a href="#ForEachLineIn">ForEachLineIn</a>:</td><td> </td><td align="left" valign="top">
</td></tr>
<tr><td align="left" valign="top">• <a href="#GotoLastLine">GotoLastLine</a>:</td><td> </td><td align="left" valign="top">
</td></tr>
<tr><td align="left" valign="top">• <a href="#HashCommentLinesContaining">HashCommentLinesContaining</a>:</td><td> </td><td align="left" valign="top">
</td></tr>
<tr><td align="left" valign="top">• <a href="#HashCommentLinesMatching">HashCommentLinesMatching</a>:</td><td> </td><td align="left" valign="top">
</td></tr>
<tr><td align="left" valign="top">• <a href="#HashCommentLinesStarting">HashCommentLinesStarting</a>:</td><td> </td><td align="left" valign="top">
</td></tr>
<tr><td align="left" valign="top">• <a href="#IfElapsed-_0028editing_0029">IfElapsed (editing)</a>:</td><td> </td><td align="left" valign="top">
</td></tr>
<tr><td align="left" valign="top">• <a href="#IncrementPointer">IncrementPointer</a>:</td><td> </td><td align="left" valign="top">
</td></tr>
<tr><td align="left" valign="top">• <a href="#Inform-_0028editing_0029">Inform (editing)</a>:</td><td> </td><td align="left" valign="top">
</td></tr>
<tr><td align="left" valign="top">• <a href="#InsertFile">InsertFile</a>:</td><td> </td><td align="left" valign="top">
</td></tr>
<tr><td align="left" valign="top">• <a href="#InsertLine">InsertLine</a>:</td><td> </td><td align="left" valign="top">
</td></tr>
<tr><td align="left" valign="top">• <a href="#LocateLineMatching">LocateLineMatching</a>:</td><td> </td><td align="left" valign="top">
</td></tr>
<tr><td align="left" valign="top">• <a href="#PercentCommentLinesContaining">PercentCommentLinesContaining</a>:</td><td> </td><td align="left" valign="top">
</td></tr>
<tr><td align="left" valign="top">• <a href="#PercentCommentLinesMatching">PercentCommentLinesMatching</a>:</td><td> </td><td align="left" valign="top">
</td></tr>
<tr><td align="left" valign="top">• <a href="#PercentCommentLinesStarting">PercentCommentLinesStarting</a>:</td><td> </td><td align="left" valign="top">
</td></tr>
<tr><td align="left" valign="top">• <a href="#Prepend-_0028editing_0029">Prepend (editing)</a>:</td><td> </td><td align="left" valign="top">
</td></tr>
<tr><td align="left" valign="top">• <a href="#PrependIfNoLineMatching">PrependIfNoLineMatching</a>:</td><td> </td><td align="left" valign="top">
</td></tr>
<tr><td align="left" valign="top">• <a href="#PrependIfNoSuchLine">PrependIfNoSuchLine</a>:</td><td> </td><td align="left" valign="top">
</td></tr>
<tr><td align="left" valign="top">• <a href="#Recurse-_0028editing_0029">Recurse (editing)</a>:</td><td> </td><td align="left" valign="top">
</td></tr>
<tr><td align="left" valign="top">• <a href="#ReplaceLineWith">ReplaceLineWith</a>:</td><td> </td><td align="left" valign="top">
</td></tr>
<tr><td align="left" valign="top">• <a href="#ReplaceAll-With">ReplaceAll With</a>:</td><td> </td><td align="left" valign="top">
</td></tr>
<tr><td align="left" valign="top">• <a href="#ReplaceFirst">ReplaceFirst</a>:</td><td> </td><td align="left" valign="top">
</td></tr>
<tr><td align="left" valign="top">• <a href="#ReplaceLinesMatchingField">ReplaceLinesMatchingField</a>:</td><td> </td><td align="left" valign="top">
</td></tr>
<tr><td align="left" valign="top">• <a href="#Repository">Repository</a>:</td><td> </td><td align="left" valign="top">
</td></tr>
<tr><td align="left" valign="top">• <a href="#ResetSearch">ResetSearch</a>:</td><td> </td><td align="left" valign="top">
</td></tr>
<tr><td align="left" valign="top">• <a href="#RunScript">RunScript</a>:</td><td> </td><td align="left" valign="top">
</td></tr>
<tr><td align="left" valign="top">• <a href="#RunScriptIfLineMatching">RunScriptIfLineMatching</a>:</td><td> </td><td align="left" valign="top">
</td></tr>
<tr><td align="left" valign="top">• <a href="#RunScriptIfNoLineMatching">RunScriptIfNoLineMatching</a>:</td><td> </td><td align="left" valign="top">
</td></tr>
<tr><td align="left" valign="top">• <a href="#SetCommentStart">SetCommentStart</a>:</td><td> </td><td align="left" valign="top">
</td></tr>
<tr><td align="left" valign="top">• <a href="#SetCommentEnd">SetCommentEnd</a>:</td><td> </td><td align="left" valign="top">
</td></tr>
<tr><td align="left" valign="top">• <a href="#SetLine">SetLine</a>:</td><td> </td><td align="left" valign="top">
</td></tr>
<tr><td align="left" valign="top">• <a href="#SetScript">SetScript</a>:</td><td> </td><td align="left" valign="top">
</td></tr>
<tr><td align="left" valign="top">• <a href="#SlashCommentLinesContaining">SlashCommentLinesContaining</a>:</td><td> </td><td align="left" valign="top">
</td></tr>
<tr><td align="left" valign="top">• <a href="#SlashCommentLinesMatching">SlashCommentLinesMatching</a>:</td><td> </td><td align="left" valign="top">
</td></tr>
<tr><td align="left" valign="top">• <a href="#SlashCommentLinesStarting">SlashCommentLinesStarting</a>:</td><td> </td><td align="left" valign="top">
</td></tr>
<tr><td align="left" valign="top">• <a href="#SplitOn">SplitOn</a>:</td><td> </td><td align="left" valign="top">
</td></tr>
<tr><td align="left" valign="top">• <a href="#SysLog">SysLog</a>:</td><td> </td><td align="left" valign="top">
</td></tr>
<tr><td align="left" valign="top">• <a href="#Umask">Umask</a>:</td><td> </td><td align="left" valign="top">
</td></tr>
<tr><td align="left" valign="top">• <a href="#UnCommentLinesContaining">UnCommentLinesContaining</a>:</td><td> </td><td align="left" valign="top">
</td></tr>
<tr><td align="left" valign="top">• <a href="#UnCommentLinesMatching">UnCommentLinesMatching</a>:</td><td> </td><td align="left" valign="top">
</td></tr>
<tr><td align="left" valign="top">• <a href="#UnCommentsNLines">UnCommentsNLines</a>:</td><td> </td><td align="left" valign="top">
</td></tr>
<tr><td align="left" valign="top">• <a href="#UnCommentToLineMatching">UnCommentToLineMatching</a>:</td><td> </td><td align="left" valign="top">
</td></tr>
<tr><td align="left" valign="top">• <a href="#UnsetAbort">UnsetAbort</a>:</td><td> </td><td align="left" valign="top">
</td></tr>
<tr><td align="left" valign="top">• <a href="#UseShell">UseShell</a>:</td><td> </td><td align="left" valign="top">
</td></tr>
<tr><td align="left" valign="top">• <a href="#WarnIfFileMissing">WarnIfFileMissing</a>:</td><td> </td><td align="left" valign="top">
</td></tr>
<tr><td align="left" valign="top">• <a href="#WarnIfLineContaining">WarnIfLineContaining</a>:</td><td> </td><td align="left" valign="top">
</td></tr>
<tr><td align="left" valign="top">• <a href="#WarnIfLineMatching">WarnIfLineMatching</a>:</td><td> </td><td align="left" valign="top">
</td></tr>
<tr><td align="left" valign="top">• <a href="#WarnIfLineStarting">WarnIfLineStarting</a>:</td><td> </td><td align="left" valign="top">
</td></tr>
<tr><td align="left" valign="top">• <a href="#WarnIfNoLineContaining">WarnIfNoLineContaining</a>:</td><td> </td><td align="left" valign="top">
</td></tr>
<tr><td align="left" valign="top">• <a href="#WarnIfNoLineMatching">WarnIfNoLineMatching</a>:</td><td> </td><td align="left" valign="top">
</td></tr>
<tr><td align="left" valign="top">• <a href="#WarnIfNoLineStarting">WarnIfNoLineStarting</a>:</td><td> </td><td align="left" valign="top">
</td></tr>
<tr><td align="left" valign="top">• <a href="#WarnIfNoSuchLine">WarnIfNoSuchLine</a>:</td><td> </td><td align="left" valign="top">
</td></tr>
</table>
<hr>
<a name="AbortAtLineMatching"></a>
<div class="header">
<p>
Next: <a href="#Append" accesskey="n" rel="next">Append</a>, Previous: <a href="#editfiles" accesskey="p" rel="previous">editfiles</a>, Up: <a href="#editfiles" accesskey="u" rel="up">editfiles</a> [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Variable-Index" title="Index" rel="index">Index</a>]</p>
</div>
<a name="AbortAtLineMatching-1"></a>
<h4 class="subsection">4.17.1 AbortAtLineMatching</h4>
<div class="smallexample">
<pre class="smallexample">
AbortAtLineMatching <var>quoted-regex</var>
</pre></div>
<p>This command sets the value of a regular expression. In all editing
operations (except <code>FixEndOfLine</code> and <code>GotoLastLine</code>) which involve multiple
replacements and searches, this expression marks a boundary
beyond which cfengine will cease to look any further. In other
words, if cfengine encounters a line matching this regular
expression, it aborts the current action. BE CAREFUL with this
feature: once set, the string remains set for the remainder of
the current file. It might therefore interact in unsuspected ways
with other search parameters. Editing actions are always aborted
as soon as the abort expression is matched.
Use <code>UnsetAbort</code> to unset the feature.
</p>
<hr>
<a name="Append"></a>
<div class="header">
<p>
Next: <a href="#AppendIfNoLineMatching" accesskey="n" rel="next">AppendIfNoLineMatching</a>, Previous: <a href="#AbortAtLineMatching" accesskey="p" rel="previous">AbortAtLineMatching</a>, Up: <a href="#editfiles" accesskey="u" rel="up">editfiles</a> [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Variable-Index" title="Index" rel="index">Index</a>]</p>
</div>
<a name="Append-1"></a>
<h4 class="subsection">4.17.2 Append</h4>
<div class="smallexample">
<pre class="smallexample">
Append <var>quoted-regex</var>
</pre></div>
<p>Add a line containing the quoted string to the end of the file.
This should be used in conjunction with the
decision structures <code>BeginGroupIfNoLineMatching</code> and
<code>BreakIfLineMatches</code>.
</p>
<hr>
<a name="AppendIfNoLineMatching"></a>
<div class="header">
<p>
Next: <a href="#AppendIfNoSuchLine" accesskey="n" rel="next">AppendIfNoSuchLine</a>, Previous: <a href="#Append" accesskey="p" rel="previous">Append</a>, Up: <a href="#editfiles" accesskey="u" rel="up">editfiles</a> [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Variable-Index" title="Index" rel="index">Index</a>]</p>
</div>
<a name="AppendIfNoLineMatching-1"></a>
<h4 class="subsection">4.17.3 AppendIfNoLineMatching</h4>
<div class="smallexample">
<pre class="smallexample">
AppendIfNoLineMatching <var>quoted-regex</var>/ ``ThisLine''
</pre></div>
<p>A new version of the older <code>AppendIfNoSuchLine</code>
which uses a regular expression instead of a literal
string. The line which gets appended must be set
previously using <code>SetLine</code>. If <code>``ThisLine''</code> is
given as the argument, the current value of then line buffer
is assumed. This allows constructions for merging files
on a convergent line-by-line basis:
</p>
<div class="smallexample">
<pre class="smallexample">
editfiles:
{ /tmp/bla
ForEachLineIn "/tmp/in"
AppendIfNoLineMatching "ThisLine"
EndLoop
}
</pre></div>
<a name="index-Merging-files_002e"></a>
<hr>
<a name="AppendIfNoSuchLine"></a>
<div class="header">
<p>
Next: <a href="#AppendIfNoSuchLinesFromFile" accesskey="n" rel="next">AppendIfNoSuchLinesFromFile</a>, Previous: <a href="#AppendIfNoLineMatching" accesskey="p" rel="previous">AppendIfNoLineMatching</a>, Up: <a href="#editfiles" accesskey="u" rel="up">editfiles</a> [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Variable-Index" title="Index" rel="index">Index</a>]</p>
</div>
<a name="AppendIfNoSuchLine-1"></a>
<h4 class="subsection">4.17.4 AppendIfNoSuchLine</h4>
<div class="smallexample">
<pre class="smallexample">
AppendIfNoSuchLine <var>quoted-string</var>
</pre></div>
<p>Add a line containing the quoted string to the end of the file
if the file doesn’t contain the exact line already.
</p>
<hr>
<a name="AppendIfNoSuchLinesFromFile"></a>
<div class="header">
<p>
Next: <a href="#AppendToLineIfNotContains" accesskey="n" rel="next">AppendToLineIfNotContains</a>, Previous: <a href="#AppendIfNoSuchLine" accesskey="p" rel="previous">AppendIfNoSuchLine</a>, Up: <a href="#editfiles" accesskey="u" rel="up">editfiles</a> [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Variable-Index" title="Index" rel="index">Index</a>]</p>
</div>
<a name="AppendIfNoSuchLinesFromFile-1"></a>
<h4 class="subsection">4.17.5 AppendIfNoSuchLinesFromFile</h4>
<div class="smallexample">
<pre class="smallexample">
AppendIfNoSuchLinesFromFile <var>filename</var>
</pre></div>
<p>For each line in the named file, call AppendIfNoSuchLine. This adds
lines containing the strings listed in the named file to the end of the
current file if the file doesn’t contain the exact line already.
<a name="index-AppendIfNoSuchLinesFromFile"></a>
</p>
<hr>
<a name="AppendToLineIfNotContains"></a>
<div class="header">
<p>
Next: <a href="#Audit" accesskey="n" rel="next">Audit</a>, Previous: <a href="#AppendIfNoSuchLinesFromFile" accesskey="p" rel="previous">AppendIfNoSuchLinesFromFile</a>, Up: <a href="#editfiles" accesskey="u" rel="up">editfiles</a> [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Variable-Index" title="Index" rel="index">Index</a>]</p>
</div>
<a name="AppendToLineIfNotContains-1"></a>
<h4 class="subsection">4.17.6 AppendToLineIfNotContains</h4>
<div class="smallexample">
<pre class="smallexample">
AppendToLineIfNotContains <var>quoted-string</var>
</pre></div>
<p>This commands looks for an exact match of the quoted string
in the current line. If the quoted string is not contained
in the line, it is appended. This may be used for adding
entries to a list.
</p>
<hr>
<a name="Audit"></a>
<div class="header">
<p>
Next: <a href="#AutoCreate" accesskey="n" rel="next">AutoCreate</a>, Previous: <a href="#AppendToLineIfNotContains" accesskey="p" rel="previous">AppendToLineIfNotContains</a>, Up: <a href="#editfiles" accesskey="u" rel="up">editfiles</a> [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Variable-Index" title="Index" rel="index">Index</a>]</p>
</div>
<a name="Audit-in-editfiles"></a>
<h4 class="subsection">4.17.7 Audit in editfiles</h4>
<div class="smallexample">
<pre class="smallexample">
Audit <var>true/false</var>
</pre></div>
<p>Local decision about whether this edit stanza will be audited. Requires
auditing to be on globally for this to have an effect.
</p>
<hr>
<a name="AutoCreate"></a>
<div class="header">
<p>
Next: <a href="#AutomountDirectResources" accesskey="n" rel="next">AutomountDirectResources</a>, Previous: <a href="#Audit" accesskey="p" rel="previous">Audit</a>, Up: <a href="#editfiles" accesskey="u" rel="up">editfiles</a> [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Variable-Index" title="Index" rel="index">Index</a>]</p>
</div>
<a name="AutoCreate-1"></a>
<h4 class="subsection">4.17.8 AutoCreate</h4>
<p>If this command is listed anywhere in the file action list, cfengine
will create the named file if it doesn’t exist. Normally cfengine issues
an error if the named file does not exist, but if this is set,
notification of the file’s absence is only in verbose output. New files
are created with mode 644 (see also Umask), read access for everyone and write access for
the cfengine user (normally root). Note that if you set this,
BeginGroupIfFileIsNewer will always be true.
<a name="index-AutoCreate"></a>
<a name="index-How-to-create-files-while-editing"></a>
</p>
<hr>
<a name="AutomountDirectResources"></a>
<div class="header">
<p>
Next: <a href="#Backup-in-editfiles" accesskey="n" rel="next">Backup in editfiles</a>, Previous: <a href="#AutoCreate" accesskey="p" rel="previous">AutoCreate</a>, Up: <a href="#editfiles" accesskey="u" rel="up">editfiles</a> [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Variable-Index" title="Index" rel="index">Index</a>]</p>
</div>
<a name="AutomountDirectResources-1"></a>
<h4 class="subsection">4.17.9 AutomountDirectResources</h4>
<div class="smallexample">
<pre class="smallexample">
AutomountDirectResources <var>quoted-string</var>
</pre></div>
<p>This command is designed to assist with automounter configuration for
users wishing to use the automounter for NFS filesystems, but still use
the cfengine mount model.
<a name="index-NFS-mount-model-and-automounter"></a>
<a name="index-automounter"></a>
Applied to the current file, it is equivalent to saying: for each of the
mountable resources in the list See <a href="#mountables">mountables</a>, append if not found a
line for a direct automount map command, to the current file. The
string which follows can be used to specify any special mount options
e.g. <code>``-nosuid''</code> for non setuid mounting (of all the
mountables). Note that this is added to the current file and not to a
file named <samp>/etc/auto_direct</samp>.
</p>
<hr>
<a name="Backup-in-editfiles"></a>
<div class="header">
<p>
Next: <a href="#BeginGroupIfDefined" accesskey="n" rel="next">BeginGroupIfDefined</a>, Previous: <a href="#AutomountDirectResources" accesskey="p" rel="previous">AutomountDirectResources</a>, Up: <a href="#editfiles" accesskey="u" rel="up">editfiles</a> [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Variable-Index" title="Index" rel="index">Index</a>]</p>
</div>
<a name="Backup-in-editfiles-1"></a>
<h4 class="subsection">4.17.10 Backup in editfiles</h4>
<div class="smallexample">
<pre class="smallexample">
Backup <var>quoted-string</var>
</pre></div>
<p>Set to true or false, on or off to set backup policy for this file.
Default is on. The default is to produce time-stamped backups of
files; this may be coded explicitly by setting to “timestamp” or
“stamp”. If set to “false” or “off”, no backup is kept of the
edited file. If the value is set to “single” or “one” then only
the last version of the file is kept, overwriting any previously saved
versions.
</p>
<p>See <a href="#copybackup">copybackup</a>.
</p>
<div class="smallexample">
<pre class="smallexample"> Backup "single"
</pre></div>
<a name="index-Backup"></a>
<hr>
<a name="BeginGroupIfDefined"></a>
<div class="header">
<p>
Next: <a href="#BeginGroupIfNotDefined" accesskey="n" rel="next">BeginGroupIfNotDefined</a>, Previous: <a href="#Backup-in-editfiles" accesskey="p" rel="previous">Backup in editfiles</a>, Up: <a href="#editfiles" accesskey="u" rel="up">editfiles</a> [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Variable-Index" title="Index" rel="index">Index</a>]</p>
</div>
<a name="BeginGroupIfDefined-1"></a>
<h4 class="subsection">4.17.11 BeginGroupIfDefined</h4>
<div class="smallexample">
<pre class="smallexample">
BeginGroupIfDefined <var>quoted-string</var>
</pre></div>
<p>The lines following, up to the first <code>EndGroup</code>
are executed if the quoted class is defined. Edit groups may be nested.
<a name="index-BeginGroupIfDefined"></a>
</p>
<hr>
<a name="BeginGroupIfNotDefined"></a>
<div class="header">
<p>
Next: <a href="#BeginGroupIfFileExists" accesskey="n" rel="next">BeginGroupIfFileExists</a>, Previous: <a href="#BeginGroupIfDefined" accesskey="p" rel="previous">BeginGroupIfDefined</a>, Up: <a href="#editfiles" accesskey="u" rel="up">editfiles</a> [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Variable-Index" title="Index" rel="index">Index</a>]</p>
</div>
<a name="BeginGroupIfNotDefined-1"></a>
<h4 class="subsection">4.17.12 BeginGroupIfNotDefined</h4>
<div class="smallexample">
<pre class="smallexample">
BeginGroupIfNotDefined <var>quoted-string</var>
</pre></div>
<p>The lines following, up to the first <code>EndGroup</code>
are executed if the quoted class is not defined. Edit groups may be nested.
<a name="index-BeginGroupIfNotDefined"></a>
</p>
<hr>
<a name="BeginGroupIfFileExists"></a>
<div class="header">
<p>
Next: <a href="#BeginGroupIfFileIsNewer" accesskey="n" rel="next">BeginGroupIfFileIsNewer</a>, Previous: <a href="#BeginGroupIfNotDefined" accesskey="p" rel="previous">BeginGroupIfNotDefined</a>, Up: <a href="#editfiles" accesskey="u" rel="up">editfiles</a> [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Variable-Index" title="Index" rel="index">Index</a>]</p>
</div>
<a name="BeginGroupIfFileExists-1"></a>
<h4 class="subsection">4.17.13 BeginGroupIfFileExists</h4>
<div class="smallexample">
<pre class="smallexample">
BeginGroupIfFileExists <var>quoted-string</var>
</pre></div>
<p>The lines following, up to the first <code>EndGroup</code>
are executed if the quoted filename exists (can be statted).
Files which are not readable by the running process are
for all intents and purposes non-existent. Edit groups may be nested.
<a name="index-BeginGroupIfFileExists"></a>
</p>
<hr>
<a name="BeginGroupIfFileIsNewer"></a>
<div class="header">
<p>
Next: <a href="#BeginGroupIfLineContaining" accesskey="n" rel="next">BeginGroupIfLineContaining</a>, Previous: <a href="#BeginGroupIfFileExists" accesskey="p" rel="previous">BeginGroupIfFileExists</a>, Up: <a href="#editfiles" accesskey="u" rel="up">editfiles</a> [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Variable-Index" title="Index" rel="index">Index</a>]</p>
</div>
<a name="BeginGroupIfFileIsNewer-1"></a>
<h4 class="subsection">4.17.14 BeginGroupIfFileIsNewer</h4>
<div class="smallexample">
<pre class="smallexample">
BeginGroupIfFileIsNewer <var>quoted-string</var>
</pre></div>
<p>The lines following, up to the first <code>EndGroup</code>
are executed if the quoted filename is newer than the file being
edited. Edit groups may be nested.
<a name="index-BeginGroupIfFileIsNewer"></a>
</p>
<hr>
<a name="BeginGroupIfLineContaining"></a>
<div class="header">
<p>
Next: <a href="#BeginGroupIfLineMatching" accesskey="n" rel="next">BeginGroupIfLineMatching</a>, Previous: <a href="#BeginGroupIfFileIsNewer" accesskey="p" rel="previous">BeginGroupIfFileIsNewer</a>, Up: <a href="#editfiles" accesskey="u" rel="up">editfiles</a> [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Variable-Index" title="Index" rel="index">Index</a>]</p>
</div>
<a name="BeginGroupIfLineContaining-1"></a>
<h4 class="subsection">4.17.15 BeginGroupIfLineContaining</h4>
<div class="smallexample">
<pre class="smallexample">
BeginGroupIfLineContaining <var>quoted-string</var>
</pre></div>
<p>The lines following, up to the first <code>EndGroup</code>
are executed if the quoted string appears in
any line in the file. Edit groups may be nested.
</p>
<hr>
<a name="BeginGroupIfLineMatching"></a>
<div class="header">
<p>
Next: <a href="#BeginGroupIfMatch" accesskey="n" rel="next">BeginGroupIfMatch</a>, Previous: <a href="#BeginGroupIfLineContaining" accesskey="p" rel="previous">BeginGroupIfLineContaining</a>, Up: <a href="#editfiles" accesskey="u" rel="up">editfiles</a> [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Variable-Index" title="Index" rel="index">Index</a>]</p>
</div>
<a name="BeginGroupIfLineMatching-1"></a>
<h4 class="subsection">4.17.16 BeginGroupIfLineMatching</h4>
<div class="smallexample">
<pre class="smallexample">
BeginGroupIfLineMatching <var>quoted-regex</var>
</pre></div>
<p>The lines following, up to the first <code>EndGroup</code>
are executed if the quoted regular expression
matches any line in the file. Edit groups may be nested.
</p>
<hr>
<a name="BeginGroupIfMatch"></a>
<div class="header">
<p>
Next: <a href="#BeginGroupIfNoLineContaining" accesskey="n" rel="next">BeginGroupIfNoLineContaining</a>, Previous: <a href="#BeginGroupIfLineMatching" accesskey="p" rel="previous">BeginGroupIfLineMatching</a>, Up: <a href="#editfiles" accesskey="u" rel="up">editfiles</a> [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Variable-Index" title="Index" rel="index">Index</a>]</p>
</div>
<a name="BeginGroupIfMatch-1"></a>
<h4 class="subsection">4.17.17 BeginGroupIfMatch</h4>
<div class="smallexample">
<pre class="smallexample">
BeginGroupIfMatch <var>quoted-regex</var>
</pre></div>
<p>The lines following, up to the first <code>EndGroup</code>
are executed if the quoted regular expression matches the current line. Edit groups may be nested.
</p>
<hr>
<a name="BeginGroupIfNoLineContaining"></a>
<div class="header">
<p>
Next: <a href="#BeginGroupIfNoLineMatching" accesskey="n" rel="next">BeginGroupIfNoLineMatching</a>, Previous: <a href="#BeginGroupIfMatch" accesskey="p" rel="previous">BeginGroupIfMatch</a>, Up: <a href="#editfiles" accesskey="u" rel="up">editfiles</a> [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Variable-Index" title="Index" rel="index">Index</a>]</p>
</div>
<a name="BeginGroupIfNoLineContaining-1"></a>
<h4 class="subsection">4.17.18 BeginGroupIfNoLineContaining</h4>
<div class="smallexample">
<pre class="smallexample">
BeginGroupIfNoLineContaining <var>quoted-string</var>
</pre></div>
<p>The lines following, up to the first <code>EndGroup</code>
are executed if the quoted string does not appear in
any line in the file. Edit groups may be nested.
</p>
<hr>
<a name="BeginGroupIfNoLineMatching"></a>
<div class="header">
<p>
Next: <a href="#BeginGroupIfNoMatch" accesskey="n" rel="next">BeginGroupIfNoMatch</a>, Previous: <a href="#BeginGroupIfNoLineContaining" accesskey="p" rel="previous">BeginGroupIfNoLineContaining</a>, Up: <a href="#editfiles" accesskey="u" rel="up">editfiles</a> [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Variable-Index" title="Index" rel="index">Index</a>]</p>
</div>
<a name="BeginGroupIfNoLineMatching-1"></a>
<h4 class="subsection">4.17.19 BeginGroupIfNoLineMatching</h4>
<div class="smallexample">
<pre class="smallexample">
BeginGroupIfNoLineMatching <var>quoted-regex</var>
</pre></div>
<p>The lines following, up to the first <code>EndGroup</code>
are executed if the quoted regular expression
does not match any line in the file. Edit groups may be nested.
</p>
<hr>
<a name="BeginGroupIfNoMatch"></a>
<div class="header">
<p>
Next: <a href="#BeginGroupIfNoSuchLine" accesskey="n" rel="next">BeginGroupIfNoSuchLine</a>, Previous: <a href="#BeginGroupIfNoLineMatching" accesskey="p" rel="previous">BeginGroupIfNoLineMatching</a>, Up: <a href="#editfiles" accesskey="u" rel="up">editfiles</a> [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Variable-Index" title="Index" rel="index">Index</a>]</p>
</div>
<a name="BeginGroupIfNoMatch-1"></a>
<h4 class="subsection">4.17.20 BeginGroupIfNoMatch</h4>
<div class="smallexample">
<pre class="smallexample">
BeginGroupIfNoMatch <var>quoted-regex</var>
</pre></div>
<p>The lines following, up to the first <code>EndGroup</code>
are executed if the quoted regular expression does
not match the current line. Edit groups may be nested.
</p>
<hr>
<a name="BeginGroupIfNoSuchLine"></a>
<div class="header">
<p>
Next: <a href="#BreakIfLineMatches" accesskey="n" rel="next">BreakIfLineMatches</a>, Previous: <a href="#BeginGroupIfNoMatch" accesskey="p" rel="previous">BeginGroupIfNoMatch</a>, Up: <a href="#editfiles" accesskey="u" rel="up">editfiles</a> [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Variable-Index" title="Index" rel="index">Index</a>]</p>
</div>
<a name="BeginGroupIfNoSuchLine-1"></a>
<h4 class="subsection">4.17.21 BeginGroupIfNoSuchLine</h4>
<div class="smallexample">
<pre class="smallexample">
BeginGroupIfNoSuchLine <var>quoted-string</var>
</pre></div>
<p>The lines following, up to the first <code>EndGroup</code>
are executed if the quoted literal string
does not match any line in the file. Edit groups may be nested.
</p>
<hr>
<a name="BreakIfLineMatches"></a>
<div class="header">
<p>
Next: <a href="#CatchAbort" accesskey="n" rel="next">CatchAbort</a>, Previous: <a href="#BeginGroupIfNoSuchLine" accesskey="p" rel="previous">BeginGroupIfNoSuchLine</a>, Up: <a href="#editfiles" accesskey="u" rel="up">editfiles</a> [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Variable-Index" title="Index" rel="index">Index</a>]</p>
</div>
<a name="BreakIfLineMatches-1"></a>
<h4 class="subsection">4.17.22 BreakIfLineMatches</h4>
<div class="smallexample">
<pre class="smallexample">
BreakIfLineMatches <var>quoted-regex</var>
</pre></div>
<p>Terminates further editing of the current
file if the current line matches the quoted
regular expression.
</p>
<hr>
<a name="CatchAbort"></a>
<div class="header">
<p>
Next: <a href="#CommentLinesMatching" accesskey="n" rel="next">CommentLinesMatching</a>, Previous: <a href="#BreakIfLineMatches" accesskey="p" rel="previous">BreakIfLineMatches</a>, Up: <a href="#editfiles" accesskey="u" rel="up">editfiles</a> [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Variable-Index" title="Index" rel="index">Index</a>]</p>
</div>
<a name="CatchAbort-1"></a>
<h4 class="subsection">4.17.23 CatchAbort</h4>
<a name="index-CatchAbort"></a>
<p>Edit actions which abort on failure (such as <code>LocateLineMatching</code>)
will jump to the first instance of this marker instead of completely
aborting an edit if this keyword occurs in an editing script.
You can catch the exceptions thrown by the following commands:
<code>CommentNLines</code>,<code>CommentToLineMatching</code>,<code>DeleteNLines</code>,<code>DeleteToLineMatching</code>,
<code>HashCommentToLineMatching</code>,<code>IncrementPointer</code>,
<code>LocateLineMatching</code>,<code>PercentCommentToLineMatching</code>,
<code>RunScriptIf(No)LineMatching</code>,<code>UnCommentNLines</code>.
</p>
<hr>
<a name="CommentLinesMatching"></a>
<div class="header">
<p>
Next: <a href="#CommentLinesStarting" accesskey="n" rel="next">CommentLinesStarting</a>, Previous: <a href="#CatchAbort" accesskey="p" rel="previous">CatchAbort</a>, Up: <a href="#editfiles" accesskey="u" rel="up">editfiles</a> [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Variable-Index" title="Index" rel="index">Index</a>]</p>
</div>
<a name="CommentLinesMatching-1"></a>
<h4 class="subsection">4.17.24 CommentLinesMatching</h4>
<div class="smallexample">
<pre class="smallexample">
CommentLinesMatching <var>quoted-regex</var>
</pre></div>
<p>Use the current value of the comment delimiters
set using <code>SetCommentStart</code> and <code>SetCommentEnd</code> to comment
out lines matching the given regular expression in quotes.
</p>
<hr>
<a name="CommentLinesStarting"></a>
<div class="header">
<p>
Next: <a href="#CommentNLines" accesskey="n" rel="next">CommentNLines</a>, Previous: <a href="#CommentLinesMatching" accesskey="p" rel="previous">CommentLinesMatching</a>, Up: <a href="#editfiles" accesskey="u" rel="up">editfiles</a> [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Variable-Index" title="Index" rel="index">Index</a>]</p>
</div>
<a name="CommentLinesStarting-1"></a>
<h4 class="subsection">4.17.25 CommentLinesStarting</h4>
<div class="smallexample">
<pre class="smallexample">
CommentLinesStarting <var>quoted-string</var>
</pre></div>
<p>Use the current value of the comment delimiters
set using <code>SetCommentStart</code> and <code>SetCommentEnd</code> to comment
out lines starting with the quoted literal string.
</p>
<hr>
<a name="CommentNLines"></a>
<div class="header">
<p>
Next: <a href="#CommentToLineMatching" accesskey="n" rel="next">CommentToLineMatching</a>, Previous: <a href="#CommentLinesStarting" accesskey="p" rel="previous">CommentLinesStarting</a>, Up: <a href="#editfiles" accesskey="u" rel="up">editfiles</a> [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Variable-Index" title="Index" rel="index">Index</a>]</p>
</div>
<a name="CommentNLines-1"></a>
<h4 class="subsection">4.17.26 CommentNLines</h4>
<div class="smallexample">
<pre class="smallexample">
CommentNLines <var>quoted-string</var>
</pre></div>
<p>Comments up to <em>N</em> lines from the current file, starting from the
location of the current line pointer. If the end of the file is reached
and less than <em>N</em> lines are deleted, a warning is issued, but
editing continues. The current value of the comment delimiters is
used to determine the method of commenting, (see <code>SetCommentStart</code>).
After the operation the pointer points to the line after the
commented lines.
</p>
<hr>
<a name="CommentToLineMatching"></a>
<div class="header">
<p>
Next: <a href="#DefineClasses" accesskey="n" rel="next">DefineClasses</a>, Previous: <a href="#CommentNLines" accesskey="p" rel="previous">CommentNLines</a>, Up: <a href="#editfiles" accesskey="u" rel="up">editfiles</a> [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Variable-Index" title="Index" rel="index">Index</a>]</p>
</div>
<a name="CommentToLineMatching-1"></a>
<h4 class="subsection">4.17.27 CommentToLineMatching</h4>
<div class="smallexample">
<pre class="smallexample">
CommentToLineMatching <var>quoted-regex</var>
</pre></div>
<p>Use the current value of the comment delimiters set using
<code>SetCommentStart</code> and <code>SetCommentEnd</code> to comment out lines
from the current position in a file to a line matching the given regular
expression in quotes.
</p>
<hr>
<a name="DefineClasses"></a>
<div class="header">
<p>
Next: <a href="#DefineInGroup" accesskey="n" rel="next">DefineInGroup</a>, Previous: <a href="#CommentToLineMatching" accesskey="p" rel="previous">CommentToLineMatching</a>, Up: <a href="#editfiles" accesskey="u" rel="up">editfiles</a> [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Variable-Index" title="Index" rel="index">Index</a>]</p>
</div>
<a name="DefineClasses-1"></a>
<h4 class="subsection">4.17.28 DefineClasses</h4>
<div class="smallexample">
<pre class="smallexample">
DefineClasses "<var>class1</var>:<var>class2</var>:..."
</pre></div>
<p>Activate the following colon, comma or dot-separated list of classes if
and only if the file is edited.
</p>
<hr>
<a name="DefineInGroup"></a>
<div class="header">
<p>
Next: <a href="#DeleteLinesAfterThisMatching" accesskey="n" rel="next">DeleteLinesAfterThisMatching</a>, Previous: <a href="#DefineClasses" accesskey="p" rel="previous">DefineClasses</a>, Up: <a href="#editfiles" accesskey="u" rel="up">editfiles</a> [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Variable-Index" title="Index" rel="index">Index</a>]</p>
</div>
<a name="DefineInGroup-1"></a>
<h4 class="subsection">4.17.29 DefineInGroup</h4>
<div class="smallexample">
<pre class="smallexample">
DefineInGroup "<var>class1</var>:<var>class2</var>:..."
</pre></div>
<p>Activate the following colon, comma or dot-separated list of classes if
the edit group is entered. This can be combined with other classes
to identify what particular edits took place.
Use DefineInGroup if you want to define a class or list of classes
conditional on entry to a BeginGroup ... EngGroup block. For example,
</p>
<div class="smallexample">
<pre class="smallexample">editfiles:
{ /etc/inetd.conf
BeginGroupIfNoSuchLine "$(myservice1)"
Append "$(myservice1)"
DefineInGroup "myservice1_added"
EndGroup
BeginGroupIfNoSuchLine "$(myservice2)"
Append "$(myservice2)"
DefineInGroup "myservice2_added"
EndGroup
}
</pre></div>
<p>This will define service_added and service_added_another_way if
either line is added, but additionally myservice1_added if myservice1
was added and likewise for myservice2_added.
</p>
<p>Activate the following colon, comma or dot-separated list of classes
if execution reaches the <code>BeginGroup</code> ... <code>EndGroup</code>
section(s) containing this command. If you think you want to put
DefineClasses within a <code>BeginGroup</code> ... <code>EndGroup</code> section,
you actually want this.
</p>
<hr>
<a name="DeleteLinesAfterThisMatching"></a>
<div class="header">
<p>
Next: <a href="#DeleteLinesContaining" accesskey="n" rel="next">DeleteLinesContaining</a>, Previous: <a href="#DefineInGroup" accesskey="p" rel="previous">DefineInGroup</a>, Up: <a href="#editfiles" accesskey="u" rel="up">editfiles</a> [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Variable-Index" title="Index" rel="index">Index</a>]</p>
</div>
<a name="DeleteLinesAfterThisMatching-1"></a>
<h4 class="subsection">4.17.30 DeleteLinesAfterThisMatching</h4>
<div class="smallexample">
<pre class="smallexample">
DeleteLinesAfterThisMatching <var>quoted-regex</var>
</pre></div>
<p>Delete lines after the current position which match the quoted expression.
</p>
<hr>
<a name="DeleteLinesContaining"></a>
<div class="header">
<p>
Next: <a href="#DeleteLinesMatching" accesskey="n" rel="next">DeleteLinesMatching</a>, Previous: <a href="#DeleteLinesAfterThisMatching" accesskey="p" rel="previous">DeleteLinesAfterThisMatching</a>, Up: <a href="#editfiles" accesskey="u" rel="up">editfiles</a> [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Variable-Index" title="Index" rel="index">Index</a>]</p>
</div>
<a name="DeleteLinesContaining_002fDeleteLinesNotContaining"></a>
<h4 class="subsection">4.17.31 DeleteLinesContaining/DeleteLinesNotContaining</h4>
<div class="smallexample">
<pre class="smallexample">
DeleteLinesContaining <var>quoted-string</var>
DeleteLinesNotContaining <var>quoted-string</var>
</pre></div>
<p>Delete all lines (not) containing the exact string quoted.
</p>
<hr>
<a name="DeleteLinesMatching"></a>
<div class="header">
<p>
Next: <a href="#DeleteLinesStarting" accesskey="n" rel="next">DeleteLinesStarting</a>, Previous: <a href="#DeleteLinesContaining" accesskey="p" rel="previous">DeleteLinesContaining</a>, Up: <a href="#editfiles" accesskey="u" rel="up">editfiles</a> [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Variable-Index" title="Index" rel="index">Index</a>]</p>
</div>
<a name="DeleteLinesMatching_002fDeleteLinesNotMatching"></a>
<h4 class="subsection">4.17.32 DeleteLinesMatching/DeleteLinesNotMatching</h4>
<div class="smallexample">
<pre class="smallexample">
DeleteLinesMatching <var>quoted-regex</var>
DeleteLinesNotMatching <var>quoted-regex</var>
</pre></div>
<p>Delete all lines (not) fully matching the tied quoted regular expression.
</p>
<hr>
<a name="DeleteLinesStarting"></a>
<div class="header">
<p>
Next: <a href="#DeleteLinesNotContaining" accesskey="n" rel="next">DeleteLinesNotContaining</a>, Previous: <a href="#DeleteLinesMatching" accesskey="p" rel="previous">DeleteLinesMatching</a>, Up: <a href="#editfiles" accesskey="u" rel="up">editfiles</a> [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Variable-Index" title="Index" rel="index">Index</a>]</p>
</div>
<a name="DeleteLinesStarting_002fDeleteLinesNotStarting"></a>
<h4 class="subsection">4.17.33 DeleteLinesStarting/DeleteLinesNotStarting</h4>
<div class="smallexample">
<pre class="smallexample">
DeleteLinesStarting <var>quoted-string</var>
DeleteLinesNotStarting <var>quoted-string</var>
</pre></div>
<p>Delete all lines (not) beginning with the exact string quoted.
</p>
<hr>
<a name="DeleteLinesNotContaining"></a>
<div class="header">
<p>
Next: <a href="#DeleteLinesNotMatchingFileItems" accesskey="n" rel="next">DeleteLinesNotMatchingFileItems</a>, Previous: <a href="#DeleteLinesStarting" accesskey="p" rel="previous">DeleteLinesStarting</a>, Up: <a href="#editfiles" accesskey="u" rel="up">editfiles</a> [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Variable-Index" title="Index" rel="index">Index</a>]</p>
</div>
<a name="DeleteLinesNotContainingFileItems"></a>
<h4 class="subsection">4.17.34 DeleteLinesNotContainingFileItems</h4>
<div class="smallexample">
<pre class="smallexample">
DeleteLinesNotContainingFileItems <var>filename</var>
</pre></div>
<p>Delete lines in the file that do not contain the any of the substrings in the file.
</p>
<hr>
<a name="DeleteLinesNotMatchingFileItems"></a>
<div class="header">
<p>
Next: <a href="#DeleteLinesNotStartingFileItems" accesskey="n" rel="next">DeleteLinesNotStartingFileItems</a>, Previous: <a href="#DeleteLinesNotContaining" accesskey="p" rel="previous">DeleteLinesNotContaining</a>, Up: <a href="#editfiles" accesskey="u" rel="up">editfiles</a> [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Variable-Index" title="Index" rel="index">Index</a>]</p>
</div>
<a name="DeleteLinesNotMatchingFileItems-1"></a>
<h4 class="subsection">4.17.35 DeleteLinesNotMatchingFileItems</h4>
<div class="smallexample">
<pre class="smallexample">
DeleteLinesNotMatchingFileItems <var>filename</var>
</pre></div>
<p>Delete lines in the file that do not match the any of the regular expressions in the file.
</p>
<hr>
<a name="DeleteLinesNotStartingFileItems"></a>
<div class="header">
<p>
Next: <a href="#DeleteNLines" accesskey="n" rel="next">DeleteNLines</a>, Previous: <a href="#DeleteLinesNotMatchingFileItems" accesskey="p" rel="previous">DeleteLinesNotMatchingFileItems</a>, Up: <a href="#editfiles" accesskey="u" rel="up">editfiles</a> [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Variable-Index" title="Index" rel="index">Index</a>]</p>
</div>
<a name="DeleteLinesNotStartingFileItems-1"></a>
<h4 class="subsection">4.17.36 DeleteLinesNotStartingFileItems</h4>
<div class="smallexample">
<pre class="smallexample">
DeleteLinesNotStartingFileItems <var>filename</var>
</pre></div>
<p>Delete lines in the file that do not start with any of the substrings in the file.
</p>
<hr>
<a name="DeleteNLines"></a>
<div class="header">
<p>
Next: <a href="#DeleteToLineMatching" accesskey="n" rel="next">DeleteToLineMatching</a>, Previous: <a href="#DeleteLinesNotStartingFileItems" accesskey="p" rel="previous">DeleteLinesNotStartingFileItems</a>, Up: <a href="#editfiles" accesskey="u" rel="up">editfiles</a> [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Variable-Index" title="Index" rel="index">Index</a>]</p>
</div>
<a name="DeleteNLines-1"></a>
<h4 class="subsection">4.17.37 DeleteNLines</h4>
<div class="smallexample">
<pre class="smallexample">
DeleteNLines <var>quoted-string</var>
</pre></div>
<p>Deletes up to <em>N</em> lines from the current file, starting from the
location of the current line pointer. If the end of the file is reached
and less than <em>N</em> lines are deleted, a warning is issued, but
editing continues.
</p>
<hr>
<a name="DeleteToLineMatching"></a>
<div class="header">
<p>
Next: <a href="#EditMode-_0028binary_0029" accesskey="n" rel="next">EditMode (binary)</a>, Previous: <a href="#DeleteNLines" accesskey="p" rel="previous">DeleteNLines</a>, Up: <a href="#editfiles" accesskey="u" rel="up">editfiles</a> [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Variable-Index" title="Index" rel="index">Index</a>]</p>
</div>
<a name="DeleteToLineMatching-1"></a>
<h4 class="subsection">4.17.38 DeleteToLineMatching</h4>
<div class="smallexample">
<pre class="smallexample">
DeleteToLineMatching <var>quoted-regex</var>
</pre></div>
<p>Delete lines from the current position, up to
but not including a line matching the regular expression
in the quoted string. If no line matches the
given expression, a warning is only printed in
verbose mode, but all edits are immediately
abandoned.
</p>
<hr>
<a name="EditMode-_0028binary_0029"></a>
<div class="header">
<p>
Next: <a href="#EditSplit" accesskey="n" rel="next">EditSplit</a>, Previous: <a href="#DeleteToLineMatching" accesskey="p" rel="previous">DeleteToLineMatching</a>, Up: <a href="#editfiles" accesskey="u" rel="up">editfiles</a> [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Variable-Index" title="Index" rel="index">Index</a>]</p>
</div>
<a name="EditMode-and-binary-editing"></a>
<h4 class="subsection">4.17.39 EditMode and binary editing</h4>
<p>If set to binary, the file will be edited as if it were a non-ASCII file.
See discussion below.
</p>
<div class="smallexample">
<pre class="smallexample">
EditMode "Binary"
</pre></div>
<hr>
<a name="EditSplit"></a>
<div class="header">
<p>
Next: <a href="#EmptyEntireFilePlease" accesskey="n" rel="next">EmptyEntireFilePlease</a>, Previous: <a href="#EditMode-_0028binary_0029" accesskey="p" rel="previous">EditMode (binary)</a>, Up: <a href="#editfiles" accesskey="u" rel="up">editfiles</a> [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Variable-Index" title="Index" rel="index">Index</a>]</p>
</div>
<a name="EditSplit-1"></a>
<h4 class="subsection">4.17.40 EditSplit</h4>
<p>Editfiles treats lists as private interpretations, since iteration over
lists could lead to unpredictable behaviour if text variables accidentally
contain the list separator. The control option <code>Split</code> therefore has
no effect on editfiles. This definition makes list expansion work in editfiles.
</p>
<div class="smallexample">
<pre class="smallexample">
EditSplit ","
</pre></div>
<a name="index-EditSplit"></a>
<a name="index-Split"></a>
<a name="index-Split-in-editfiles"></a>
<a name="index-Iteration-over-lists-_0028editfiles_0029"></a>
<p>Be careful not to confuse this with the <code>SplitOn</code> character.
</p>
<div class="smallexample">
<pre class="smallexample">
editfiles:
{ /tmp/bla1
EditSplit "!"
AppendIfNoSuchLine "alpha1!beta1"
EditSplit ":"
AppendIfNoSuchLine "alpha2!beta2"
EditSplit "@"
AppendIfNoSuchLine "alpha3@beta3"
}
{ /tmp/bla2
AppendIfNoSuchLine "new1@new2"
}
</pre></div>
<hr>
<a name="EmptyEntireFilePlease"></a>
<div class="header">
<p>
Next: <a href="#ElseDefineClasses" accesskey="n" rel="next">ElseDefineClasses</a>, Previous: <a href="#EditSplit" accesskey="p" rel="previous">EditSplit</a>, Up: <a href="#editfiles" accesskey="u" rel="up">editfiles</a> [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Variable-Index" title="Index" rel="index">Index</a>]</p>
</div>
<a name="EmptyEntireFilePlease-1"></a>
<h4 class="subsection">4.17.41 EmptyEntireFilePlease</h4>
<p>Deletes all lines from the current file.
</p>
<hr>
<a name="ElseDefineClasses"></a>
<div class="header">
<p>
Next: <a href="#EndGroup" accesskey="n" rel="next">EndGroup</a>, Previous: <a href="#EmptyEntireFilePlease" accesskey="p" rel="previous">EmptyEntireFilePlease</a>, Up: <a href="#editfiles" accesskey="u" rel="up">editfiles</a> [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Variable-Index" title="Index" rel="index">Index</a>]</p>
</div>
<a name="ElseDefineClasses-1"></a>
<h4 class="subsection">4.17.42 ElseDefineClasses</h4>
<p>See <code>DefineClasses</code>
</p>
<hr>
<a name="EndGroup"></a>
<div class="header">
<p>
Next: <a href="#EndLoop" accesskey="n" rel="next">EndLoop</a>, Previous: <a href="#ElseDefineClasses" accesskey="p" rel="previous">ElseDefineClasses</a>, Up: <a href="#editfiles" accesskey="u" rel="up">editfiles</a> [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Variable-Index" title="Index" rel="index">Index</a>]</p>
</div>
<a name="EndGroup-1"></a>
<h4 class="subsection">4.17.43 EndGroup</h4>
<p>Terminates a begin-end conditional structure.
</p>
<hr>
<a name="EndLoop"></a>
<div class="header">
<p>
Next: <a href="#ExpandVariables" accesskey="n" rel="next">ExpandVariables</a>, Previous: <a href="#EndGroup" accesskey="p" rel="previous">EndGroup</a>, Up: <a href="#editfiles" accesskey="u" rel="up">editfiles</a> [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Variable-Index" title="Index" rel="index">Index</a>]</p>
</div>
<a name="EndLoop-1"></a>
<h4 class="subsection">4.17.44 EndLoop</h4>
<p>Terminates a loop. See <code>ForEachLineIn</code>
</p>
<hr>
<a name="ExpandVariables"></a>
<div class="header">
<p>
Next: <a href="#ExpireAfter-editfiles" accesskey="n" rel="next">ExpireAfter editfiles</a>, Previous: <a href="#EndLoop" accesskey="p" rel="previous">EndLoop</a>, Up: <a href="#editfiles" accesskey="u" rel="up">editfiles</a> [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Variable-Index" title="Index" rel="index">Index</a>]</p>
</div>
<a name="ExpandVariables-1"></a>
<h4 class="subsection">4.17.45 ExpandVariables</h4>
<p>This causes cfengine to run through the contents of the file
and expand any recognisable editfile strings in the file, if they
are defined within the scope of the cfagent script. This gives
cfengine an m4 like capacity.
<a name="index-ExpandVariables"></a>
<a name="index-Templates"></a>
<a name="index-m4-functionality"></a>
</p>
<hr>
<a name="ExpireAfter-editfiles"></a>
<div class="header">
<p>
Next: <a href="#Filter" accesskey="n" rel="next">Filter</a>, Previous: <a href="#ExpandVariables" accesskey="p" rel="previous">ExpandVariables</a>, Up: <a href="#editfiles" accesskey="u" rel="up">editfiles</a> [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Variable-Index" title="Index" rel="index">Index</a>]</p>
</div>
<a name="ExpireAfter-editfiles-1"></a>
<h4 class="subsection">4.17.46 ExpireAfter editfiles</h4>
<div class="smallexample">
<pre class="smallexample">
ExpireAfter <var>mins</var>
</pre></div>
<hr>
<a name="Filter"></a>
<div class="header">
<p>
Next: <a href="#FixEndOfLine" accesskey="n" rel="next">FixEndOfLine</a>, Previous: <a href="#ExpireAfter-editfiles" accesskey="p" rel="previous">ExpireAfter editfiles</a>, Up: <a href="#editfiles" accesskey="u" rel="up">editfiles</a> [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Variable-Index" title="Index" rel="index">Index</a>]</p>
</div>
<a name="Filter-1"></a>
<h4 class="subsection">4.17.47 Filter</h4>
<p>Name a fiter for pruning file searches.
</p>
<div class="smallexample">
<pre class="smallexample">
Filter <var>filteralias</var>
</pre></div>
<hr>
<a name="FixEndOfLine"></a>
<div class="header">
<p>
Next: <a href="#ForEachLineIn" accesskey="n" rel="next">ForEachLineIn</a>, Previous: <a href="#Filter" accesskey="p" rel="previous">Filter</a>, Up: <a href="#editfiles" accesskey="u" rel="up">editfiles</a> [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Variable-Index" title="Index" rel="index">Index</a>]</p>
</div>
<a name="FixEndOfLine-1"></a>
<h4 class="subsection">4.17.48 FixEndOfLine</h4>
<p>The quoted string which follows may be either ‘<samp>dos</samp>’
or ‘<samp>Unix</samp>’ to fix the end of line character conventions
to match these systems. This command should be executed
last of all, since cfengine appends new lines with the conventions
of the system on which is was complied during edit operations.
</p>
<hr>
<a name="ForEachLineIn"></a>
<div class="header">
<p>
Next: <a href="#GotoLastLine" accesskey="n" rel="next">GotoLastLine</a>, Previous: <a href="#FixEndOfLine" accesskey="p" rel="previous">FixEndOfLine</a>, Up: <a href="#editfiles" accesskey="u" rel="up">editfiles</a> [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Variable-Index" title="Index" rel="index">Index</a>]</p>
</div>
<a name="ForEachLineIn-quoted_002dfilename"></a>
<h4 class="subsection">4.17.49 ForEachLineIn <var>quoted-filename</var></h4>
<div class="smallexample">
<pre class="smallexample">
ForEachLineIn <var>quoted-filename</var>
</pre></div>
<p>This marks the beginning of a for-loop which reads successive
lines from a named file. The result is like using <code>SetLine</code>
for each line in the file. Nested loops are not permitted.
</p>
<hr>
<a name="GotoLastLine"></a>
<div class="header">
<p>
Next: <a href="#HashCommentLinesContaining" accesskey="n" rel="next">HashCommentLinesContaining</a>, Previous: <a href="#ForEachLineIn" accesskey="p" rel="previous">ForEachLineIn</a>, Up: <a href="#editfiles" accesskey="u" rel="up">editfiles</a> [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Variable-Index" title="Index" rel="index">Index</a>]</p>
</div>
<a name="GotoLastLine-1"></a>
<h4 class="subsection">4.17.50 GotoLastLine</h4>
<p>Moves the file pointer to the last line in
the current file.
</p>
<hr>
<a name="HashCommentLinesContaining"></a>
<div class="header">
<p>
Next: <a href="#HashCommentLinesMatching" accesskey="n" rel="next">HashCommentLinesMatching</a>, Previous: <a href="#GotoLastLine" accesskey="p" rel="previous">GotoLastLine</a>, Up: <a href="#editfiles" accesskey="u" rel="up">editfiles</a> [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Variable-Index" title="Index" rel="index">Index</a>]</p>
</div>
<a name="HashCommentLinesContaining-1"></a>
<h4 class="subsection">4.17.51 HashCommentLinesContaining</h4>
<p>Add a ‘<samp>#</samp>’ to the start of any line containing the quoted string.
</p>
<div class="smallexample">
<pre class="smallexample">
HashCommentLinesContaining <var>quoted-string</var>
</pre></div>
<hr>
<a name="HashCommentLinesMatching"></a>
<div class="header">
<p>
Next: <a href="#HashCommentLinesStarting" accesskey="n" rel="next">HashCommentLinesStarting</a>, Previous: <a href="#HashCommentLinesContaining" accesskey="p" rel="previous">HashCommentLinesContaining</a>, Up: <a href="#editfiles" accesskey="u" rel="up">editfiles</a> [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Variable-Index" title="Index" rel="index">Index</a>]</p>
</div>
<a name="HashCommentLinesMatching-1"></a>
<h4 class="subsection">4.17.52 HashCommentLinesMatching</h4>
<p>Add a ‘<samp>#</samp>’ to the start of any line exactly matching the quoted regular expression.
</p>
<div class="smallexample">
<pre class="smallexample">
HashCommentLinesMatching <var>quoted-regex</var>
</pre></div>
<hr>
<a name="HashCommentLinesStarting"></a>
<div class="header">
<p>
Next: <a href="#IfElapsed-_0028editing_0029" accesskey="n" rel="next">IfElapsed (editing)</a>, Previous: <a href="#HashCommentLinesMatching" accesskey="p" rel="previous">HashCommentLinesMatching</a>, Up: <a href="#editfiles" accesskey="u" rel="up">editfiles</a> [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Variable-Index" title="Index" rel="index">Index</a>]</p>
</div>
<a name="HashCommentLinesStarting-1"></a>
<h4 class="subsection">4.17.53 HashCommentLinesStarting</h4>
<p>Add a ‘<samp>#</samp>’ to the start of any line starting with the quoted string.
</p>
<div class="smallexample">
<pre class="smallexample">
HashCommentLinesStarting <var>quoted-string</var>
</pre></div>
<hr>
<a name="IfElapsed-_0028editing_0029"></a>
<div class="header">
<p>
Next: <a href="#IncrementPointer" accesskey="n" rel="next">IncrementPointer</a>, Previous: <a href="#HashCommentLinesStarting" accesskey="p" rel="previous">HashCommentLinesStarting</a>, Up: <a href="#editfiles" accesskey="u" rel="up">editfiles</a> [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Variable-Index" title="Index" rel="index">Index</a>]</p>
</div>
<a name="IfElapsed"></a>
<h4 class="subsection">4.17.54 IfElapsed</h4>
<div class="smallexample">
<pre class="smallexample">
ExpireAfter <var>mins</var>
</pre></div>
<hr>
<a name="IncrementPointer"></a>
<div class="header">
<p>
Next: <a href="#Inform-_0028editing_0029" accesskey="n" rel="next">Inform (editing)</a>, Previous: <a href="#IfElapsed-_0028editing_0029" accesskey="p" rel="previous">IfElapsed (editing)</a>, Up: <a href="#editfiles" accesskey="u" rel="up">editfiles</a> [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Variable-Index" title="Index" rel="index">Index</a>]</p>
</div>
<a name="IncrementPointer-quoted_002dnumber"></a>
<h4 class="subsection">4.17.55 IncrementPointer <var>quoted-number</var></h4>
<div class="smallexample">
<pre class="smallexample">
IncrementPointer <var>quoted-number</var>
</pre></div>
<p>Increments the value (in lines) of the file pointer
by the number of lines specified in the quoted
string (as a denary number). e.g. ‘<samp>``4''</samp>’.
Negative values are equivalent to decrementing the
pointer. If a request is made to increment/decrement
outside of the file boundaries the pointer ‘bumps’
into the boundary and remains there, i.e. either at
start of file or end of file.
<a name="index-Incrementing-line-pointer-in-editfiles"></a>
<a name="index-Decrementing-line-pointer-in-editfiles"></a>
</p>
<hr>
<a name="Inform-_0028editing_0029"></a>
<div class="header">
<p>
Next: <a href="#InsertFile" accesskey="n" rel="next">InsertFile</a>, Previous: <a href="#IncrementPointer" accesskey="p" rel="previous">IncrementPointer</a>, Up: <a href="#editfiles" accesskey="u" rel="up">editfiles</a> [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Variable-Index" title="Index" rel="index">Index</a>]</p>
</div>
<a name="Inform-editfiles"></a>
<h4 class="subsection">4.17.56 Inform editfiles</h4>
<div class="smallexample">
<pre class="smallexample">
Inform <var>quoted-string</var>
</pre></div>
<p>Set to <code>true</code> or <code>false</code>, <code>on</code> or <code>off</code> to set the
inform level for this file. Default is <code>off</code>. Note that, owing to the
way that cfengine re-uses code, this feature does not work very
well. Detailed messages are not available, only a summary of whether
or not the file changed.
</p>
<hr>
<a name="InsertFile"></a>
<div class="header">
<p>
Next: <a href="#InsertLine" accesskey="n" rel="next">InsertLine</a>, Previous: <a href="#Inform-_0028editing_0029" accesskey="p" rel="previous">Inform (editing)</a>, Up: <a href="#editfiles" accesskey="u" rel="up">editfiles</a> [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Variable-Index" title="Index" rel="index">Index</a>]</p>
</div>
<a name="InsertFile-1"></a>
<h4 class="subsection">4.17.57 InsertFile</h4>
<div class="smallexample">
<pre class="smallexample">
InsertFile <var>quoted-string</var>
</pre></div>
<p>Inserts the named file after the current line position
in the file. This should be used in conjunction
with a begin-end construction in order to avoid
including the file every time cfengine is run.
If the file does not exist, or cannot be opened,
there is only a warning issued in verbose mode.
Note if the file is empty, or if the current line
pointer is not set, the file is inserted at the start
of the file.
</p>
<hr>
<a name="InsertLine"></a>
<div class="header">
<p>
Next: <a href="#LocateLineMatching" accesskey="n" rel="next">LocateLineMatching</a>, Previous: <a href="#InsertFile" accesskey="p" rel="previous">InsertFile</a>, Up: <a href="#editfiles" accesskey="u" rel="up">editfiles</a> [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Variable-Index" title="Index" rel="index">Index</a>]</p>
</div>
<a name="InsertLine-1"></a>
<h4 class="subsection">4.17.58 InsertLine</h4>
<div class="smallexample">
<pre class="smallexample">
InsertFile <var>quoted-string</var>
</pre></div>
<p>Inserts the quoted string as a line after the current
line pointer in the file. After the insert, the line
pointer is incremented by one so that subsequent
inserted lines are placed after the first.
This should probably be used in conjunction with the
conditional begin-end tests to avoid lines being
inserted on every run.
</p>
<hr>
<a name="LocateLineMatching"></a>
<div class="header">
<p>
Next: <a href="#PercentCommentLinesContaining" accesskey="n" rel="next">PercentCommentLinesContaining</a>, Previous: <a href="#InsertLine" accesskey="p" rel="previous">InsertLine</a>, Up: <a href="#editfiles" accesskey="u" rel="up">editfiles</a> [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Variable-Index" title="Index" rel="index">Index</a>]</p>
</div>
<a name="LocateLineMatching-1"></a>
<h4 class="subsection">4.17.59 LocateLineMatching</h4>
<div class="smallexample">
<pre class="smallexample">
LocateLineMatching <var>quoted-regex</var>
</pre></div>
<p>Moves the current line pointer to the line matching the
quoted regular expression. If there is no match, a
warning is only issued in verbose mode, but all
editing is immediately aborted. See also
<code>WarnIfNoLineMatching</code> so that you can get an
explicit warning, even out of verbose mode.
</p>
<hr>
<a name="PercentCommentLinesContaining"></a>
<div class="header">
<p>
Next: <a href="#PercentCommentLinesMatching" accesskey="n" rel="next">PercentCommentLinesMatching</a>, Previous: <a href="#LocateLineMatching" accesskey="p" rel="previous">LocateLineMatching</a>, Up: <a href="#editfiles" accesskey="u" rel="up">editfiles</a> [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Variable-Index" title="Index" rel="index">Index</a>]</p>
</div>
<a name="PercentCommentLinesContaining-1"></a>
<h4 class="subsection">4.17.60 PercentCommentLinesContaining</h4>
<div class="smallexample">
<pre class="smallexample">
PercentCommentLinesContaining <var>quoted-string</var>
</pre></div>
<p>Add a ‘<samp>%</samp>’ to the start of any line containing the quoted string.
</p>
<hr>
<a name="PercentCommentLinesMatching"></a>
<div class="header">
<p>
Next: <a href="#PercentCommentLinesStarting" accesskey="n" rel="next">PercentCommentLinesStarting</a>, Previous: <a href="#PercentCommentLinesContaining" accesskey="p" rel="previous">PercentCommentLinesContaining</a>, Up: <a href="#editfiles" accesskey="u" rel="up">editfiles</a> [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Variable-Index" title="Index" rel="index">Index</a>]</p>
</div>
<a name="PercentCommentLinesMatching-1"></a>
<h4 class="subsection">4.17.61 PercentCommentLinesMatching</h4>
<div class="smallexample">
<pre class="smallexample">
PercentCommentLinesMatching <var>quoted-regex</var>
</pre></div>
<p>Add a ‘<samp>%</samp>’ to the start of any line exactly matching the quoted regular.
</p>
<hr>
<a name="PercentCommentLinesStarting"></a>
<div class="header">
<p>
Next: <a href="#Prepend-_0028editing_0029" accesskey="n" rel="next">Prepend (editing)</a>, Previous: <a href="#PercentCommentLinesMatching" accesskey="p" rel="previous">PercentCommentLinesMatching</a>, Up: <a href="#editfiles" accesskey="u" rel="up">editfiles</a> [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Variable-Index" title="Index" rel="index">Index</a>]</p>
</div>
<a name="PercentCommentLinesStarting-1"></a>
<h4 class="subsection">4.17.62 PercentCommentLinesStarting</h4>
<div class="smallexample">
<pre class="smallexample">
PercentCommentLinesStarting <var>quoted-string</var>
</pre></div>
<p>Add a ‘<samp>%</samp>’ to the start of any line starting with the quoted string.
</p>
<hr>
<a name="Prepend-_0028editing_0029"></a>
<div class="header">
<p>
Next: <a href="#PrependIfNoLineMatching" accesskey="n" rel="next">PrependIfNoLineMatching</a>, Previous: <a href="#PercentCommentLinesStarting" accesskey="p" rel="previous">PercentCommentLinesStarting</a>, Up: <a href="#editfiles" accesskey="u" rel="up">editfiles</a> [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Variable-Index" title="Index" rel="index">Index</a>]</p>
</div>
<a name="Prepend"></a>
<h4 class="subsection">4.17.63 Prepend</h4>
<div class="smallexample">
<pre class="smallexample">
Prepend <var>quoted-string</var>
</pre></div>
<p>Add a line containing the quoted string to the start of the file.
This should be used in conjunction with the
decision structures <code>BeginGroupIfNoLineMatching</code> and
<code>BreakIfLineMatches</code>.
</p>
<hr>
<a name="PrependIfNoLineMatching"></a>
<div class="header">
<p>
Next: <a href="#PrependIfNoSuchLine" accesskey="n" rel="next">PrependIfNoSuchLine</a>, Previous: <a href="#Prepend-_0028editing_0029" accesskey="p" rel="previous">Prepend (editing)</a>, Up: <a href="#editfiles" accesskey="u" rel="up">editfiles</a> [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Variable-Index" title="Index" rel="index">Index</a>]</p>
</div>
<a name="PrependIfNoLineMatching-1"></a>
<h4 class="subsection">4.17.64 PrependIfNoLineMatching</h4>
<div class="smallexample">
<pre class="smallexample">
PrependIfNoLineMatching <var>quoted-regex</var>
</pre></div>
<p>A new version of the older <code>PrependIfNoSuchLine</code>
with uses a regular expression instead of a literal string.
The string prepended is the one set using <code>SetLine</code>.
</p>
<hr>
<a name="PrependIfNoSuchLine"></a>
<div class="header">
<p>
Next: <a href="#Recurse-_0028editing_0029" accesskey="n" rel="next">Recurse (editing)</a>, Previous: <a href="#PrependIfNoLineMatching" accesskey="p" rel="previous">PrependIfNoLineMatching</a>, Up: <a href="#editfiles" accesskey="u" rel="up">editfiles</a> [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Variable-Index" title="Index" rel="index">Index</a>]</p>
</div>
<a name="PrependIfNoSuchLine-1"></a>
<h4 class="subsection">4.17.65 PrependIfNoSuchLine</h4>
<div class="smallexample">
<pre class="smallexample">
PrependIfNoSuchLine <var>quoted-string</var>
</pre></div>
<p>Add a line containing the quoted string to the start of the file
if the file doesn’t contain the exact line already.
</p>
<hr>
<a name="Recurse-_0028editing_0029"></a>
<div class="header">
<p>
Next: <a href="#ReplaceLineWith" accesskey="n" rel="next">ReplaceLineWith</a>, Previous: <a href="#PrependIfNoSuchLine" accesskey="p" rel="previous">PrependIfNoSuchLine</a>, Up: <a href="#editfiles" accesskey="u" rel="up">editfiles</a> [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Variable-Index" title="Index" rel="index">Index</a>]</p>
</div>
<a name="Recurse"></a>
<h4 class="subsection">4.17.66 Recurse</h4>
<div class="smallexample">
<pre class="smallexample">
Recurse <var>digit/inf</var>
</pre></div>
<p>For recursive descents when editing whole file trees.
</p>
<hr>
<a name="ReplaceLineWith"></a>
<div class="header">
<p>
Next: <a href="#ReplaceAll-With" accesskey="n" rel="next">ReplaceAll With</a>, Previous: <a href="#Recurse-_0028editing_0029" accesskey="p" rel="previous">Recurse (editing)</a>, Up: <a href="#editfiles" accesskey="u" rel="up">editfiles</a> [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Variable-Index" title="Index" rel="index">Index</a>]</p>
</div>
<a name="ReplaceLineWith-1"></a>
<h4 class="subsection">4.17.67 ReplaceLineWith</h4>
<div class="smallexample">
<pre class="smallexample">
ReplaceLineWith <var>quoted-string</var>
</pre></div>
<p>Replace the line at the current position with the
text in the quoted string. The file pointer remains
pointing to this line after the change.
</p>
<hr>
<a name="ReplaceAll-With"></a>
<div class="header">
<p>
Next: <a href="#ReplaceFirst" accesskey="n" rel="next">ReplaceFirst</a>, Previous: <a href="#ReplaceLineWith" accesskey="p" rel="previous">ReplaceLineWith</a>, Up: <a href="#editfiles" accesskey="u" rel="up">editfiles</a> [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Variable-Index" title="Index" rel="index">Index</a>]</p>
</div>
<a name="ReplaceAll_002fWith"></a>
<h4 class="subsection">4.17.68 ReplaceAll/With</h4>
<div class="smallexample">
<pre class="smallexample">
ReplaceAll <var>quoted-regex</var> With <var>quoted-string</var>
</pre></div>
<p>Replace all instances of strings matching the regular expression in the
first quotes with the exact string in the second set of quotes,
throughout the current file. Note that cfengine matches on a left to
right basis, with the first match taking precedence, so if your regular
expression matches text ambiguously it is the first occurrence which is
replaced. For example, if you replace ‘<samp>cf.*</samp>’ with ‘<samp>CFENGINE</samp>’
and cfengine encounters a line ‘<samp>hello cfengine cfengine</samp>’, then this
will be replaced with ‘<samp>hello CFENGINE</samp>’ even though two possible
strings match the regular expression. On the other hand if the
expression is not ambiguous, say replacing ‘<samp>cfengine</samp>’ with
‘<samp>CFENGINE</samp>’, then the result would be ‘<samp>hello CFENGINE CFENGINE</samp>’.
</p>
<hr>
<a name="ReplaceFirst"></a>
<div class="header">
<p>
Next: <a href="#ReplaceLinesMatchingField" accesskey="n" rel="next">ReplaceLinesMatchingField</a>, Previous: <a href="#ReplaceAll-With" accesskey="p" rel="previous">ReplaceAll With</a>, Up: <a href="#editfiles" accesskey="u" rel="up">editfiles</a> [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Variable-Index" title="Index" rel="index">Index</a>]</p>
</div>
<a name="ReplaceFirst_002fWith"></a>
<h4 class="subsection">4.17.69 ReplaceFirst/With</h4>
<div class="smallexample">
<pre class="smallexample">
ReplaceFirst <var>quoted-regex</var> With <var>quoted-string</var>
</pre></div>
<p>For each line of the current file, replace the first string matching the
regular expression in the first quotes (<var>quoted-regex</var>) with the
string given in the second set of quotes (<var>quoted-string</var>).
Matching is done left to right. For example, if you replace
‘<samp>``YY = [[:digit:]][[:digit:]]''</samp>’ with ‘<samp>``YY = 04''</samp>’ and
cfengine encounters ‘<samp>``YY = 03 but old YY = 70''</samp>’ then it will
be replaced with ‘<samp>``YY = 04 but old YY = 70''</samp>’
</p>
<hr>
<a name="ReplaceLinesMatchingField"></a>
<div class="header">
<p>
Next: <a href="#Repository" accesskey="n" rel="next">Repository</a>, Previous: <a href="#ReplaceFirst" accesskey="p" rel="previous">ReplaceFirst</a>, Up: <a href="#editfiles" accesskey="u" rel="up">editfiles</a> [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Variable-Index" title="Index" rel="index">Index</a>]</p>
</div>
<a name="ReplaceLinesMatchingField-1"></a>
<h4 class="subsection">4.17.70 ReplaceLinesMatchingField</h4>
<div class="smallexample">
<pre class="smallexample">
ReplaceLinesMatchingField <var>quoted-number</var>
</pre></div>
<p>This command replaces any lines in the current file with the current line
set by <code>SetLine</code> or <code>ForEachLineIn</code>, if the lines
are split into fields (e.g. the password file) separated by the
<code>SplitOn</code> character (’:’ by default), and the corresponding
fields match.
</p>
<p>The idea behind this command was to be able to override global
passwords (from a file which gets distributed) by new passwords
in a local file. Rather than maintaining the files separately,
this simply overrides the entries with the new ones.
</p>
<hr>
<a name="Repository"></a>
<div class="header">
<p>
Next: <a href="#ResetSearch" accesskey="n" rel="next">ResetSearch</a>, Previous: <a href="#ReplaceLinesMatchingField" accesskey="p" rel="previous">ReplaceLinesMatchingField</a>, Up: <a href="#editfiles" accesskey="u" rel="up">editfiles</a> [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Variable-Index" title="Index" rel="index">Index</a>]</p>
</div>
<a name="Repository-editfiles"></a>
<h4 class="subsection">4.17.71 Repository editfiles</h4>
<div class="smallexample">
<pre class="smallexample">
Repository <var>quoted string</var>
</pre></div>
<p>This allows a local override of the <code>Repository</code> variable, on an item
by item basis. If set to “off” or “none” it cancels the value of a global repository.
</p>
<p>See <a href="#copybackup">copybackup</a>.
See <a href="#Backup-in-editfiles">Backup in editfiles</a>.
</p>
<hr>
<a name="ResetSearch"></a>
<div class="header">
<p>
Next: <a href="#RunScript" accesskey="n" rel="next">RunScript</a>, Previous: <a href="#Repository" accesskey="p" rel="previous">Repository</a>, Up: <a href="#editfiles" accesskey="u" rel="up">editfiles</a> [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Variable-Index" title="Index" rel="index">Index</a>]</p>
</div>
<a name="ResetSearch-1"></a>
<h4 class="subsection">4.17.72 ResetSearch</h4>
<div class="smallexample">
<pre class="smallexample">
ResetSearch <var>quoted-string</var>
</pre></div>
<p>Sets the current-position pointer to the line number
in the quoted string. ‘<samp>EOF</samp>’ indicates the end of
the file.
</p>
<hr>
<a name="RunScript"></a>
<div class="header">
<p>
Next: <a href="#RunScriptIfLineMatching" accesskey="n" rel="next">RunScriptIfLineMatching</a>, Previous: <a href="#ResetSearch" accesskey="p" rel="previous">ResetSearch</a>, Up: <a href="#editfiles" accesskey="u" rel="up">editfiles</a> [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Variable-Index" title="Index" rel="index">Index</a>]</p>
</div>
<a name="RunScript-1"></a>
<h4 class="subsection">4.17.73 RunScript</h4>
<div class="smallexample">
<pre class="smallexample">
RunScript <var>quoted-string</var>
</pre></div>
<p>Executes the named script command. Before executing the script any edits
are saved to disk. After the script has executed,
cfengine reloads the file for any further editing
operations. The script (which may be any executable
program) is appended with two arguments: the name of the
file which is being edited and the system hard class
(e.g. sun4, ultrix etc.) of the system executing
the script.
</p>
<p>CAUTION: cfengine knows nothing about
the success or failure of anything that is done during the
execution of user scripts. This feature is to be
used at the users own peril!
</p>
<hr>
<a name="RunScriptIfLineMatching"></a>
<div class="header">
<p>
Next: <a href="#RunScriptIfNoLineMatching" accesskey="n" rel="next">RunScriptIfNoLineMatching</a>, Previous: <a href="#RunScript" accesskey="p" rel="previous">RunScript</a>, Up: <a href="#editfiles" accesskey="u" rel="up">editfiles</a> [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Variable-Index" title="Index" rel="index">Index</a>]</p>
</div>
<a name="RunScriptIfLineMatching-1"></a>
<h4 class="subsection">4.17.74 RunScriptIfLineMatching</h4>
<div class="smallexample">
<pre class="smallexample">
RunScriptIfLineMatching <var>quoted-string</var>
</pre></div>
<p>Executes the script named with the <code>SetScript</code>
command only if the current file contains a line matching
the quoted regular expression.
</p>
<p>CAUTION: cfengine knows nothing about
the success or failure of anything that is done during the
execution of user scripts. This feature is to be
used at the users own peril!
</p>
<hr>
<a name="RunScriptIfNoLineMatching"></a>
<div class="header">
<p>
Next: <a href="#SetCommentStart" accesskey="n" rel="next">SetCommentStart</a>, Previous: <a href="#RunScriptIfLineMatching" accesskey="p" rel="previous">RunScriptIfLineMatching</a>, Up: <a href="#editfiles" accesskey="u" rel="up">editfiles</a> [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Variable-Index" title="Index" rel="index">Index</a>]</p>
</div>
<a name="RunScriptIfNoLineMatching-1"></a>
<h4 class="subsection">4.17.75 RunScriptIfNoLineMatching</h4>
<div class="smallexample">
<pre class="smallexample">
RunScriptIfNoLineMatching <var>quoted-regex</var>
</pre></div>
<p>Executes the script named with the <code>SetScript</code>
command if the current file contains no line matching
the quoted regular expression.
</p>
<p>CAUTION: cfengine knows nothing about
the success or failure of anything that is done during the
execution of user scripts. This feature is to be
used at the users own peril!
</p>
<hr>
<a name="SetCommentStart"></a>
<div class="header">
<p>
Next: <a href="#SetCommentEnd" accesskey="n" rel="next">SetCommentEnd</a>, Previous: <a href="#RunScriptIfNoLineMatching" accesskey="p" rel="previous">RunScriptIfNoLineMatching</a>, Up: <a href="#editfiles" accesskey="u" rel="up">editfiles</a> [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Variable-Index" title="Index" rel="index">Index</a>]</p>
</div>
<a name="SetCommentStart-1"></a>
<h4 class="subsection">4.17.76 SetCommentStart</h4>
<div class="smallexample">
<pre class="smallexample">
SetCommentStart <var>quoted-string</var>
</pre></div>
<p>Specify which string should be used for starting
a comment using the commands <code>CommentLineMatching</code>
and <code>CommentLineStarting</code>. The default is the hash
symbol ‘<samp>#</samp>’ followed by a single space.
</p>
<hr>
<a name="SetCommentEnd"></a>
<div class="header">
<p>
Next: <a href="#SetLine" accesskey="n" rel="next">SetLine</a>, Previous: <a href="#SetCommentStart" accesskey="p" rel="previous">SetCommentStart</a>, Up: <a href="#editfiles" accesskey="u" rel="up">editfiles</a> [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Variable-Index" title="Index" rel="index">Index</a>]</p>
</div>
<a name="SetCommentEnd-1"></a>
<h4 class="subsection">4.17.77 SetCommentEnd</h4>
<div class="smallexample">
<pre class="smallexample">
SetCommentEnd <var>quoted-string</var>
</pre></div>
<p>Specify which string should be used for ending
a comment using the commands <code>CommentLineMatching</code>
and <code>CommentLineStarting</code>. The default is the empty
string. For example, you could make C style comments
by setting CommentStart to ‘<samp>/*</samp>’ and comment
end to ‘<samp>*/</samp>’.
</p>
<hr>
<a name="SetLine"></a>
<div class="header">
<p>
Next: <a href="#SetScript" accesskey="n" rel="next">SetScript</a>, Previous: <a href="#SetCommentEnd" accesskey="p" rel="previous">SetCommentEnd</a>, Up: <a href="#editfiles" accesskey="u" rel="up">editfiles</a> [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Variable-Index" title="Index" rel="index">Index</a>]</p>
</div>
<a name="SetLine-1"></a>
<h4 class="subsection">4.17.78 SetLine</h4>
<div class="smallexample">
<pre class="smallexample">
SetLine <var>quoted-string</var>
</pre></div>
<p>Sets a current line value which can be appended using
<code>AppendIfNoLineMatching</code> using a regular expression.
</p>
<hr>
<a name="SetScript"></a>
<div class="header">
<p>
Next: <a href="#SlashCommentLinesContaining" accesskey="n" rel="next">SlashCommentLinesContaining</a>, Previous: <a href="#SetLine" accesskey="p" rel="previous">SetLine</a>, Up: <a href="#editfiles" accesskey="u" rel="up">editfiles</a> [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Variable-Index" title="Index" rel="index">Index</a>]</p>
</div>
<a name="SetScript-1"></a>
<h4 class="subsection">4.17.79 SetScript</h4>
<div class="smallexample">
<pre class="smallexample">
SetScript <var>quoted-string</var>
</pre></div>
<p>Sets the name of a user-supplied script
for editing the current file.
</p>
<hr>
<a name="SlashCommentLinesContaining"></a>
<div class="header">
<p>
Next: <a href="#SlashCommentLinesMatching" accesskey="n" rel="next">SlashCommentLinesMatching</a>, Previous: <a href="#SetScript" accesskey="p" rel="previous">SetScript</a>, Up: <a href="#editfiles" accesskey="u" rel="up">editfiles</a> [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Variable-Index" title="Index" rel="index">Index</a>]</p>
</div>
<a name="SlashCommentLinesContaining-1"></a>
<h4 class="subsection">4.17.80 SlashCommentLinesContaining</h4>
<div class="smallexample">
<pre class="smallexample">
SlashCommentLinesContaining <var>quoted-string</var>
</pre></div>
<p>Add a ‘<samp>//</samp>’ to the start of any line containing the quoted string.
</p>
<hr>
<a name="SlashCommentLinesMatching"></a>
<div class="header">
<p>
Next: <a href="#SlashCommentLinesStarting" accesskey="n" rel="next">SlashCommentLinesStarting</a>, Previous: <a href="#SlashCommentLinesContaining" accesskey="p" rel="previous">SlashCommentLinesContaining</a>, Up: <a href="#editfiles" accesskey="u" rel="up">editfiles</a> [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Variable-Index" title="Index" rel="index">Index</a>]</p>
</div>
<a name="SlashCommentLinesMatching-1"></a>
<h4 class="subsection">4.17.81 SlashCommentLinesMatching</h4>
<div class="smallexample">
<pre class="smallexample">
SlashCommentLinesMatching <var>quoted-regex</var>
</pre></div>
<p>Add a ‘<samp>//</samp>’ to the start of any line exactly matching the quoted regular expression.
</p>
<hr>
<a name="SlashCommentLinesStarting"></a>
<div class="header">
<p>
Next: <a href="#SplitOn" accesskey="n" rel="next">SplitOn</a>, Previous: <a href="#SlashCommentLinesMatching" accesskey="p" rel="previous">SlashCommentLinesMatching</a>, Up: <a href="#editfiles" accesskey="u" rel="up">editfiles</a> [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Variable-Index" title="Index" rel="index">Index</a>]</p>
</div>
<a name="SlashCommentLinesStarting-1"></a>
<h4 class="subsection">4.17.82 SlashCommentLinesStarting</h4>
<div class="smallexample">
<pre class="smallexample">
SlashCommentLinesStarting <var>quoted-string</var>
</pre></div>
<p>Add a ‘<samp>//</samp>’ to the start of any line starting with the quoted string.
</p>
<hr>
<a name="SplitOn"></a>
<div class="header">
<p>
Next: <a href="#SysLog" accesskey="n" rel="next">SysLog</a>, Previous: <a href="#SlashCommentLinesStarting" accesskey="p" rel="previous">SlashCommentLinesStarting</a>, Up: <a href="#editfiles" accesskey="u" rel="up">editfiles</a> [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Variable-Index" title="Index" rel="index">Index</a>]</p>
</div>
<a name="SplitOn-1"></a>
<h4 class="subsection">4.17.83 SplitOn</h4>
<div class="smallexample">
<pre class="smallexample">
SplitOn <var>quoted-string</var>
</pre></div>
<p>This defines a single character which is to be interpreted as a
field separator for editing files with columns. The default value
for this is ‘<samp>:</samp>’, as is used in the password and group files.
It is used in conjunction with <code>ReplaceLinesMatchingField</code>.
Note, be careful not to confuse this with the <code>EditSplit</code> character.
<a name="index-SplitOn"></a>
<a name="index-Password-file_002c-editing"></a>
<a name="index-Group-field_002c-editing"></a>
<a name="index-Field-separator-in-editfiles"></a>
</p>
<hr>
<a name="SysLog"></a>
<div class="header">
<p>
Next: <a href="#Umask" accesskey="n" rel="next">Umask</a>, Previous: <a href="#SplitOn" accesskey="p" rel="previous">SplitOn</a>, Up: <a href="#editfiles" accesskey="u" rel="up">editfiles</a> [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Variable-Index" title="Index" rel="index">Index</a>]</p>
</div>
<a name="Syslog-editfiles"></a>
<h4 class="subsection">4.17.84 Syslog editfiles</h4>
<p>Set to true or false, on or off to set inform level for this file.
Default is off.
</p>
<div class="smallexample">
<pre class="smallexample">
Syslog <var>quoted-string</var>
</pre></div>
<hr>
<a name="Umask"></a>
<div class="header">
<p>
Next: <a href="#UnCommentLinesContaining" accesskey="n" rel="next">UnCommentLinesContaining</a>, Previous: <a href="#SysLog" accesskey="p" rel="previous">SysLog</a>, Up: <a href="#editfiles" accesskey="u" rel="up">editfiles</a> [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Variable-Index" title="Index" rel="index">Index</a>]</p>
</div>
<a name="Umask-1"></a>
<h4 class="subsection">4.17.85 Umask</h4>
<div class="smallexample">
<pre class="smallexample">
<var>quote mode</var>
</pre></div>
<p>Set local umask for file creation and script execution.
<a name="index-umask"></a>
</p>
<hr>
<a name="UnCommentLinesContaining"></a>
<div class="header">
<p>
Next: <a href="#UnCommentLinesMatching" accesskey="n" rel="next">UnCommentLinesMatching</a>, Previous: <a href="#Umask" accesskey="p" rel="previous">Umask</a>, Up: <a href="#editfiles" accesskey="u" rel="up">editfiles</a> [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Variable-Index" title="Index" rel="index">Index</a>]</p>
</div>
<a name="UnCommentLinesContaining-1"></a>
<h4 class="subsection">4.17.86 UnCommentLinesContaining</h4>
<div class="smallexample">
<pre class="smallexample"> UnCommentLinesContaining <var>quoted-string</var>
</pre></div>
<p>Uncomment all lines in file containing the quoted string as a
substring. The comment delimiters are assumed to be those
set using SetCommentStart and SetCommentEnd.
</p>
<hr>
<a name="UnCommentLinesMatching"></a>
<div class="header">
<p>
Next: <a href="#UnCommentsNLines" accesskey="n" rel="next">UnCommentsNLines</a>, Previous: <a href="#UnCommentLinesContaining" accesskey="p" rel="previous">UnCommentLinesContaining</a>, Up: <a href="#editfiles" accesskey="u" rel="up">editfiles</a> [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Variable-Index" title="Index" rel="index">Index</a>]</p>
</div>
<a name="UnCommentLinesMatching-1"></a>
<h4 class="subsection">4.17.87 UnCommentLinesMatching</h4>
<div class="smallexample">
<pre class="smallexample">
UnCommentLinesMatching <var>quoted-regex</var>
</pre></div>
<p>Uncomment all lines in file matching the quoted regular expression. The
comment delimiters are assumed to be those set using SetCommentStart and
SetCommentEnd.
</p>
<hr>
<a name="UnCommentsNLines"></a>
<div class="header">
<p>
Next: <a href="#UnCommentToLineMatching" accesskey="n" rel="next">UnCommentToLineMatching</a>, Previous: <a href="#UnCommentLinesMatching" accesskey="p" rel="previous">UnCommentLinesMatching</a>, Up: <a href="#editfiles" accesskey="u" rel="up">editfiles</a> [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Variable-Index" title="Index" rel="index">Index</a>]</p>
</div>
<a name="UnCommentNLines"></a>
<h4 class="subsection">4.17.88 UnCommentNLines</h4>
<div class="smallexample">
<pre class="smallexample">
UnCommentNLines <var>quoted-string</var>
</pre></div>
<p>Uncomments N lines starting from the current position, using
the currently defined method for commenting. Note that the
comment start and end symbols are removed independently, i.e.
they are not matched, so that a comment may be spread over
several lines. e.g. If using C style ‘<samp>/*</samp>’ and ‘<samp>*/</samp>’
comments, the command <code>UnCommentNLines "3"</code> would
uncomment
</p>
<div class="smallexample">
<pre class="smallexample"> /* 1 */
/* 2 */
/* 3 */
</pre></div>
<p>and also
</p>
<div class="smallexample">
<pre class="smallexample"> /* 1
2
3 */
</pre></div>
<hr>
<a name="UnCommentToLineMatching"></a>
<div class="header">
<p>
Next: <a href="#UnsetAbort" accesskey="n" rel="next">UnsetAbort</a>, Previous: <a href="#UnCommentsNLines" accesskey="p" rel="previous">UnCommentsNLines</a>, Up: <a href="#editfiles" accesskey="u" rel="up">editfiles</a> [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Variable-Index" title="Index" rel="index">Index</a>]</p>
</div>
<a name="UnCommentToLineMatching-1"></a>
<h4 class="subsection">4.17.89 UnCommentToLineMatching</h4>
<div class="smallexample">
<pre class="smallexample">
UnCommentToLineMatching <var>quoted-string</var>
</pre></div>
<p>Uncomments from the current position up to and including the first
line matching the named regular expression.
</p>
<hr>
<a name="UnsetAbort"></a>
<div class="header">
<p>
Next: <a href="#UseShell" accesskey="n" rel="next">UseShell</a>, Previous: <a href="#UnCommentToLineMatching" accesskey="p" rel="previous">UnCommentToLineMatching</a>, Up: <a href="#editfiles" accesskey="u" rel="up">editfiles</a> [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Variable-Index" title="Index" rel="index">Index</a>]</p>
</div>
<a name="UnsetAbort-1"></a>
<h4 class="subsection">4.17.90 UnsetAbort</h4>
<p>Switches off the feature <code>AbortAtLineMatching</code>.
</p>
<div class="smallexample">
<pre class="smallexample">
UnsetAbort <var>quoted-string</var>
</pre></div>
<hr>
<a name="UseShell"></a>
<div class="header">
<p>
Next: <a href="#WarnIfFileMissing" accesskey="n" rel="next">WarnIfFileMissing</a>, Previous: <a href="#UnsetAbort" accesskey="p" rel="previous">UnsetAbort</a>, Up: <a href="#editfiles" accesskey="u" rel="up">editfiles</a> [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Variable-Index" title="Index" rel="index">Index</a>]</p>
</div>
<a name="UseShell-1"></a>
<h4 class="subsection">4.17.91 UseShell</h4>
<p>Normally cfengine uses a shell based exec function to run
scripts during editing. This involves the inheritance of
environment variables and path, which carries with it an
inherent security risk. Setting this value to false
causes execution to execute without an encapsulating shell.
</p>
<hr>
<a name="WarnIfFileMissing"></a>
<div class="header">
<p>
Next: <a href="#WarnIfLineContaining" accesskey="n" rel="next">WarnIfLineContaining</a>, Previous: <a href="#UseShell" accesskey="p" rel="previous">UseShell</a>, Up: <a href="#editfiles" accesskey="u" rel="up">editfiles</a> [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Variable-Index" title="Index" rel="index">Index</a>]</p>
</div>
<a name="WarnIfFileMissing-1"></a>
<h4 class="subsection">4.17.92 WarnIfFileMissing</h4>
<p>If the file to be edited does not exist, a visible alert
is issued.
</p>
<div class="smallexample">
<pre class="smallexample">
WarnIfFileMissing <var>quoted-string</var>
</pre></div>
<hr>
<a name="WarnIfLineContaining"></a>
<div class="header">
<p>
Next: <a href="#WarnIfLineMatching" accesskey="n" rel="next">WarnIfLineMatching</a>, Previous: <a href="#WarnIfFileMissing" accesskey="p" rel="previous">WarnIfFileMissing</a>, Up: <a href="#editfiles" accesskey="u" rel="up">editfiles</a> [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Variable-Index" title="Index" rel="index">Index</a>]</p>
</div>
<a name="WarnIfLineContaining-1"></a>
<h4 class="subsection">4.17.93 WarnIfLineContaining</h4>
<p>Issue a warning if the quoted string is found as a
substring of one or more lines in the file.
</p>
<div class="smallexample">
<pre class="smallexample">
WarnIfLineContaining <var>quoted-string</var>
</pre></div>
<hr>
<a name="WarnIfLineMatching"></a>
<div class="header">
<p>
Next: <a href="#WarnIfLineStarting" accesskey="n" rel="next">WarnIfLineStarting</a>, Previous: <a href="#WarnIfLineContaining" accesskey="p" rel="previous">WarnIfLineContaining</a>, Up: <a href="#editfiles" accesskey="u" rel="up">editfiles</a> [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Variable-Index" title="Index" rel="index">Index</a>]</p>
</div>
<a name="WarnIfLineMatching-1"></a>
<h4 class="subsection">4.17.94 WarnIfLineMatching</h4>
<div class="smallexample">
<pre class="smallexample">
WarnIfLineMatching <var>quoted-regex</var>
</pre></div>
<p>Issue a warning if the quoted regular expression
matches one or more lines in the file.
</p>
<hr>
<a name="WarnIfLineStarting"></a>
<div class="header">
<p>
Next: <a href="#WarnIfNoLineContaining" accesskey="n" rel="next">WarnIfNoLineContaining</a>, Previous: <a href="#WarnIfLineMatching" accesskey="p" rel="previous">WarnIfLineMatching</a>, Up: <a href="#editfiles" accesskey="u" rel="up">editfiles</a> [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Variable-Index" title="Index" rel="index">Index</a>]</p>
</div>
<a name="WarnIfLineStarting-1"></a>
<h4 class="subsection">4.17.95 WarnIfLineStarting</h4>
<div class="smallexample">
<pre class="smallexample">
WarnIfLineStarting <var>quoted-string</var>
</pre></div>
<p>Issue a warning if the quoted string matches the start
of one or more lines in the file.
</p>
<hr>
<a name="WarnIfNoLineContaining"></a>
<div class="header">
<p>
Next: <a href="#WarnIfNoLineMatching" accesskey="n" rel="next">WarnIfNoLineMatching</a>, Previous: <a href="#WarnIfLineStarting" accesskey="p" rel="previous">WarnIfLineStarting</a>, Up: <a href="#editfiles" accesskey="u" rel="up">editfiles</a> [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Variable-Index" title="Index" rel="index">Index</a>]</p>
</div>
<a name="WarnIfNoLineContaining-1"></a>
<h4 class="subsection">4.17.96 WarnIfNoLineContaining</h4>
<div class="smallexample">
<pre class="smallexample">
WarnIfNoLineContaining <var>quoted-string</var>
</pre></div>
<p>Issue a warning if the quoted string is not contained
in one or more lines in the file.
</p>
<hr>
<a name="WarnIfNoLineMatching"></a>
<div class="header">
<p>
Next: <a href="#WarnIfNoLineStarting" accesskey="n" rel="next">WarnIfNoLineStarting</a>, Previous: <a href="#WarnIfNoLineContaining" accesskey="p" rel="previous">WarnIfNoLineContaining</a>, Up: <a href="#editfiles" accesskey="u" rel="up">editfiles</a> [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Variable-Index" title="Index" rel="index">Index</a>]</p>
</div>
<a name="WarnIfNoLineMatching-1"></a>
<h4 class="subsection">4.17.97 WarnIfNoLineMatching</h4>
<div class="smallexample">
<pre class="smallexample">
WarnIfNoLineMatching <var>reg-ex</var>
</pre></div>
<p>Issue a warning if the quoted regular expression does not match
one or more lines in the file.
</p>
<hr>
<a name="WarnIfNoLineStarting"></a>
<div class="header">
<p>
Next: <a href="#WarnIfNoSuchLine" accesskey="n" rel="next">WarnIfNoSuchLine</a>, Previous: <a href="#WarnIfNoLineMatching" accesskey="p" rel="previous">WarnIfNoLineMatching</a>, Up: <a href="#editfiles" accesskey="u" rel="up">editfiles</a> [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Variable-Index" title="Index" rel="index">Index</a>]</p>
</div>
<a name="WarnIfNoLineStarting-1"></a>
<h4 class="subsection">4.17.98 WarnIfNoLineStarting</h4>
<div class="smallexample">
<pre class="smallexample">
WarnIfNoLineStarting <var>quoted-string</var>
</pre></div>
<p>Issue a warning if the quoted string is not found
at the start of one or more lines in the file.
</p>
<hr>
<a name="WarnIfNoSuchLine"></a>
<div class="header">
<p>
Previous: <a href="#WarnIfNoLineStarting" accesskey="p" rel="previous">WarnIfNoLineStarting</a>, Up: <a href="#editfiles" accesskey="u" rel="up">editfiles</a> [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Variable-Index" title="Index" rel="index">Index</a>]</p>
</div>
<a name="WarnIfNoSuchLine-1"></a>
<h4 class="subsection">4.17.99 WarnIfNoSuchLine</h4>
<div class="smallexample">
<pre class="smallexample">
WarnIfNoSuchLine <var>quoted-regex</var>
</pre></div>
<p>Issue a warning if the quoted regular expression does not
match one or more lines in the file.
</p>
<hr>
<a name="Editfiles-on-Binary-Files"></a>
<div class="header">
<p>
Next: <a href="#files" accesskey="n" rel="next">files</a>, Previous: <a href="#editfiles" accesskey="p" rel="previous">editfiles</a>, Up: <a href="#Cfagent-reference" accesskey="u" rel="up">Cfagent reference</a> [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Variable-Index" title="Index" rel="index">Index</a>]</p>
</div>
<a name="Editfiles-on-Binary-Files-1"></a>
<h3 class="section">4.18 Editfiles on Binary Files</h3>
<p>A limited number of operations can also be performed on purely binary
files, e.g. compiled programs, in order to search for strings or
viral code, or to modify strings within a program. Binary mode is a
mutually exclusive, separate mode to normal editing. The limit on the
size of binary files is set by <code>editbinaryfilesize</code> in
<code>control</code>.
</p>
<ul>
<li> ReplaceAll <var>regex</var> With <var>literal</var>
<p>Replaces occurrences of the matched regular expression with\
the provided literal text, only if the length of the literal substitute
is less than or equal to the length of the located string. If the
replacement string is shorter, it is padded with ascii spaces (character 32) by default.
The padding character can be changed by setting <code>BinaryPaddingChar</code> in <code>control</code>.
Padding with a null byte would lead to corruption of text within a program.
</p>
</li><li> WarnIfContainsString <var>regex/literal</var>
Yields a warning if the literal string or regular expression matches.
Cfengine first attempts a literal match and then a regular expression
match.
</li><li> WarnIfContainsFile <var>filename</var>
Yields a warning if the contents of the named file exactly match
part of the file which is being edited. This can be used to search for
binary data which cannot be typed directly into the cfengine program,
e.g. virus signatures.
</li></ul>
<hr>
<a name="files"></a>
<div class="header">
<p>
Next: <a href="#filters" accesskey="n" rel="next">filters</a>, Previous: <a href="#Editfiles-on-Binary-Files" accesskey="p" rel="previous">Editfiles on Binary Files</a>, Up: <a href="#Cfagent-reference" accesskey="u" rel="up">Cfagent reference</a> [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Variable-Index" title="Index" rel="index">Index</a>]</p>
</div>
<a name="files-1"></a>
<h3 class="section">4.19 files</h3>
<a name="index-File-management"></a>
<a name="index-Files_002c-checking-permissions"></a>
<a name="index-Files_002c-setting-owner"></a>
<a name="index-files-1"></a>
<p>The <code>files</code> facility allows you to touch (create), check for the
existence, owner and permissions of files, change the permissions and
test for setuid root programs.
</p>
<table class="menu" border="0" cellspacing="0">
<tr><td align="left" valign="top">• <a href="#Syntax" accesskey="1">Syntax</a>:</td><td> </td><td align="left" valign="top">
</td></tr>
<tr><td align="left" valign="top">• <a href="#Recursion" accesskey="2">Recursion</a>:</td><td> </td><td align="left" valign="top">
</td></tr>
<tr><td align="left" valign="top">• <a href="#Directory-permissions" accesskey="3">Directory permissions</a>:</td><td> </td><td align="left" valign="top">
</td></tr>
<tr><td align="left" valign="top">• <a href="#Checksums-and-change-management" accesskey="4">Checksums and change management</a>:</td><td> </td><td align="left" valign="top">
</td></tr>
<tr><td align="left" valign="top">• <a href="#home-directive" accesskey="5">home directive</a>:</td><td> </td><td align="left" valign="top">
</td></tr>
<tr><td align="left" valign="top">• <a href="#Owner-and-group-wildcards" accesskey="6">Owner and group wildcards</a>:</td><td> </td><td align="left" valign="top">
</td></tr>
<tr><td align="left" valign="top">• <a href="#Files-linkchildren" accesskey="7">Files linkchildren</a>:</td><td> </td><td align="left" valign="top">
</td></tr>
<tr><td align="left" valign="top">• <a href="#touch" accesskey="8">touch</a>:</td><td> </td><td align="left" valign="top">
</td></tr>
<tr><td align="left" valign="top">• <a href="#create" accesskey="9">create</a>:</td><td> </td><td align="left" valign="top">
</td></tr>
</table>
<hr>
<a name="Syntax"></a>
<div class="header">
<p>
Next: <a href="#Recursion" accesskey="n" rel="next">Recursion</a>, Previous: <a href="#files" accesskey="p" rel="previous">files</a>, Up: <a href="#files" accesskey="u" rel="up">files</a> [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Variable-Index" title="Index" rel="index">Index</a>]</p>
</div>
<a name="Syntax-1"></a>
<h4 class="subsection">4.19.1 Syntax</h4>
<a name="index-Files_002c-syntax"></a>
<p>A files-statement can have several options. We can begin by examining
the form of the statement in pseudo-code:
</p>
<table class="cartouche" border="1"><tr><td>
<p><!-- /@w -->
</p><div class="smallexample">
<pre class="smallexample"> files:
<var>classes</var>::
/<var>file-object</var>
mode=<var>mode</var>
owner=<var>uid-list</var>
group=<var>gid-list</var>
action=<var>fixall/other-options</var>/<b>warnall</b>
links=<b>false/stop</b><var>/traverse/follow/tidy</var>
rxdirs=<b>true/on</b>/<var>false/off</var>
ignore=<var>pattern</var>
include=<var>pattern</var>
exclude=<var>pattern</var>
filter=<var>filter alias</var>
xdev=<var>true/on</var>/<b>false/off</b>
define=<var>classlist</var>
elsedefine=<var>classlist</var>
checksum=<var>md5/sha/best</var>
syslog=<var>true/on</var>/<b>false/off</b>
inform=<var>true/on</var>/<b>false/off</b>
audit=<var>true/on</var>/<var>false/off</var>
ifelapsed=<var>mins</var>
expireafter=<var>mins</var>
<var>Special OS flags:</var>
flags=<var>BSD flags</var>
</pre></div>
</td></tr></table>
<p>An example would be the following:
</p>
<div class="smallexample">
<pre class="smallexample"> any::
/var/spool/printQ mode=0775 r=0 o=daemon g=daemon act=fixdirs
</pre></div>
<p>The meaning of these item is sketched out below and becomes clearer on
looking at a number of examples. Note that, each of the options below
can be written in either upper or lower case and abbreviated by any
unique abbreviation.
<a name="index-m_003d"></a>
<a name="index-mode"></a>
<a name="index-l_003d"></a>
<a name="index-link"></a>
<a name="index-recurse"></a>
<a name="index-r_003d"></a>
<a name="index-a_003d"></a>
<a name="index-action"></a>
<a name="index-o_003d"></a>
<a name="index-owner"></a>
<a name="index-g_003d"></a>
<a name="index-group"></a>
<a name="index-rxdirs"></a>
</p>
<dl compact="compact">
<dt><code><var>/file-object</var></code></dt>
<dd><p>This is the only obligatory part of a file action. This may be a
single file or a directory. If it is a directory then it indicates
where does the file search should begin. The recursion specifier may
be used to force cfengine to descend into subdirectories in a
controlled fashion, starting from this point, checking files there
also. The wildcard <code>home</code> may also be used. See <a href="#home-directive">home directive</a>.
</p>
<p>A file object is interpreted as a directory if you write it in the
following form: <samp>/directory-path/.</samp>. i.e. a trailing dot signifies
a directory. This then becomes the same as the <code>directory</code> command.
<a name="index-home-wildcard"></a>
<a name="index-Wildcard-home"></a>
<a name="index-home"></a>
</p>
</dd>
<dt><code>mode=<var>modestring</var></code></dt>
<dd><p>Specifies what the allowed permissions for files are. If cfengine finds
that a file’s mode is incorrect, the value of the <code>action</code>
option determines what will be done about it. The modestring should
consist of either a three digit octal numbers with ‘<samp>+</samp>’, ‘<samp>-</samp>’ or
‘<samp>=</samp>’ symbols, or a text string like that used by the command
<code>chmod</code>. For instance: <code>mode=u=rwx,og+rx</code> would mean set the
read/write and execute flags for the user (file owner) and add the
read/execute flags for others and group bits. An example of the
numerical form might be <code>-002</code> which would mean that the
read-for-others flag should either not be set or should be unset,
depending on the action you choose. <code>+2000</code> would mean that the
setgid flag should be present or set, depending on the action.
<code>+2000,-002</code> would be a combination of these. The ‘<samp>=</samp>’ sign
sets to an absolute value, so <code>=755</code> would set the file mode to
mode 755.
</p>
</dd>
<dt><code>flags=<var>BSD flags</var></code></dt>
<dd><p>The free BSD Unices have additional filesystem flags which can be seton
files. Refer to the BSD <code>chflags</code> documentation for this. For
example,
</p>
<div class="smallexample">
<pre class="smallexample">
/tmp/flags.01 mode=0600 owner=0 group=0
flags=uappnd,uchg,uunlnk,nodump,opaque,sappnd,schg,sunlnk
action=touch
</pre></div>
</dd>
<dt><code>recurse=<var>number/inf</var></code></dt>
<dd><p>This specifier tells cfengine whether or not to recurse into
subdirectories. If the value is zero, only the named file or directory
is affected. If the value is 1, it will open at most one level of
subdirectory and affect the files within this scope. If the value is
<code>inf</code> then cfengine opens all subdirectories and files beginning
from the specified filename.See <a href="#Recursion">Recursion</a>.
</p>
</dd>
<dt><code>owner=<var>owner list</var></code></dt>
<dd><p>This is a list of allowed owners, or uids by number, separated by
commas. For example <code>root,2,3,sysadm</code>. In cases where you ask
cfengine to fix the ownership automatically, the owner will be set to
the first recogized owner in the list if and only if it is not one of the named
uids in the list.
</p>
</dd>
<dt><code>group=<var>group list</var></code></dt>
<dd><p>This is a list of allowed groups, or gids by number, separated by
commas. For example <code>wheel,2,3,sysadm</code>. In cases where you ask
cfengine to fix the ownership automatically, the group will be set to
the first recognized group in the list if and only if it is not one of the named
gids in the list.
</p>
</dd>
<dt><code>action=<var>action</var></code></dt>
<dd><p>The action is one of the following keywords.
</p>
<div class="smallexample">
<pre class="smallexample">warnall warndirs warnplain
fixall fixdirs fixplain
touch linkchildren create compress alert
</pre></div>
<p>The upper line results only in warnings being issued. The actions
beginning ‘fix’ prompt cfengine to fix encountered problems without
bothering the user. No message is issued unless in verbose mode. The
special features on the third line will be explained separately. Alert
is like <code>-print</code> in the find command, it triggers on the existence
of files which have not been ignored, excluded or filtered. This should
normally be used together <code>filter</code>, in order to locate files of particular types.
</p>
</dd>
<dt><code>include=<var>wildcard/pattern</var></code></dt>
<dd><p>You can include this option several times to specify specific patterns
which are to be included in the search. Once you specify one
pattern you exclude all files not matching at least one of the
patterns. The case be useful for restricting a search, or for
modifying the permissions of only certain files.
<a name="index-Search-patterns-in-files"></a>
<a name="index-include_003d"></a>
<a name="index-Pattern-matching-in-file-sweeps"></a>
</p>
</dd>
<dt><code>exclude=<var>wildcard/pattern</var></code></dt>
<dd><p>You can include this option several times to specify specific patterns
which are to be excluded from the search. This overrides any patterns
given in the <code>include=</code> list.
<a name="index-exclude_003d"></a>
<a name="index-Excluding-files-from-a-file-sweep"></a>
</p>
</dd>
<dt><code>ignore</code></dt>
<dd><p>This works like the global ignore directive but here you may
provide a private list of ignorable directories and files.
Unlike include, exclude this affects the way cfengine parses
directory trees.
</p>
</dd>
<dt><code>links=<var>stop/traverse/tidy</var></code></dt>
<dd><p>Normally cfengine does not descend into subdirectories which are pointed
to by symbolic links. If you wish to force it to do so (without using
the <code>-l</code> command line option) you may give this option the value
<code>true</code>, or <code>traverse</code>, or <code>follow</code>. To specify no
recursion you set the value <code>false</code> or <code>stop</code>.
<a name="index-Links_002c-traversing-in-searches"></a>
<a name="index-_002dl"></a>
<a name="index-_002dl-option"></a>
Note that the value set here in the cfengine program <em>always
overrides</em> the value set by the <code>-l</code> command line option, so you
can protect certain actions from this command line option by specifying
a negative value here. If you specify no value here, the behaviour is
determined by what you specify on the command line.
</p>
<p>The value <code>links=tidy</code> has the same effect as the ‘<samp>-L</samp>’ command
line option except that here it may be specified per item rather than
globally. Setting this value causes links which point to non-existent
files to be deleted.
<a name="index-Deleting-stale-links"></a>
<a name="index-Links_002c-deleting-stale"></a>
</p>
<p>If the warn directive is used (for directories, plain files or both)
then only a warning message is issued if the file being tested does not
match the specification given. If the fix directives are used then
cfengine does not issue a warning, it simply fixes the value silently.
Non-existent files are created by the <code>touch</code> command. A
directory may be touched (created) by writing the filename
<code>/a/b/c/.</code> with a dot as the last character. (This may also be
achieved with the <code>directories</code> directive, See <a href="#directories">directories</a>.)
</p>
</dd>
<dt><code>define=<var>classlist</var></code></dt>
<dd><p>If a file operation results in action being taken to fix a file,
the colon, comma or dot separated list of classes becomes defined.
Warnings do not activate the classes.
</p>
</dd>
<dt><code>checksum=<var>md5/sha/best</var></code></dt>
<dd><p>If set this option causes cfengine to add a checksum for the named file
to a database. Changes in the value of this checksum are then warned as
a security issue. This should normally only be used to monitor binary
files which one would not expect to change often. Note also that the use
of this option can mean a significant performance penalty. If the value
<code>best</code> is used for this option then the best known pair of
checksum methods are cross-checked for each file. (The best value are
determined by the algorithms supported in the OpenSSL interfaces used
to compile the program).
</p>
<p>If <code>ChecksumUpdates</code> is set, then
security warning messages are issued only once and the value
in the database is then changed to the new value of the file
automatically i.e. the behaviour is similar to that of setuid root
program detection, See <a href="#ChecksumPurge">ChecksumPurge</a>.
Also, See <a href="#ChecksumUpdates">ChecksumUpdates</a>.
<a name="index-Message-digests-1"></a>
<a name="index-Hashes-of-files-1"></a>
<a name="index-Tripwire-functionality-1"></a>
</p>
</dd>
<dt><code>xdev</code></dt>
<dd><p>Prevents cfengine from descending into file systems that are not on the
same device as the root of the rescurion path.
<a name="index-xdev-1"></a>
</p>
</dd>
<dt><code>rxdirs</code></dt>
<dd><p>If true (the default) cfengine assumes that a directory that is readable should also
have its execute flag set, allowing users to enter it and perform directory browsing.
If false, cfengine will not make this assumption. Note that if set to false, it will
affect recursive file checks. Thus setting to false with <code>mode=644 recurse=true</code>
could lead to unintended permissions on directories.
</p></dd>
</dl>
<p>The default values are <code>mode=+000</code>, <code>recurse=0</code>,
<code>action=warnall</code> and any owner or group is acceptable. The default
for <code>links</code> is to not traverse links unless the <code>-l</code> option is
set on the command line.
</p>
<hr>
<a name="Recursion"></a>
<div class="header">
<p>
Next: <a href="#Directory-permissions" accesskey="n" rel="next">Directory permissions</a>, Previous: <a href="#Syntax" accesskey="p" rel="previous">Syntax</a>, Up: <a href="#files" accesskey="u" rel="up">files</a> [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Variable-Index" title="Index" rel="index">Index</a>]</p>
</div>
<a name="Recursion-1"></a>
<h4 class="subsection">4.19.2 Recursion</h4>
<a name="index-Recursion-in-files"></a>
<a name="index-Files_002c-recursion"></a>
<p>The recursion specifier tells cfengine what to do, starting from
<code>/directory name</code>. A value of <code>r=0</code> means ‘no recursion’ and
any checking is limited only to the named file or directory. A value of
<code>r=inf</code> implies unlimited recursion. Cfengine then descends into
all subdirectories checking or setting the permissions of files until it
‘bottoms out’ at a plain file. A value such as <code>R=4</code> means descend
recursively into subdirectories, but no more than four levels. This is
a useful safety net in preventing unforeseen accidents. A recursive
search also bottoms out on device boundaries and symbolic links
(provided the <kbd>-l</kbd> option is not used).
<a name="index-Device-boundaries-and-files"></a>
<a name="index-xdev-_0028File-system-boundaries_0029"></a>
</p>
<hr>
<a name="Directory-permissions"></a>
<div class="header">
<p>
Next: <a href="#Checksums-and-change-management" accesskey="n" rel="next">Checksums and change management</a>, Previous: <a href="#Recursion" accesskey="p" rel="previous">Recursion</a>, Up: <a href="#files" accesskey="u" rel="up">files</a> [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Variable-Index" title="Index" rel="index">Index</a>]</p>
</div>
<a name="Directory-permissions-1"></a>
<h4 class="subsection">4.19.3 Directory permissions</h4>
<a name="index-Directory-permissions"></a>
<a name="index-Permissions_002c-directories"></a>
<p>When you specify the permissions for a whole file tree, using the
recursion specifier it is awkward to have to remember that directories
must be executable. cfengine will do this for you automatically. If
you specify that a file tree is to have a read flag set, cfengine will
ensure that the corresponding execute flag is also set for directories
which live in the tree. So the command
</p>
<div class="smallexample">
<pre class="smallexample">files:
myclass::
/dir mode=a+rw r=inf fixall
</pre></div>
<p>would set all plain files to mode 644 and all directories to 755, that
is read/write for everyone on plain files and read/write/execute for
everyone on directories.
</p>
<hr>
<a name="Checksums-and-change-management"></a>
<div class="header">
<p>
Next: <a href="#home-directive" accesskey="n" rel="next">home directive</a>, Previous: <a href="#Directory-permissions" accesskey="p" rel="previous">Directory permissions</a>, Up: <a href="#files" accesskey="u" rel="up">files</a> [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Variable-Index" title="Index" rel="index">Index</a>]</p>
</div>
<a name="Checksums-and-change-management-1"></a>
<h4 class="subsection">4.19.4 Checksums and change management</h4>
<a name="index-Checksums"></a>
<a name="index-Hashes"></a>
<p>Integrity checks are a good way of detecting tampering
with a system, or simply for monitoring upgrades that happen
as a result of software unrelated to cfengine. The <code>checksum</code>
option asks cfengine to compute and cache the value of the
cryptographic checksum of the named file.
</p>
<div class="smallexample">
<pre class="smallexample">files:
/my/file
checksum=best
action=warnall
</pre></div>
<p>The checksum type can be <code>md5</code>, <code>sha</code> or <code>best</code>.
The option best cross checks the best two available algorithms.
At present cfengine is waiting for improvements to the OpenSSL
library supporting sha2 algorithms.
</p>
<p>Once a value has been
computed and placed in the database each new computation will be
checked against the old one. Any change will lead to a mismatch
and the following will happen:
</p>
<ul>
<li> A warning is printed about the change
</li><li> As of 2.2.8 a class called <code>checksum_alerts</code> will be defined, indicating
that a change has occurred. This can be used to trigger followup actions. The class
is a persistant class that lasts for 60 minutes.
</li><li> If ChecksumUpdates is set to true, the new value will replace the old in the database
</li></ul>
<hr>
<a name="home-directive"></a>
<div class="header">
<p>
Next: <a href="#Owner-and-group-wildcards" accesskey="n" rel="next">Owner and group wildcards</a>, Previous: <a href="#Checksums-and-change-management" accesskey="p" rel="previous">Checksums and change management</a>, Up: <a href="#files" accesskey="u" rel="up">files</a> [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Variable-Index" title="Index" rel="index">Index</a>]</p>
</div>
<a name="home-directive-1"></a>
<h4 class="subsection">4.19.5 <code>home</code> directive</h4>
<a name="index-home-directive"></a>
<a name="index-Files_002c-home-wildcard"></a>
<p>If you want to check the files of all the users who have their login
areas on the current host, you can use a wildcard directive <code>home</code>
instead of a directory name. In this case the file action iterates over
all home directories physically on the current host. The home
directories are, of course, located by searching for files which match
</p>
<div class="smallexample">
<pre class="smallexample">$(mountpattern)/$(homepattern)
</pre></div>
<p>i.e. the values which are specified in the <code>control</code> part of the
program. For example the following line is a very useful service to
ignorant users.
</p>
<div class="smallexample">
<pre class="smallexample">files:
any::
home mode=o-w r=inf act=fixall
</pre></div>
<p>It ensures automatically that no user has files which can be written to
by other arbitrary users.
</p>
<p>As a corollary to this, you may write something like
</p>
<div class="smallexample">
<pre class="smallexample">
any::
home/www mode=a+r fixall
</pre></div>
<p>to specify a special subdirectory of every users’ home directory. This
statement would check that all of the files in users’ world wide web
directories were readable for everyone.
</p>
<hr>
<a name="Owner-and-group-wildcards"></a>
<div class="header">
<p>
Next: <a href="#Files-linkchildren" accesskey="n" rel="next">Files linkchildren</a>, Previous: <a href="#home-directive" accesskey="p" rel="previous">home directive</a>, Up: <a href="#files" accesskey="u" rel="up">files</a> [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Variable-Index" title="Index" rel="index">Index</a>]</p>
</div>
<a name="Owner-and-group-wildcards-1"></a>
<h4 class="subsection">4.19.6 Owner and group wildcards</h4>
<a name="index-Ownership-of-files"></a>
<a name="index-Files_002c-ownership"></a>
<p>If you do not want to explicitly state the owner or group of a file you
may simply omit the group or owner options.
</p>
<div class="smallexample">
<pre class="smallexample">
/<var>file-object</var> m=0664 r=inf
</pre></div>
<p>This example generate a warning if any files under the named directory
do not have permission read/write for all users.
</p>
<hr>
<a name="Files-linkchildren"></a>
<div class="header">
<p>
Next: <a href="#touch" accesskey="n" rel="next">touch</a>, Previous: <a href="#Owner-and-group-wildcards" accesskey="p" rel="previous">Owner and group wildcards</a>, Up: <a href="#files" accesskey="u" rel="up">files</a> [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Variable-Index" title="Index" rel="index">Index</a>]</p>
</div>
<a name="Files-linkchildren-1"></a>
<h4 class="subsection">4.19.7 Files linkchildren</h4>
<a name="index-linkchildren"></a>
<a name="index-Linkchildren"></a>
<p>The <code>linkchildren</code> facility is almost identical to that already
described under <code>links</code>. See <a href="#Link-Children">Link Children</a>. The only
difference here is that the ownership and permissions on the links are
set all in one operation. For example:
</p>
<div class="smallexample">
<pre class="smallexample"><var>myclass</var>::
/local/lib/emacs m=0770 o=me g=mygroup act=linkchildren
</pre></div>
<hr>
<a name="touch"></a>
<div class="header">
<p>
Next: <a href="#create" accesskey="n" rel="next">create</a>, Previous: <a href="#Files-linkchildren" accesskey="p" rel="previous">Files linkchildren</a>, Up: <a href="#files" accesskey="u" rel="up">files</a> [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Variable-Index" title="Index" rel="index">Index</a>]</p>
</div>
<a name="touch-1"></a>
<h4 class="subsection">4.19.8 touch</h4>
<a name="index-touch"></a>
<a name="index-Touching-files"></a>
<p>The <code>touch</code> facility creates a new file with the
specified permissions and ownership, or corrects the
permissions and ownership of an existing file, in addition
to updating the time stamps.
</p>
<div class="smallexample">
<pre class="smallexample"><var>myclass</var>::
/<var>newfile</var> mode=0644 action=touch
</pre></div>
<hr>
<a name="create"></a>
<div class="header">
<p>
Previous: <a href="#touch" accesskey="p" rel="previous">touch</a>, Up: <a href="#files" accesskey="u" rel="up">files</a> [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Variable-Index" title="Index" rel="index">Index</a>]</p>
</div>
<a name="create-1"></a>
<h4 class="subsection">4.19.9 create</h4>
<a name="index-create"></a>
<a name="index-Creating-files"></a>
<p>This is like <code>touch</code> except that an existing
file’s time stamps, permissions and ownership will not be modified
if the file already exists. If the file does not exist, the
attributes are set to the values specified, or to the default
values of <code>0644</code>.
</p>
<hr>
<a name="filters"></a>
<div class="header">
<p>
Next: <a href="#groups" accesskey="n" rel="next">groups</a>, Previous: <a href="#files" accesskey="p" rel="previous">files</a>, Up: <a href="#Cfagent-reference" accesskey="u" rel="up">Cfagent reference</a> [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Variable-Index" title="Index" rel="index">Index</a>]</p>
</div>
<a name="filters-1"></a>
<h3 class="section">4.20 filters</h3>
<a name="index-filter"></a>
<a name="index-Selecting-files-in-searches"></a>
<a name="index-Searching_002c-advanced"></a>
<p>A filter is a way of selecting or pruning during a search over
files or processes. Since filter rules could apply to several objects, cfengine
allows you to define filter conditions as separate objects to be
applied in different contexts.
</p>
<p>Filter objects can be used in <code>copy</code>, <code>editfiles</code>,
<code>files</code>, <code>tidy</code> and <code>processes</code>. In most cases one
writes
</p>
<div class="smallexample">
<pre class="smallexample">.. filter=<i>filteralias</i>
</pre></div>
<p>in the appropriate command. The exception is <code>editfiles</code>, where the syntax
is
</p>
<div class="smallexample">
<pre class="smallexample">{
..
Filter "filteralias"
..
}
</pre></div>
<p>Example:
</p>
<div class="smallexample">
<pre class="smallexample">
files:
/tmp filter=testfilteralias action=alert r=inf
</pre></div>
<p>Filters are defined in a separate section. Filters for files
and processes are defined together. They differ only in the
criteria they contain. Here is are examples of file filters:
</p>
<div class="smallexample">
<pre class="smallexample">Filters:
{ filteralias1
Owner: "mark|cell|motd"
Group: "ecg|mark"
Mode: "700"
FromCtime: "date(2000,1,1,0,0,0)" # absolute date
ToCtime: "now"
FromMtime: "tminus(1,0,0,2,30,0)" # relative "ago" from now
ToMtime: "inf" # end of time
FromAtime: "date(1997,2,22,0,0,0)"
ToAtime: "inf"
FromSize: "10000" # File size interval
ToSize: "10mb"
ExecRegex: "/usr/bin/file $(this) (.*ascii.*)"# Result from "files" command
Type: "dir|link" # reg|link|dir|socket|fifo|door|char|block
NameRegex: ".*.asc" # regex matching file name
IsSymLinkTo: "/dev/null" # True if file is a link to object name regex
Result: "Type" # Result which shouldbe returned
}
#########################################
{ testfilteralias2
ExecProgram: "/bin/ls $(this)" # True if the program returns true. $(this) is the current object
}
#########################################
{ testfilteralias3
Owner: "mark"
}
</pre></div>
<p>Filters are evaluated like classes. In fact, the filtering works by evaluating
the class attributes for each file.
</p>
<p>File filters:
</p>
<dl compact="compact">
<dt><code>Owner:</code></dt>
<dd><p>and Group can use numerical id’s or
names, or <code>``none''</code> for users or groups which are undefined in
the system passwd/group file.
</p>
</dd>
<dd><p>Mode: applies only to file objects. It shares syntax with
the <code>mode=</code> strings in the files command. This test returns
true if the bits which are specified as ‘should be set’ are indeed
set, and those which are specified as ‘should not be set’ are not set.
</p>
</dd>
<dt><code>Atime:,Ctime:,Mtime:</code></dt>
<dd><p>apply only to file objects.
These specify ranges From and To. If the file’s time stamps
lie in the specified range, this returns true. Times are
specfied by a six component vector
</p>
<div class="smallexample">
<pre class="smallexample">(year,month,day,hour,minutes,seconds)
</pre></div>
<p>This may be evaluated as two functions: date() or tminus()
which give absolute times and times relative to the current time respectively.
In addition, the words now and inf may be used.
e.g.
</p>
<div class="smallexample">
<pre class="smallexample"> FromCtime: "date(2000,1,1,0,0,0)" # absolute date
ToCtime: "now"
FromMtime: "tminus(1,0,0,2,30,0)" # relative "ago" from now
ToMtime: "inf" # end of time
</pre></div>
</dd>
<dt><code>Type:</code></dt>
<dd><p>applies only to file objects may be a list of file types
which are to be matched. The list should be separated by the OR symbol
‘|’, since these types are mutually exclusive. The possible values are
currently
</p>
<div class="smallexample">
<pre class="smallexample">file|reg|link|dir|socket|fifo|door|char|block
</pre></div>
<p>Note that <code>file</code> and <code>reg</code> are synonymous.
</p></dd>
<dt><code>ExecRegex:</code></dt>
<dd><p>matches the test string against the output of the specified command.
</p></dd>
<dt><code>NameRegex:</code></dt>
<dd><p>matches the name of the file with a regular expression.
</p></dd>
<dt><code>IsSymLinkTo:</code></dt>
<dd><p>applies only when the file object $(this) is a symbolic link. It is true
if the regular expression matches the contents of the link.
</p></dd>
<dt><code>ExecProgram:</code></dt>
<dd><p>matches if the command returns successfully (with return code 0).
Note that this feature introduces an implicit dependency on the command being
called. This might be exploitable as a security weakness by advanced intruders.
</p></dd>
<dt><code>Result:</code></dt>
<dd><p>specifies the way in which the above elements are combined
into a single filter.
</p></dd>
</dl>
<p>Process filters:
</p>
<dl compact="compact">
<dt><code>Owner</code></dt>
<dd><p>process owner UID (quoted regex)
</p></dd>
<dt><code>PID:</code></dt>
<dd><p>process ID (quoted regex)
</p></dd>
<dt><code>PPID:</code></dt>
<dd><p>parent process ID (quoted regex)
</p></dd>
<dt><code>PGID:</code></dt>
<dd><p>process group ID (quoted regex)
</p></dd>
<dt><code>RSize:</code></dt>
<dd><p>resident size (quoted regex)
</p></dd>
<dt><code>VSize:</code></dt>
<dd><p>virtual memory size (quoted regex)
</p></dd>
<dt><code>Status:</code></dt>
<dd><p>status (quoted regex)
</p></dd>
<dt><code>Command:</code></dt>
<dd><p>CMD or COMMAND fields (quoted regex)
</p></dd>
<dt><code>(From/To)TTime:</code></dt>
<dd><p>Total elasped time in TIME field (accumulated time)
</p></dd>
<dt><code>(From/To)STime:</code></dt>
<dd><p>Starting time for process in STIME or START field (accumulated time)
</p></dd>
<dt><code>TTY:</code></dt>
<dd><p>terminal type, or none (quoted regex)
</p></dd>
<dt><code>Priority:</code></dt>
<dd><p>PRI or NI field (quoted regex)
</p></dd>
<dt><code>Threads:</code></dt>
<dd><p>NLWP field for SVR4 (quoted regex)
</p></dd>
<dt><code>Result:</code></dt>
<dd><p>logical combination of above returned by filter (quoted regex)
</p></dd>
</dl>
<p>Examples: processes started between 18th Nov 2000 and now.
</p>
<div class="smallexample">
<pre class="smallexample"> { filteralias
FromSTime: "date(2000,11,18,0,0,0)"
ToSTime: "now"
}
</pre></div>
<p>All processes which have accumulated between 1 and 20 hours of CPU time.
</p>
<div class="smallexample">
<pre class="smallexample"> { filteralias
FromTTime: "accumulated(0,0,0,1,0,0)"
ToTTime: "accumulated(0,0,0,20,0,0)"
}
</pre></div>
<table class="menu" border="0" cellspacing="0">
<tr><td align="left" valign="top">• <a href="#Complete-filter-examples" accesskey="1">Complete filter examples</a>:</td><td> </td><td align="left" valign="top">
</td></tr>
</table>
<hr>
<a name="Complete-filter-examples"></a>
<div class="header">
<p>
Previous: <a href="#filters" accesskey="p" rel="previous">filters</a>, Up: <a href="#filters" accesskey="u" rel="up">filters</a> [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Variable-Index" title="Index" rel="index">Index</a>]</p>
</div>
<a name="Complete-filter-examples-1"></a>
<h4 class="subsection">4.20.1 Complete filter examples</h4>
<p>Here is an example filter to search for all files which are either directories or links,
or any kind of file owned by mark, in group cfengine.
</p>
<div class="smallexample">
<pre class="smallexample">
control:
actionsequence = ( files )
files:
/tmp filter=testfilteralias action=alert r=inf
/cfengine filter=testfilteralias action=fixall r=inf mode=644
filters:
{ testfilteralias
Owner: "mark"
Group: "cfengine"
Type: "dir|link"
Result: "Type|(Owner.Group)" # Both owner AND group required correct
}
</pre></div>
<p>Find all ELF executables using data from the Unix <code>file</code> command.
Caution, this takes a long time if used indescriminately.
</p>
<div class="smallexample">
<pre class="smallexample">
control:
actionsequence = ( files )
files:
/tmp filter=testfilteralias action=alert r=inf
/cfengine filter=testfilteralias action=fixall r=inf mode=644
filters:
{ testfilteralias
ExecRegex: "/bin/file (.*ELF.*)"
Result: "ExecRegex"
}
</pre></div>
<p>Here is an example which warns of any process coupled to a terminal
started in November:
</p>
<div class="smallexample">
<pre class="smallexample">control:
actionsequence = ( processes )
filters:
{ filteralias
FromSTime: "date(2000,11,0,0,0,0)"
ToSTime: "date(2000,11,30,0,0,0)"
TTY: ".*pt.*"
Result: "TTY.STime"
}
processes:
"." filter=filteralias action=warn
</pre></div>
<hr>
<a name="groups"></a>
<div class="header">
<p>
Next: <a href="#homeservers" accesskey="n" rel="next">homeservers</a>, Previous: <a href="#filters" accesskey="p" rel="previous">filters</a>, Up: <a href="#Cfagent-reference" accesskey="u" rel="up">Cfagent reference</a> [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Variable-Index" title="Index" rel="index">Index</a>]</p>
</div>
<a name="groups_002fclasses"></a>
<h3 class="section">4.21 groups/classes</h3>
<a name="index-groups-2"></a>
<a name="index-Defining-groups"></a>
<a name="index-Groups_002c-defining"></a>
<p>The <code>groups</code> action (equivalently referred to as <code>classes</code> as
of version 1.4.0) is used to define classes which stand for groups of
hosts. If you use the NIS (network information service) facility for
defining <em>netgroups</em> then this idea will already be familiar to you
and you can probably use your already-defined netgroups in cfengine.
<a name="index-groups-1"></a>
<a name="index-classes-2"></a>
</p>
<p>To define a group, you simply make a list and assign it a name. Here is
an example of the syntax:
</p>
<div class="smallexample">
<pre class="smallexample">
groups:
ANDed_class::
science = ( saga tor odin )
packages = ( saga )
AllHomeServers = ( saga )
AllBinaryServers = ( saga )
OIH_servers = ( saga )
OIH_clients = ( tor odin )
notthis = ( !this )
ip_in_range = ( IPRange(129.0.0.1-15) ) # host is in ip address range
ip_in_range = ( IPRange(129.0.0.1/24) ) # host is in ip address range (CIDR notation)
compute_nodes = ( HostRange(cpu-,1-32) ) # host name in the cpu-01 through cpu-32 range
</pre></div>
<a name="index-CIDR"></a>
<a name="index-Classless-IP-addresses"></a>
<p>To include a list of hosts from a NIS netgroup, you use the ‘<samp>+</samp>’ symbol, or
the ‘<samp>+@</samp>’ construction. For example:
</p>
<a name="index-Netgroups"></a>
<a name="index-NIS_002c-netgroup-support"></a>
<a name="index-_002b"></a>
<p><!-- /@w -->
</p><div class="smallexample">
<pre class="smallexample">
groups:
science = ( +science-allhosts )
physics = ( +physics-allhosts )
physics_theory = ( +@physics-theory-sun4 dirac feynman schwinger )
</pre></div>
<p>Using an enormous netgroup does not use up any space. A group
declaration results in the storage of only the class name regardless of
how many hosts are in the list. The rule is that the left hand side of
the assignment becomes defined (true) if the list on the right hand side
includes the host which is parsing the file — i.e. <code>$(host)</code>.
</p>
<p>In some cases your netgroups will not correspond exactly to the list you
want, but it might be more convenient to use a netgroup <em>except</em>
for certain hosts. You can ‘undefine’ or remove hosts from the netgroup
list by using the minus ‘-’ symbol. For example:
</p>
<a name="index-Removing-entries-from-netgroups"></a>
<a name="index-Negating-entries-from-netgroups"></a>
<a name="index-Netgroups_002c-negating-entries"></a>
<p><!-- /@w -->
</p><div class="smallexample">
<pre class="smallexample">
group = ( +mynetgroup -specialhost -otherhost )
</pre></div>
<p>which means, of course, all hosts in netgroup <code>mynetgroup</code> except
for <code>specialhost</code> and <code>otherhost</code>. Finally, you may also
subtract two netgroups in the following manner.
</p>
<div class="smallexample">
<pre class="smallexample">group = ( +bignetgroup -smallnetgroup )
</pre></div>
<p>The ‘minus’ command effectively eliminates its members from
<code>bignetgroup</code> if they exist within that group. If none of the
hosts in <code>smallnetgroup</code> exist in <code>bignetgroup</code> then the
command has no effect.
</p>
<a name="index-Group-dependencies"></a>
<a name="index-Class-dependencies"></a>
<a name="index-Dependencies"></a>
<p>Groups may contain previously defined cfengine groups too. This
allows one class to inherit the attributes of another class, for instance:
</p>
<div class="smallexample">
<pre class="smallexample">
AllSun4Hosts = ( sonny sunny solar stella )
AllUltrixHosts = ( ully olly wally golly )
AllBSD = ( AllSun4Hosts AllUltrixHosts )
</pre></div>
<p>The classes on the right hand side are effectively ORed together into
the left hand side. This enables complex classes to be constructed from
several other basic classes, e.g.
</p>
<div class="smallexample">
<pre class="smallexample">
SpecialTimes = ( Hr00 Monday Day1 )
</pre></div>
<p>which evaluates to true every day when it between 00:00 hours and 00:59,
all day Monday and all day on the first day of every month.
</p>
<p>If you apply a class predicate before a definition then the result
is effectively the AND of the classes:
</p>
<div class="smallexample">
<pre class="smallexample">
Hr00::
SpecialTime = ( Monday Tuesday )
</pre></div>
<p>defines <code>SpecialTime</code> at Hr00 on Monday or Tuesday.
</p>
<a name="index-Shell-command-to-decide-class"></a>
<a name="index-Class-decided-by-shell-command"></a>
<p>Finally, you can define groups (strictly classes) by the result of a shell
command. A shell command or program is deemed to be ‘true’ if it
exits with a status of zero, i.e. it calls <code>exit(0)</code>. Any other
value is taken to be false. You can include shell commands as the members
of groups in order to define classes based on the outcomes of your
own scripts by enclosing the script in single or double quotes:
</p>
<div class="smallexample">
<pre class="smallexample">
have_cc = ( '/bin/test -f /usr/ucb/cc' )
</pre></div>
<p>The class <code>have_cc</code> will then be defined if the shell command returns
true. Of course, you can put any script or program in the single quotes as
long as they adhere to the convention that zero exit status means true.
If you have several members which are shell commands, then the effect is
to make the class the logical OR of the scripts’ results.
</p>
<hr>
<a name="homeservers"></a>
<div class="header">
<p>
Next: <a href="#ignore" accesskey="n" rel="next">ignore</a>, Previous: <a href="#groups" accesskey="p" rel="previous">groups</a>, Up: <a href="#Cfagent-reference" accesskey="u" rel="up">Cfagent reference</a> [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Variable-Index" title="Index" rel="index">Index</a>]</p>
</div>
<a name="homeservers-1"></a>
<h3 class="section">4.22 homeservers</h3>
<a name="index-Home-servers_002c-defining"></a>
<a name="index-Defining-a-home-server"></a>
<a name="index-homeservers"></a>
<p>The <code>homeservers</code> declaration need only be used if you are using
cfengine’s model for mounting NFS filesystems. This declaration informs
hosts of which other hosts on the network possess filesystems containing
home directories (login areas) which client hosts should mount.
</p>
<p>A sample homeserver declaration looks like this:
</p>
<div class="smallexample">
<pre class="smallexample">
homeservers:
Physics:: einstein
Math:: riemann euler
</pre></div>
<p>The meaning of this declaration is the following. Any host which finds
itself to be a member of the classes on the left hand side of the
assignment need to mount all home directory resources from the hosts on
the right hand side of the assignment. The pattern variable
<code>homepattern</code> is used to determine which resources are home
directories in the list of <code>mountables</code>. See <a href="#mountables">mountables</a>.
</p>
<p>Let us consider an example in which <code>homepattern</code> is set to the
wildcard value ‘<samp>home?</samp>’ and the mountables list is given by
</p>
<div class="smallexample">
<pre class="smallexample">mountables:
einstein:/mysite/einstein/home1
einstein:/mysite/einstein/home2 mountoptions=soft,bg,intr,rsize=8192,wsize=8192
riemann:/mysite/riemann/local readonly=true
euler:/mysite/euler/home1
</pre></div>
<a name="index-mountables"></a>
<a name="index-Mountable-resources_002c-defining"></a>
<p>Any host in the group <code>Physics</code> would now want to mount all home
directories from the host <code>einstein</code>. There are two of these.
Both the filesystems listed for <code>einstein</code> match the
<code>homepattern</code> variable since they end in ‘<samp>home?</samp>’. cfengine
would therefore take this to mean that all hosts in <code>Physics</code>
should mount both of these filesystems.
</p>
<p>Hosts in <code>Math</code>, on the other hand, should mount only
homedirectories from the hosts <code>riemann</code> and <code>euler</code>. There
is only a single filesystem on <code>riemann</code> and it does not match
<code>homepattern</code>, so it is not mounted. On <code>euler</code> there is a
match, so this filesystem will be added to the appropriate hosts.
</p>
<p><em>Cfengine picks out home directory resources from the
<code>mountables</code> list by trying to match the <code>homepattern</code>
variable, starting from the end of the directory name. You do not
therefore have to use the designation <code>/site/host/home?</code> but this
is a simple choice and is highly recommended.</em>
</p>
<hr>
<a name="ignore"></a>
<div class="header">
<p>
Next: <a href="#import" accesskey="n" rel="next">import</a>, Previous: <a href="#homeservers" accesskey="p" rel="previous">homeservers</a>, Up: <a href="#Cfagent-reference" accesskey="u" rel="up">Cfagent reference</a> [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Variable-Index" title="Index" rel="index">Index</a>]</p>
</div>
<a name="ignore-1"></a>
<h3 class="section">4.23 ignore</h3>
<p>When you specify a recursive search as part of a <code>files</code>,
<code>tidy</code> or <code>copy</code> action, you would sometimes like to exclude
certain directories from the list of sub directories. In most cases you
will want to do this on a per-command basis (see the pages for these
actions separately), but you can also make a global ignore list. This
can be accomplished by adding the directory to the ignore-list. The syntax
is
</p>
<table class="cartouche" border="1"><tr><td>
<p><!-- /@w -->
</p><div class="smallexample">
<pre class="smallexample">
ignore:
<var>wildcards/directories/filenames</var>
</pre></div>
</td></tr></table>
<p>For example:
<a name="index-ignore-command"></a>
</p>
<p><!-- /@w -->
</p><div class="smallexample">
<pre class="smallexample">
ignore:
any::
#
# Prevent tidying .X11 directories in /tmp where
# window managers write semaphores
#
.X11
#
# Don't tidy emacs locks
#
!*
/local/lib/gnu/emacs/lock/
/local/tmp
/local/bin/top
/local/lib/tex/fonts
/local/etc
/local/www
/local/mutils/etc/finger.log
</pre></div>
<p>None of the above directories will be checked or entered during
recursive descents unless a specific command is initiated to search
those directories with their names as the top of the search tree.
<a name="index-_002eX11-directory"></a>
</p>
<p>A handy tip if you are tidying <samp>/tmp</samp> recursively is to include the
directory <samp>.X11</samp> here. This directory is used by the X-windows
system and deleting it while a window manager has an open session can
cause the user some trouble.
</p>
<p>Ignore refers to all recursive searches in tidy, files, copy and links.
</p>
<hr>
<a name="import"></a>
<div class="header">
<p>
Next: <a href="#interfaces" accesskey="n" rel="next">interfaces</a>, Previous: <a href="#ignore" accesskey="p" rel="previous">ignore</a>, Up: <a href="#Cfagent-reference" accesskey="u" rel="up">Cfagent reference</a> [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Variable-Index" title="Index" rel="index">Index</a>]</p>
</div>
<a name="import-1"></a>
<h3 class="section">4.24 import</h3>
<a name="index-Importing-files"></a>
<a name="index-Several-files"></a>
<a name="index-Files_002c-importing"></a>
<a name="index-Files_002c-breaking-up-into-several"></a>
<a name="index-import"></a>
<p>To break up a large configuration file into smaller files you can use
the include directive. This conditionally reads in files if the class
on the left hand side of the assignment matches the host parsing the
file. This enables also a variety of cfengine configuration scripts to
read in a standard set of default settings. The syntax of the statement
is:
</p>
<div class="smallexample">
<pre class="smallexample">
import:
any::
cf.global_classes
linux::
cf.linux_classes
</pre></div>
<p>Note that, if you define variables in an imported file they will not be
defined for operations in their parent files. This because cfengine reads in all the
import files after the main file has been parsed—not at the place where you
call import in your script. This means that variables or macros defined in
imported files are only defined after the main program. Variables from earlier
files are inherited by later includes, but not <em>vice-versa</em>.
</p>
<a name="index-Variables-in-import-files"></a>
<a name="index-Import-files_002c-variables-in"></a>
<hr>
<a name="interfaces"></a>
<div class="header">
<p>
Next: <a href="#links" accesskey="n" rel="next">links</a>, Previous: <a href="#import" accesskey="p" rel="previous">import</a>, Up: <a href="#Cfagent-reference" accesskey="u" rel="up">Cfagent reference</a> [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Variable-Index" title="Index" rel="index">Index</a>]</p>
</div>
<a name="interfaces-1"></a>
<h3 class="section">4.25 interfaces</h3>
<a name="index-Network-interfaces_002c-several"></a>
<a name="index-Dual-homed-hosts"></a>
<a name="index-interface-configuration"></a>
<table class="cartouche" border="1"><tr><td>
<p><!-- /@w -->
</p><div class="smallexample">
<pre class="smallexample">
interfaces:
<var>classes</var>::
<var>interfacename</var> netmask=<var>netmask</var> broadcast=<var>broadcast</var>
</pre></div>
</td></tr></table>
<p>If you have more than one network interface, or you do not wish to use the
default interface name, this section may be used to define further
interfaces to be checked. This feature can replace the older method
of setting netmask and broadcast address in <code>control:</code>. If the <code>netmask</code>
variable is not set, cfengine ignores the default interface configuration.
Example:
</p>
<div class="smallexample">
<pre class="smallexample">
interfaces:
"le1" netmask=255.255.255.0 broadcast=ones
"le2" netmask=255.255.255.0 broadcast=ones
</pre></div>
<hr>
<a name="links"></a>
<div class="header">
<p>
Next: <a href="#mailserver" accesskey="n" rel="next">mailserver</a>, Previous: <a href="#interfaces" accesskey="p" rel="previous">interfaces</a>, Up: <a href="#Cfagent-reference" accesskey="u" rel="up">Cfagent reference</a> [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Variable-Index" title="Index" rel="index">Index</a>]</p>
</div>
<a name="links-1"></a>
<h3 class="section">4.26 links</h3>
<a name="index-Making-links"></a>
<a name="index-Links_002c-making"></a>
<a name="index-links-1"></a>
<p>The symbolic links function is one of the greatest plusses in cfengine
as a system administration tool. It allows you to do two things: check
single links for correctness and consistency (or make them if they do
not exist), and check or make links to every file in a designated
directory. This latter feature is called multiple linking or linking
children. The <code>linkchildren</code> feature is also available from the
<code>files</code> action See <a href="#files">files</a>. The syntax of a link item is:
</p>
<table class="cartouche" border="1"><tr><td>
<p><!-- /@w -->
</p><div class="smallexample">
<pre class="smallexample">
<var>from-link</var> ->[!] <var>to-object</var>
<var>or</var>
<var>from-link</var> +>[!] <var>to-object</var>
type=<b>symbolic/absolute/abs</b>/<var>hard/relative/rel</var>
copy=<var>pattern</var>
recurse=<var>number/inf/</var><b>0</b>
copytype=<var>checksum/</var><b>ctime</b>
include=<var>pattern</var>
exclude=<var>pattern</var>
ignore=<var>pattern</var>
action=<var>silent</var>
deadlinks=<b>kill</b>/<var>force</var>
define=<var>classlist</var>
nofile=<b>kill</b>/<var>force</var>
syslog=<var>true/on</var>/<var>false/off</var>
inform=<var>true/on</var>/<var>false/off</var>
audit=<var>true/on</var>/<var>false/off</var>
ifelapsed=<var>mins</var>
expireafter=<var>mins</var>
</pre></div>
</td></tr></table>
<p><em>The special variable <code>$(binserver)</code> can be used in <code>links</code>.</em>
</p>
<table class="menu" border="0" cellspacing="0">
<tr><td align="left" valign="top">• <a href="#Single-links" accesskey="1">Single links</a>:</td><td> </td><td align="left" valign="top">
</td></tr>
<tr><td align="left" valign="top">• <a href="#Multiple-Links" accesskey="2">Multiple Links</a>:</td><td> </td><td align="left" valign="top">
</td></tr>
<tr><td align="left" valign="top">• <a href="#Link-Children" accesskey="3">Link Children</a>:</td><td> </td><td align="left" valign="top">
</td></tr>
<tr><td align="left" valign="top">• <a href="#Relative-and-absolute-links" accesskey="4">Relative and absolute links</a>:</td><td> </td><td align="left" valign="top">
</td></tr>
<tr><td align="left" valign="top">• <a href="#Hard-links" accesskey="5">Hard links</a>:</td><td> </td><td align="left" valign="top">
</td></tr>
</table>
<hr>
<a name="Single-links"></a>
<div class="header">
<p>
Next: <a href="#Multiple-Links" accesskey="n" rel="next">Multiple Links</a>, Previous: <a href="#links" accesskey="p" rel="previous">links</a>, Up: <a href="#links" accesskey="u" rel="up">links</a> [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Variable-Index" title="Index" rel="index">Index</a>]</p>
</div>
<a name="Single-links-1"></a>
<h4 class="subsection">4.26.1 Single links</h4>
<a name="index-Single-links"></a>
<a name="index-Links_002c-single"></a>
<p>To define a single link, you create an entry of the following
form:
</p>
<div class="smallexample">
<pre class="smallexample">
links:
<var>class</var>::
<var>linkname</var> -> <var>object_to_link_to</var>
<var>linkname</var> -> ./<var>relative_link</var>
<var>linkname</var> -> ../<var>relative_link</var>
</pre></div>
<p>If links exists and point to their intended destinations then no
action is taken. If a link exists but points incorrectly then a
warning is issued, unless the pling operator ‘<samp>!</samp>’ is given, in
which case the correct value is forced.
If the link exists and points to a file which does
not exist a warning is issued unless the command line option <code>-L</code>
is used, in which case the link is deleted.
<a name="index-_002dL-option"></a>
<a name="index-_002dL"></a>
</p>
<p>Here is an example of some valid link statements.
</p>
<div class="smallexample">
<pre class="smallexample">
links:
Physics.sun4::
/usr/local -> /$(site)/$(host)/local
/home -> /$(site)/$(host)/u1
/etc/sendmail.cf -> /usr/local/mail/etc/global-sendmail.cf
/usr/lib/sendmail ->! /local/lib/sendmail
</pre></div>
<p>cfengine makes any directories which are required leading up to the link
name on the left hand side of the arrow automatically. In the last
example the ‘pling’ forces cfengine to make the link even if a file for
link exists previously. Plain files are saved by appending
<samp>.cfsaved</samp> to the filename, or by moving to a repository, whereas
old links are removed. The same effect can be enforced globally using
the <code>-E</code> option, but only if the program is run interactively. (In
this case a prompt is issued to make sure that you wish to use such a
big hammer on your system!)
</p>
<p>The link operation accepts a number of parameters
</p>
<dl compact="compact">
<dt><code>type=<var>hard/relative/absolute</var></code></dt>
<dd><p>If the link type is hard, a hard link is created See <a href="#Hard-links">Hard links</a>.
Symbolic links may specify two special types. If <code>relative</code>
is selected, and the ‘to’ object is an absolute path name,
the link name will be rewritten as a pathname relative
to the source file, using ‘<samp>.</samp>’ and ‘<samp>..</samp>’ to move relative
to the current directory. For instance, a link from <samp>/usr/local/file</samp>
to <samp>/usr/file</samp> would be linked as <samp>./../file</samp>.
If the ‘to’ object is already relative,
this has no effect.
</p>
<p>If <code>absolute</code> is specified, cfengine
will try to resolve the true path location of the ‘to’ object,
expanding any symbolic links or dots in the path name, up to
a maximum of four levels of symbolic links.
</p>
<a name="index-Relative-links"></a>
<a name="index-Symbolic-links_002c-relative"></a>
<a name="index-Links_002c-absolute"></a>
<a name="index-Absolute-links"></a>
<a name="index-Symbolic-links_002c-absolute"></a>
<a name="index-Links_002c-absolute-1"></a>
</dd>
<dt><code>copy=<var>pattern</var></code></dt>
<dd><p>This option can be repeated any number of times to build up a list of
filenames or wildcards which are to be copied rather than linked
symbolically. The copy is made on an age-comparison basis. A global
variable may also be set to invoke this feature See <a href="#copylinks">copylinks</a>.
Directories cannot be copied in this way.
</p>
</dd>
<dt><code>copytype=<var>checksum/ctime</var></code></dt>
<dd><p>This specifies the basis for deciding whether to update a file
which is to be copied instead of linked See <a href="#copy">copy</a>.
</p>
</dd>
<dt><code>nofile=<b>kill</b>/<var>force</var></code></dt>
<dd><p>This decides what happens to links which point to non-existent
files. The default action is to remove such links, or refuse to
create them. By setting the <var>force</var> option you can force
cfengine to make symbolic links to files which do not exist.
This is useful for setting up links to filesystems which
are not permanently mounted.
<a name="index-Links_002c-removing-dead"></a>
<a name="index-Links_002c-forcing-for-non_002dexistent-files"></a>
</p>
</dd>
<dt><code>exclude=<var>pattern</var></code></dt>
<dd><p>This option can be repeated any number of times to build up a list of
filenames or wildcards which are to be excluded from the linking
process. A global variable may also be set to invoke this feature
See <a href="#excludelinks">excludelinks</a>.
</p>
</dd>
<dt><code>ignore</code></dt>
<dd><p>This works like the global ignore directive but here you may
provide a private list of ignorable directories and files.
Unlike include, exclude this affects the way cfengine parses
directory trees.
</p>
</dd>
<dt><code>recurse=<var>number/</var>inf</code></dt>
<dd><p>This option can only be used with multiple link operations See <a href="#Multiple-Links">Multiple Links</a>.
If this option is specified, cfengine links only non-directory
objects. Directories are instead created and links within those
directories are also created. The value of this option specifies the
maximum number of levels to which cfengine should recursively descend a
link tree. <code>inf</code> means infinite recursion. Cfengine also ignores
files and directories in the ignore list See <a href="#ignore">ignore</a>.
</p>
</dd>
<dt><code>define=<var>classlist</var></code></dt>
<dd><p>If a link is created or replaced, the colon, comma or dot separated
list of classes becomes defined.
</p>
</dd>
</dl>
<a name="index-Binary-servers-and-links"></a>
<a name="index-Links-and-binary-servers"></a>
<a name="index-binserver"></a>
<p>The final feature of the links facility is connected to the use of the
cfengine model for mounting NFS filesystems. In particular it concerns
the variable <code>$(binserver)</code>. The easiest way to understand this
feature is to illustrate a couple of examples. Consider the following:
</p>
<div class="smallexample">
<pre class="smallexample">links:
any::
/local -> /${site}/${binserver}/local
</pre></div>
<p>The result of this command is quite different depending on which host is
executing it. The variable <code>$(site)</code> clearly has a fixed value,
but the variable <code>$(binserver)</code> might expand to any valid binary
server for the host executing the program. See <a href="#binservers">binservers</a>. The
procedure cfengine adopts is to go through its list of mountables,
keeping only those mountable resources which belong to defined binary
servers for the current host. It then attempts to match a filesystem by
substituting <code>$(binserver)</code> with each of its valid binservers in
turn and it matches the first one binary server which yields an existing
file.
</p>
<a name="index-Binary-servers_002c-priority-1"></a>
<p>Note that every host is a binary server for itself, so that the value of
<code>$(binserver)</code> which has absolute priority is alway the same as the
value of <code>$(host)</code>. This ensures that the link will always be made
to a local filesystem if the rules of the model are upheld.
</p>
<hr>
<a name="Multiple-Links"></a>
<div class="header">
<p>
Next: <a href="#Link-Children" accesskey="n" rel="next">Link Children</a>, Previous: <a href="#Single-links" accesskey="p" rel="previous">Single links</a>, Up: <a href="#links" accesskey="u" rel="up">links</a> [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Variable-Index" title="Index" rel="index">Index</a>]</p>
</div>
<a name="Multiple-Links-1"></a>
<h4 class="subsection">4.26.2 Multiple Links</h4>
<a name="index-Multiple-links"></a>
<a name="index-Links_002c-multiple"></a>
<p>With the link symbol <code>+></code>, you opt to link all of the files in a
directory to corresponding files in another directory. This procedure is
sometimes useful for installing software. In the example
</p>
<div class="smallexample">
<pre class="smallexample">
links:
myclass::
/usr/local/bin +> /usr/local/lib/perl/bin
/opt +>! /local
</pre></div>
<p>every file in the directory <code>/usr/local/lib/perl/bin</code> is linked
symbolically to a corresponding file in <code>/usr/local/bin</code>. The
‘pling’ character forces cfengine to replace old links or plain files
already existing. Old links are removed, whereas old files are saved
by appending <samp>.cfsaved</samp> to the filename See <a href="#repository">repository</a>.
<a name="index-_002ecfsaved-files"></a>
</p>
<p>Each time cfengine runs it goes through all of the files in the
directory concerned and checks the appropriate link accordingly. If new
files appear, new links will be added. If a file disappears but the
link to it remains, a warning will be issued, unless the <code>-L</code>
command line option is used, in which case the link is deleted.
</p>
<hr>
<a name="Link-Children"></a>
<div class="header">
<p>
Next: <a href="#Relative-and-absolute-links" accesskey="n" rel="next">Relative and absolute links</a>, Previous: <a href="#Multiple-Links" accesskey="p" rel="previous">Multiple Links</a>, Up: <a href="#links" accesskey="u" rel="up">links</a> [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Variable-Index" title="Index" rel="index">Index</a>]</p>
</div>
<a name="Link-Children-1"></a>
<h4 class="subsection">4.26.3 Link Children</h4>
<a name="index-Linkchildren-1"></a>
<a name="index-linkchildren-1"></a>
<p>The linkchildren directive is a closely related to the cfengine model
for NFS filesystems. It is a way of making links which embodies a
rudimentary kind of ‘intelligence’.
</p>
<a name="index-Binary-servers-and-links-1"></a>
<a name="index-Links-and-binary-servers-1"></a>
<a name="index-binserver-1"></a>
<p>Consider the following:
</p>
<div class="smallexample">
<pre class="smallexample">links:
any::
/usr/local/lib/emacs +> linkchildren
</pre></div>
<p>The word <code>linkchildren</code> automatically tells cfengine that it should
look for an appropriate file to link to on a binary server for the
current host. The exact meaning of the above statement is as follows.
cfengine begins searching though the list of mountable resources,
discarding any filesystems which do not belong to valid binary servers.
It looks for a filesystem ending in ‘emacs’ (the last link of the left
hand side). If all is well, these file systems are already mounted and
they can be searched. If no resource is found ending in ‘emacs’, we go
to the next link <code>lib</code> and look for a filesystem ending in ‘lib’.
If this is not found we go to <code>local</code> and so on. When a match is
made, cfengine then tries to locate the file by checking whether it
exists relative to the matched filesystem. For example, suppose ‘local’
matched with <code>host:/site/host/local</code>. It would then try to locate
<code>host:/site/host/local/lib/emacs</code> and link all of the children
therein to the local file directory <code>/usr/local/lib/emacs</code>.
</p>
<a name="index-Making-use-of-local-disk-space"></a>
<a name="index-Local-disk-space_002c-make-use-of"></a>
<p>Here is another example which makes reference to the cfengine model for
mounting NFS filesystems. Suppose you have a host with some spare disk
space. You want to mount <code>/usr/local</code> from the binary architecture
server, but you also want to use the disk you have locally. The
following lines
</p>
<div class="smallexample">
<pre class="smallexample">links:
electron::
/$(site)/electron/local +> linkchildren
any::
/usr/local -> /$(site)/$(binserver)/local
</pre></div>
<p>have the effect of creating a directory <code>/$(site)/electron/local</code>
and filling it with links to all of the files and directories on the
binary server’s mounted filesystem. It results in an exact copy (by
linkage) on the local disk, but does not use up your local disk space.
The space you have remaining could, for example, be used for software
with a special license for that host. The second link links
<code>/usr/local</code> to the ‘nearest’ binary server. But the nearest
binary server is always <code>$(host)</code> which means this evaluates to a
file which now exists because of the first command, so on the host
‘electron’ the directory <code>/usr/local</code> ends up being a link to
<code>/$(site)/electron/local</code> which is full of links to the binary
server.
</p>
<p>If you’ve caught your breath after that mouthful you probably have mixed
feelings about creating a bunch of links in this way. What happens if
the files they point to are removed? Then you are left with a lot of
useless links. Actually this is no problem for cfengine, since you can
ask cfengine to simply remove links which point to non-existent files
See <a href="#files">files</a>. Nevertheless, this feature clearly requires some caution
and is mainly a spice for advanced users of the cfengine model.
</p>
<hr>
<a name="Relative-and-absolute-links"></a>
<div class="header">
<p>
Next: <a href="#Hard-links" accesskey="n" rel="next">Hard links</a>, Previous: <a href="#Link-Children" accesskey="p" rel="previous">Link Children</a>, Up: <a href="#links" accesskey="u" rel="up">links</a> [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Variable-Index" title="Index" rel="index">Index</a>]</p>
</div>
<a name="Relative-and-absolute-links-1"></a>
<h4 class="subsection">4.26.4 Relative and absolute links</h4>
<p>When specifying symbolic linking, you can ask cfengine
to change the link type to be either relative to the
source or to be an absolute path. What this means is the
following. Consider the following link:
</p>
<div class="smallexample">
<pre class="smallexample">
/var/tmp/cfengine -> /local/cfengine
</pre></div>
<p>If we add the option <code>type=relative</code>, then instead
of creating a link which points to <samp>/local/cfengine</samp>,
the link is created pointing to the location
</p>
<div class="smallexample">
<pre class="smallexample"> ./../../local/cfengine
</pre></div>
<p>In other words, the link is relative to the calling
directory <samp>/var/tmp</samp>.
</p>
<p>If a link is specified as being absolute with the option
<code>type=absolute</code>, then cfengine attempts to resolve
to value of the link so as to be the true path of the
target. If the target name contains a symbolic link, then
this is expanded as far as possible to give the true
path to the file. For example, if <samp>/local</samp> is
really a link to <samp>/site/myhost/local</samp> then the link
would point to <samp>/site/myhost/local/cfengine</samp>.
</p>
<hr>
<a name="Hard-links"></a>
<div class="header">
<p>
Previous: <a href="#Relative-and-absolute-links" accesskey="p" rel="previous">Relative and absolute links</a>, Up: <a href="#links" accesskey="u" rel="up">links</a> [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Variable-Index" title="Index" rel="index">Index</a>]</p>
</div>
<a name="Hard-Links"></a>
<h4 class="subsection">4.26.5 Hard Links</h4>
<a name="index-Hardlinks"></a>
<a name="index-type_003d-1"></a>
<p>Cfengine will also allow you to create hard links to regular files. A
hard link is in every way identical to the original file, it merely has
a different name (technically, it is a duplicate inode). To create a
hard link you use the link-option <code>type=hard</code>. For example:
</p>
<div class="smallexample">
<pre class="smallexample">
links:
/<var>directory</var>/<var>newname</var> -> /<var>directory</var>/<var>othername</var> type=hard
</pre></div>
<p>Cfengine will not create hard links to directories or other special files.
This is always a slightly dubious practice and is best avoided anyway.
POSIX says that the hard link can be on a different device to the file
it points to, but both BSD and System V restrict hard links to be on
the same device as their predecessors. Cfengine has no policy on this,
but—in the theoretical case in which the hard link and the predecessor
were on different file systems—it becomes near impossible to determine
with certainly between a hard link and a very similar regular file, and thus
cfengine issues a warning in verbose mode about this eventuality.
Provided both link and predecessor are on the same filesystem cfengine
determines the status of hard links by comparing the device and inode
numbers of the file pointed to.
</p>
<hr>
<a name="mailserver"></a>
<div class="header">
<p>
Next: <a href="#methods" accesskey="n" rel="next">methods</a>, Previous: <a href="#links" accesskey="p" rel="previous">links</a>, Up: <a href="#Cfagent-reference" accesskey="u" rel="up">Cfagent reference</a> [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Variable-Index" title="Index" rel="index">Index</a>]</p>
</div>
<a name="mailserver-1"></a>
<h3 class="section">4.27 mailserver</h3>
<a name="index-Mail-server_002c-defining"></a>
<a name="index-Defining-a-mail-server"></a>
<a name="index-mailserver"></a>
<p>The <code>mailserver</code> declaration need only be used if you are using
cfengine’s model for mounting NFS filesystems. This declaration informs
hosts of which NFS filesystem contains mail for its users. All hosts
apart from the mail-host itself must then mount the mail spool directory
across the network. The declaration looks like this:
</p>
<div class="smallexample">
<pre class="smallexample">
mailserver:
<var>class</var>:: mailhost:/var/spool/mail
</pre></div>
<p>The result of the <code>mailcheck</code> command in the action-sequence is now
to mount the filesystem <code>/var/spool/mail</code> on the host
<code>mailhost</code>. This action is carried out on any machine which does
not already have that filesystem mounted.
<a name="index-mailcheck-1"></a>
</p>
<p>The mail spool directory is mounted, by default, onto the official mail
spool directory for the system which is parsing the program. In other
words, on an HPUX system, the spool directory is mounted on
<code>/usr/mail</code> by default, whereas on a Sun system it would be mounted
on <code>/var/spool/mail</code>. The default location can be changed by using
the resource file. See <a href="#cfrc-resource-file">cfrc resource file</a>.
</p>
<hr>
<a name="methods"></a>
<div class="header">
<p>
Next: <a href="#miscmounts" accesskey="n" rel="next">miscmounts</a>, Previous: <a href="#mailserver" accesskey="p" rel="previous">mailserver</a>, Up: <a href="#Cfagent-reference" accesskey="u" rel="up">Cfagent reference</a> [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Variable-Index" title="Index" rel="index">Index</a>]</p>
</div>
<a name="methods-1"></a>
<h3 class="section">4.28 methods</h3>
<a name="index-Methods"></a>
<a name="index-Private-modules"></a>
<a name="index-methods"></a>
<p>From version 2.1.0, cfagent provides for the execution of closed
functions or "methods". Methods are similar to the old idea of modules,
but they are implemented in a way that allows collaboration between
different hosts within a network, using a common standard. Methods must
be cfengine programs however, wheras the module interface can be written
in any script language.
</p>
<p><em>Methods are designed to offer a firewall-like proxy interface for remote
method execution. We can call methods a form of ‘voluntary RPC’, in which
hosts execute methods for one another on a purely voluntary basis. This
builds in anti-spamming protection. The principle used is that hosts
should be immune to Denial of Service attacks; they should
only be able to disadvanatge themselves with the attempt.</em>
</p>
<p>(Remote method execution was not implemented until version 2.1.3. It is still
considered experimental and should be tested carefully for
production environments with at least version 2.2.2.
List expansion is particularly fragile in cfengine 2. This problem cannot be
resolved in version 2, so this should not be reported as a bug.
)
</p>
<a name="index-Warning-remote-methods"></a>
<a name="index-Methods_002c-remote-caution"></a>
<p>Methods allow you to call an independent cfengine program, pass it
arguments and classes, and collect the results for use in your main
program. It thus introduces parent-child semantics into cfengine
"imports". A method is more than an import. (Import is analagous to a C
#include, while a method is like a C function.) Communication is peer
to peer, by mutual consent. There is no "method server" that executes
methods on remote hosts. Hosts exchange information by invitation
only. This is an unreliable service (in the sense of UDP).
</p>
<p>The order of method exeuction is not guaranteed. This results from the
decoupling between client request and service provision.
</p>
<table class="cartouche" border="1"><tr><td>
<div class="smallexample">
<pre class="smallexample">
methods:
<var>class</var>::
<var>function_name</var>(<var>parameters or none</var>)
action=<samp>filename</samp>
sendclasses=<var>comma separated class list</var>
returnvars=<var>comma separated variable list or void</var>
returnclasses=<var>comma separated class list</var>
server=<var>ip-host/localhost/none</var>
forcereplyto=<var>ip address</var>
owner=<var>setuid</var>
group=<var>setgid</var>
chdir=<var>cd for child</var>
chroot=<var>sandbox directory</var>
</pre></div>
</td></tr></table>
<p>Most of these functions will be familiar from other cfengine
commands. Some special ones are noted below:
</p>
<dl compact="compact">
<dt><code>action</code></dt>
<dd><p>The name of the method file that should be defined in the modules
directory of the server host.
</p></dd>
<dt><code>forcereplyto</code></dt>
<dd><p>Sometimes nameservice problems (especially with remote devices) can lead
to confusion about where a method should be sent. The caller can
therefore declare to the server which address it wants the reply to be
marked for.
</p></dd>
<dt><code>returnvars</code></dt>
<dd><p>Returns the values of the variables to the parent process. This acts as
an access control list for variable names transmitted by the child
process. The names returned by the child must match this list.
</p></dd>
<dt><code>returnclasses</code></dt>
<dd><p>Returns the classes to the parent process, if and only if they are
defined at the end of the current method. This acts as an access control
list for class names transmitted by the child process. The names
returned by the child must match this list.
</p>
</dd>
<dt><code>sendclasses</code></dt>
<dd><p>Transmits the current status of the named classes to the child
process. In other words, if the listed classes are defined, they become
defined in the child process, else they remain undefined. The class may
still be defined in the child by independent local definitions.
</p></dd>
</dl>
<p>If the server is set to <code>localhost</code>, the method will be
evaluated on the local machine. If the server is set of <code>none</code>,
the method will not be executed at all.
<a name="index-none-in-server"></a>
<a name="index-none"></a>
</p>
<p>The function arguments may not be empty, but a null value can be
transmitted with a dummy value, e.g. <code>Function(null)</code> or
<code>function(void)</code>. Here is an example method call.
</p>
<div class="smallexample">
<pre class="smallexample">
# cfagent.conf
control:
actionsequence = ( methods )
#################################################
methods:
any::
SimpleMethod(null)
action=cf.simple
returnvars=null
returnclasses=null
server=localhost
</pre></div>
<p>With method file (located in the ModulesDirectory),
</p>
<div class="smallexample">
<pre class="smallexample">
# cf.simple
control:
MethodName = ( SimpleMethod )
MethodParameters = ( null )
actionsequence = ( timezone )
classes:
dummy = ( any )
####################################################
alerts:
dummy::
"This simple method does nothing"
ReturnVariables(void)
ReturnClasses(void)
</pre></div>
<p>On executing this example, the output is:
</p><div class="example">
<pre class="example">nexus$ ./cfagent -f ./cftest
cfengine:myhost:SimpleMethod: cfengine:nexus: This simple method does nothing
</pre></div>
<p>If the server name is a wildcard, e.g. <code>*</code> then this acts as a multicast or broadcast.
</p>
<table class="menu" border="0" cellspacing="0">
<tr><td align="left" valign="top">• <a href="#localhost-examples" accesskey="1">localhost examples</a>:</td><td> </td><td align="left" valign="top">
</td></tr>
<tr><td align="left" valign="top">• <a href="#remotehost-examples" accesskey="2">remotehost examples</a>:</td><td> </td><td align="left" valign="top">
</td></tr>
</table>
<hr>
<a name="localhost-examples"></a>
<div class="header">
<p>
Next: <a href="#remotehost-examples" accesskey="n" rel="next">remotehost examples</a>, Previous: <a href="#methods" accesskey="p" rel="previous">methods</a>, Up: <a href="#methods" accesskey="u" rel="up">methods</a> [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Variable-Index" title="Index" rel="index">Index</a>]</p>
</div>
<a name="Localhost-examples"></a>
<h4 class="subsection">4.28.1 Localhost examples</h4>
<p>The following example
collects the tar file, unpacks it,
configures and compiles it, then tidies its files.
</p>
<div class="smallexample">
<pre class="smallexample">####################################################
#
# This is a cfengine file that calls a method.
# It should be in the usual place for cfinputs
#
####################################################
control:
actionsequence = ( methods )
#####################################################
methods:
InstallTar(cfengine-2.1.0b7,/local/gnu)
action=cf.install
returnvars=null
returnclasses=null
server=localhost
</pre></div>
<p>We must install the method in the trusted modules directory
(normally /var/cfengine/modules or WORKDIR/modules).
</p>
<div class="smallexample">
<pre class="smallexample">####################################################
#
# This is an example method file, that needs to be
# in the module directory /var/cfengine/modules
# since this is the trusted directory
#
# e.g. InstallFromTar(cfengine-2.1.0,/usr/local/gnu)
#
####################################################
control:
MethodName = ( InstallTar )
MethodParameters = ( filename gnuprefix )
path = ( /usr/local/gnu/bin )
TrustedWorkDir = ( /tmp )
TrustedSources = ( /iu/nexus/ud/mark/tmp )
TrustedSourceServer = ( localhost )
actionsequence = ( copy editfiles shellcommands tidy )
####################################################
classes:
Force = ( any )
####################################################
copy:
$(TrustedSources)/$(filename).tar.gz
dest=$(TrustedWorkDir)/$(filename).tar.gz
server=$(TrustedSourceServer)
####################################################
shellcommands:
"$(path)/tar zxf $(filename).tar.gz"
chdir=$(TrustedWorkDir)
"$(TrustedWorkDir)/$(filename)/configure --prefix=$(gnuprefix)"
chdir=$(TrustedWorkDir)/$(filename)
define=okay
okay::
"$(path)/make"
chdir=$(TrustedWorkDir)/$(filename)
####################################################
tidy:
$(TrustedWorkDir) pattern=$(filename) r=inf rmdirs=true age=0
####################################################
#editfiles:
#
#{ $(TrustedWorkDir)/$(filename)/configure-opts
#
#AppendIfNoSuchLine "Something ???"
#}
####################################################
alerts:
Force::
ReturnVariables(none)
ReturnClasses(success)
</pre></div>
<p>A more complex example is given below:
</p>
<div class="smallexample">
<pre class="smallexample"> GetAnalysis("${parent1}",param2,ReadFile("/etc/passwd",300))
# The name of the method that is in modulesdir
action=cf.methodtest
# The variables that we get back should be called these names
# with method name prefix
returnvars=a,b,c,d
# This is an access list for returned classes. Classes will
# only be handed back if they are included here
returnclasses=define1,define2,class1
# The host(s) that should execute the method
server=localhost
# Only localhost can decide these - not a remote caller
# owner=25
# group=root
# chdir=/var/cfengine
# chroot=/tmp
</pre></div>
<p>Here the function being called is the cfengine program <samp>cf.methodtest</samp>.
It is passed three arguments: the contents of variable <var>parent1</var>, the literal
string "param2" and the first 300 bytes of the file <samp>/etc/passwd</samp>.
On return, if the method gets executed, the values will be placed in the four
variables:
</p>
<div class="smallexample">
<pre class="smallexample">$(GetAnalysis.a) $(GetAnalysis.b) $(GetAnalysis.c) $(GetAnalysis.d)
</pre></div>
<p>If the classes <code>define1</code> etc, are returned by the method, then we
set them also in the main program as
</p><div class="smallexample">
<pre class="smallexample">GetAnalysis_define::
</pre></div>
<p>In other words, the class name is also prefixed with the method name to distinguish it.
(<code>returnclasses</code> works like an access
control list for setting classes, deciding whether or not the main
script should accept the results from the child method.). The remaining options are as those
for executing shell commands, and apply only on the host that executes
the function.
</p>
<p>Both the client and server hosts must have a copy of the same method
declaration. The client should have a non-empty <code>server=</code> declaration.
The server side should have no <code>server=</code> declaration unless it is sending
the request on recursively to other hosts.
At present only requests to localhost are allowed, so only there is automatic
access to the rule.
</p>
<p>The cfagent file that contains the method code must have the following
declarations:
</p>
<table class="cartouche" border="1"><tr><td>
<p>control:
</p>
<p>MethodName = ( <var>identifier</var> )
MethodParameters = ( <var>spaced list of recipient variables or files</var> )
</p>
<p># ....
</p>
<p>alerts:
</p>
<p># Return variables are alerts to parent
</p>
<p>ReturnVariables(<var>comma separated list of variables or functions or void</var>)
ReturnClasses(<var>comma separated list of classes</var>)
</p>
</td></tr></table>
<p>e.g.
</p>
<div class="smallexample">
<pre class="smallexample">control:
MethodName = ( GetAnalysis )
MethodParameters = ( value1 value2 /tmp/file1 )
# ....
alerts:
# Return variables are alerts to parent
ReturnVariables("${var1}","${var2}","var3",literal_value)
ReturnClasses(class1,class2)
</pre></div>
<p>The parameters transmitted by the parent are read into the formal
parameters <code>value1</code>, <code>value2</code> and the the file excerpt is
placed in the temporary file <samp>/tmp/file1</samp>.
</p>
<p>The return classes are passed in their current state to the parent;
i.e. if class1 is defined then it is offered to the parent, but if it
is not defined in the method, it is not passed on. The parent can then
choose to accept or ignore the value.
</p>
<hr>
<a name="remotehost-examples"></a>
<div class="header">
<p>
Previous: <a href="#localhost-examples" accesskey="p" rel="previous">localhost examples</a>, Up: <a href="#methods" accesskey="u" rel="up">methods</a> [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Variable-Index" title="Index" rel="index">Index</a>]</p>
</div>
<a name="Remote-host-examples"></a>
<h4 class="subsection">4.28.2 Remote host examples</h4>
<p>Methods can also be scheduled for execution on remote hosts.
</p><ul>
<li> Both hosts must have an identical copy of the method stanza
</li><li> Public keys must be exchanged between the cooperating hosts
</li><li> Access must be granted to <samp>/var/cfengine/rpc_out</samp> in cfservd.
</li></ul>
<p>Remote method execution is the same as local method execution except for
some additional requirements. A list of collaborating peers must be added
to the control section of <samp>update.conf</samp>.
In order the the requests to be collected automatically, you must have <code>copy</code>
in the action sequence of the <samp>update.conf</samp> file.
</p>
<div class="smallexample">
<pre class="smallexample">control:
MethodPeers = ( <var>hostname list</var> ) # Must have copy in actionsequence
</pre></div>
<p>This list tells the agent which remote hosts to collaborate with, i.e.
whom should we contact to look for work that we have promised to perform?
In order the the requests to be collected automatically, you must have <code>copy</code>
in the action sequence of the <samp>update.conf</samp> file.
</p>
<p>For example, to make two hosts collaborate:
</p>
<div class="smallexample">
<pre class="smallexample">methods:
host1|host2::
MethodTest("my test!")
action=cf.methodtest
server=host2.iu.hio.no
returnclasses=null
returnvars=retval
ifelapsed=120
</pre></div>
<p>Note that an important aspect of remote method invocation is that there is only
voluntary cooperation between the parties. A reply bundle from a finished method
can collected from a server by the client many times, causing the classes
and variables associated with it to be defined at regular intervals, controlled
by the ifelapsed time. To avoid multiple actions, you should lock methods or
their follow-up actions with long ifelapsed times. This is a fundamental ‘feature’
of voluntary cooperation: each party must take responsibilty for the sense of what
it receives from the other. This feature will not be to everyone’s taste, and it
is unconventional. However, voluntary cooperation provides a way of collaborating
without trust in a framework that forces us to confront the security issues directly.
As such, it is a successful experiment.
</p>
<hr>
<a name="miscmounts"></a>
<div class="header">
<p>
Next: <a href="#mountables" accesskey="n" rel="next">mountables</a>, Previous: <a href="#methods" accesskey="p" rel="previous">methods</a>, Up: <a href="#Cfagent-reference" accesskey="u" rel="up">Cfagent reference</a> [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Variable-Index" title="Index" rel="index">Index</a>]</p>
</div>
<a name="miscmounts-1"></a>
<h3 class="section">4.29 miscmounts</h3>
<a name="index-Mounting-filesystems_002e"></a>
<a name="index-Miscellaneous-mount-operations"></a>
<a name="index-miscmounts"></a>
<p>If you do not use the cfengine model for statically mounting NFS
filesystems (or if there are filesystems which do not naturally fall
into the bounds of that model) then you can still statically mount
miscellaneous filesystems using a statement of the form:
</p>
<table class="cartouche" border="1"><tr><td>
<p><!-- /@w -->
</p><div class="smallexample">
<pre class="smallexample">
miscmounts:
<var>class</var>::
<var>infohost</var>:<var>source-directory</var> <var>destination</var> <var>mode</var>
<var>infohost</var>:<var>source-directory</var> <var>destination</var> mode=<var>mode</var>
ifelapsed=<var>mins</var> expireafter=<var>mins</var>
</pre></div>
</td></tr></table>
<p>For example
</p>
<div class="smallexample">
<pre class="smallexample">
physics::
# old syntax
libraryserver:/$(site)/libraryserver/data1
/$(site)/libraryserver/data1 ro
# consistent syntax
libraryserver:/$(site)/libraryserver/data2
/$(site)/libraryserver/data2 mode=ro
host:/foo /foo mode=rw,bg,hard,intr
</pre></div>
<p>This statement would mount the directory
<samp>/$(site)/libraryserver/data</samp> physically attached to host
libraryserver onto a directory of the same name on all hosts in the
group <code>physics</code>. The modes <code>ro</code> and <code>rw</code> signify
read-only and read-write respectively.
If no mode is given, read-write is assumed.
</p>
<hr>
<a name="mountables"></a>
<div class="header">
<p>
Next: <a href="#processes" accesskey="n" rel="next">processes</a>, Previous: <a href="#miscmounts" accesskey="p" rel="previous">miscmounts</a>, Up: <a href="#Cfagent-reference" accesskey="u" rel="up">Cfagent reference</a> [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Variable-Index" title="Index" rel="index">Index</a>]</p>
</div>
<a name="mountables-1"></a>
<h3 class="section">4.30 mountables</h3>
<a name="index-Mountable-resources_002c-defining-1"></a>
<a name="index-Defining-a-mountable"></a>
<a name="index-mountables-1"></a>
<p>The <code>mountables</code> declaration need only be used if you are using
cfengine’s model for mounting NFS filesystems. This declaration informs
hosts of what filesystem resources are available for mounting. This
list is used in conjunction with <code>binservers</code> and
<code>homeservers</code> to determine which filesystems a given host should
mount, according to the cfengine model.
</p>
<p>The syntax of the list is:
</p>
<div class="smallexample">
<pre class="smallexample">mountables:
<var>class</var>::
"filesystem to mount"
readonly=<b>false/off</b>/<var>true/on</var>
mountoptions=<var>nfs-options</var>
</pre></div>
<p>e.g.
</p>
<div class="smallexample">
<pre class="smallexample">
mountables:
<var>class</var>::
server:/site/server/u1
server:/site/server/local
linuxhost:/site/linuxhost/local
linuxhost:/site/linuxhost/u1
</pre></div>
<p>Notice that binary and home-directory filesystems are mixed freely here.
Cfengine determines which of the entries are homedirectories using the
<code>homepattern</code> variable.
<a name="index-homepattern"></a>
<a name="index-Homepattern-variable_002e"></a>
</p>
<p>Every time you add a disk or a mountable partition to your network, you
should add the partition to the list of mountables.
</p>
<p><em>NOTE: This list is read in order, top down. Cfengine looks for
the first filesystem matching a given binary server when expanding the
variable <code>$(binserver)</code>, so sometimes the ordering of filesystems
matters.</em>
</p>
<p>This list can be accessed in editfiles, to allow straightforward
configuration of the automounter, using the command <code>AutomountDirectResources</code>.
</p>
<hr>
<a name="processes"></a>
<div class="header">
<p>
Next: <a href="#packages" accesskey="n" rel="next">packages</a>, Previous: <a href="#mountables" accesskey="p" rel="previous">mountables</a>, Up: <a href="#Cfagent-reference" accesskey="u" rel="up">Cfagent reference</a> [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Variable-Index" title="Index" rel="index">Index</a>]</p>
</div>
<a name="processes-1"></a>
<h3 class="section">4.31 processes</h3>
<p>Using the processes facility, you can test for the existence of
processes, signal (kill) processes and optionally restart them
again. Cfengine opens a pipe from the system ps command and searches
through the output from this command using regular expressions to match
the lines of output from ‘<samp>ps</samp>’. The regular expression does not
have to be an exact match, only a substring of the process line. The
form of a process command is
</p>
<table class="cartouche" border="1"><tr><td>
<p><!-- /@w -->
</p><div class="smallexample">
<pre class="smallexample">processes:
<var>class</var>::
<var>"quoted regular expression"</var>
restart <var>"shell command"</var>
useshell=<b>true</b>/<var>false/dumb</var>
owner=<var>restart-uid</var>
group=<var>restart-gid</var>
chroot=<var>directory</var>
chdir=<var>directory</var>
umask=<var>mask</var>
signal=<var>signal name</var>
matches=<var>number</var>
define=<var>classlist</var>
elsedefine=<var>classlist</var>
action=<b>signal</b><var>/do/warn/bymatch</var>
include=<var>literal</var>
exclude=<var>literal</var>
filter=<var>filter_name</var>
syslog=<var>true/on</var>/<var>false/off</var>
inform=<var>true/on</var>/<var>false/off</var>
audit=<var>true/on</var>/<var>false/off</var>
ifelapsed=<var>mins</var>
expireafter=<var>mins</var>
SetOptionString <var>"quoted option string"</var>
</pre></div>
</td></tr></table>
<a name="index-umask-1"></a>
<p>By default, the options sent to ps are "-aux" for BSD systems and "-ef"
for System V. You can use the <code>SetOptionString</code> command to redefine
the option string. Cfengine assumes only that the first identifiable number
on each line is the process identifier for the processes, so you must not
choose options for ps which change this basic requirement (this is not a
problem in practice). Cfengine reads the output of the ps-command normally only
once, and searches through it in memory. The process table is only
re-consulted if <code>SetOptionString</code> is called. The options have the
following meanings:
</p>
<dl compact="compact">
<dt><code>signal=<var>signal name</var></code></dt>
<dd><p>This option defines the name of a signal which is to be sent to all processes
matching the quoted regular expression. If this option is omitted, no signal
is sent. The signal names have the usual
meanings. The full list, with largely standardized meanings, is
</p>
<div class="smallexample">
<pre class="smallexample"> hup 1 hang-up
int 2 interrupt
quit 3 quit
ill 4 illegal instruction
trap 5 trace trap
iot 6 iot instruction
emt 7 emt instruction
fpe 8 floating point exception
kill 9 kill signal
bus 10 bus error
segv 11 segmentation fault
sys 12 bad argument to system call
pipe 13 write to non existent pipe
alrm 14 alarm clock
term 15 software termination signal
urg 16 urgent condition on I/O channel
stop 17 stop signal (not from tty)
tstp 18 stop from tty
cont 19 continue
chld 20 to parent on child exit/stop
gttin 21 to readers pgrp upon background tty read
gttou 22 like TTIN for output if (tp->t_local&LTOSTOP)
io 23 input/output possible signal
xcpu 24 exceeded CPU time limit
xfsz 25 exceeded file size limit
vtalrm 26 virtual time alarm
prof 27 profiling time alarm
winch 28 window changed
lost 29 resource lost (eg, record-lock lost)
usr1 30 user defined signal 1
usr2 31 user defined signal 2
</pre></div>
<p>Note that cfengine will not attempt to signal or restart processes 0 to 3
on any system since such an attempt could bring down the system. The only
exception is that the hangup (hup) signal may be sent to process 1
(init) which normally forces init to reread its terminal configuration
files.
<a name="index-Processes_002c-0-to-3"></a>
</p>
</dd>
<dt><code>restart <var>"shell command"</var></code></dt>
<dd>
<p>Note the syntax: there is no equals sign here. If the keyword ‘restart’
appears, then the next quoted string is interpreted as a shell command
which is to be executed after any signals have been sent. This command
is only issued if the number of processes matching the specified regular
expression is zero, or if the signal sent was signal 9 (sigkill) or 15
(sigterm) , i.e. the normal termination signals. This could be used to
restart a daemon for instance. Cfengine executes this command and
<em>waits</em> for its completion so you should normally only use this
feature to execute non-blocking commands, such as daemons which
dissociate themselves from the I/O stream and place themselves in the
background. Some unices leave a hanging pipe on restart (they never
manage to detect the end of file condition). This occurs on POSIX.1 and
SVR4 popen calls which use wait4. For some reason they fail to find and
end-of-file for an exiting child process and go into a deadlock trying
to read from an already dead process. This leaves a zombie behind (the
parent daemon process which forked and was supposed to exit) though the
child continues. A way around this is to use a wrapper script which
prints the line "cfengine-die" to STDOUT after restarting the
process. This causes cfengine to close the pipe forcibly and continue.
<a name="index-Deadlock-zombie-bug-in-restart"></a>
<a name="index-Restart-zombie-deadlock-bug"></a>
Cfengine places a timeout on the restart process and attempts to
clean up zombies, but you should be aware of this possibility.
<a name="index-Setting-uid-on-restarted-processes"></a>
</p>
</dd>
<dt><code>owner=,group=</code></dt>
<dd><p>Sets the process uid and gid (setuid,gid) for processes which are
restarted. This applies only to cfengine run by root.
</p>
</dd>
<dt><code>chroot</code></dt>
<dd><p>Changes the process root directory of the restarted process, creating
a ‘sandbox’ which the process cannot escape from. Best used together with
a change of owner, since a root process can break out of such a confinement
in principle.
</p>
</dd>
<dt><code>chdir</code></dt>
<dd><p>Change the current working directory of the restarted process.
</p>
</dd>
<dt><code>useshell=<var>true/false/dumb</var></code></dt>
<dd><p>When restarting processes, cfengine normally uses a shell to
interpret and execute the restart command. This has inherent
security problems associated with it. If you set this option to
false, cfengine executes restart commands without using a shell.
This is recommended, but it does mean that you cannot use any
shell operators or features in the restart command-line.
</p>
<p>Some programs (like cron) do not handle I/O properly when they fork
their daemon parts, this causes a zombie process and normally
hangs cfengine. By choosing the value ‘dumb’ for this, cfengine
ignores all output from a program and does not use a startup shell.
This prevents programs like cron from hanging cfengine.
</p>
</dd>
<dt><code>matches=<var>number</var></code></dt>
<dd><p>This option may be used to set a maximum, minimum or exact number of
matches. If cfengine doesn’t find a number of matches to the regular
expression which is in accordance with this value it signals a warning.
The ‘<samp><</samp>’, ‘<samp>></samp>’ symbols are used to specify upper and lower
limits. For example,
</p>
<div class="smallexample">
<pre class="smallexample"> matches=>6 # warn number of matches is greater than or equal to 6
matches=1 # warn if not exactly 1 matching process
matches=<2 # warn if there are less than or equal to 2 matching processes
</pre></div>
<a name="index-Processes_002c-counting"></a>
</dd>
<dt><code>include=<var>literal</var></code></dt>
<dd><p>Items listed as includes provide an extra level of selection after the
regular expression matches have been expanded. If you include one
include option, then only lines containing one or more of the literal
strings or wildcards will be matched.
</p>
</dd>
<dt><code>exclude=<var>literal</var></code></dt>
<dd><p>Process lines containing literal strings or wildcards in exclude
statements are not matched. Excludes are processed after regular
expression matching and after includes.
</p>
</dd>
<dt><code>define=<var>classlist</var></code></dt>
<dd><p>The colon, comma or dot separated list of classes becomes activated if the
number of regular expression matches is non-zero.
</p>
</dd>
<dt><code>elsedefine=<var>classlist</var></code></dt>
<dd><p>The colon, comma or dot separated list of classes becomes activated if the
number of regular expression matches is zero.
</p>
<a name="index-bymatch"></a>
<a name="index-signal"></a>
</dd>
<dt><code>action=<var>signal/do/warn/bymatch</var></code></dt>
<dd><p>The default value of this option is to silently send a signal
(if one was defined using the <code>signal</code> option) to matching
processes. This is equivalent to setting the value of this
parameter to ‘<samp>signal</samp>’ or ‘<samp>do</samp>’. If you set this option
to ‘<samp>warn</samp>’, cfengine sends no signal, but prints a message
detailing the processes which match the regular expression.
If the option is set to <code>bymatch</code>, then signals are only sent
to the processes if the matches criteria fail.
<a name="index-Processes_002c-checking-existence-of"></a>
<a name="index-Processes_002c-signalling"></a>
</p>
</dd>
</dl>
<p>Here is an example script which sends the hang-up signal to cron,
forcing it to reread its crontab files:
</p>
<div class="smallexample">
<pre class="smallexample">
processes:
"cron" signal=hup
</pre></div>
<p>Here is a second example which may be used to restart the nameservice
on a Solaris system:
</p>
<div class="smallexample">
<pre class="smallexample">
processes:
solaris::
"named" signal=kill restart "/usr/sbin/in.named"
</pre></div>
<p>A more complex match could be used to look for processes belonging to
a particular user. Here is a script which kills ftp related processes
belonging to a particular user who is known to spend the whole day
FTP-ing files:
</p>
<div class="smallexample">
<pre class="smallexample">
control:
actionsequence = ( processes )
#
# Set a kill signal here for convenience
#
sig = ( kill )
#
# Better not find that dumpster here!
#
matches = ( 1 )
processes:
#
# Look for Johnny Mnemonic trying to dump his head, user = jmnemon
#
".*jmnemon.*ftp.*" signal=$(sig) matches=<$(matches) action=$(do)
# No mercy!
</pre></div>
<p>The regular expression ‘<samp>.*</samp>’ matches any number of characters, so this
command searches for a line containing both the username and something to
do with ftp and sends these processes the kill signal.
</p>
<p>You can arrange for signals to be sent, only if the number of matches
fails the test. The <code>action=bymatch</code> option is used for this.
For instance, to kill process ‘XXX’ only if the number
of matches is greater than 20, one would write:
</p>
<div class="smallexample">
<pre class="smallexample">
processes:
"XXX" matches=<20 action=bymatch signal=kill
</pre></div>
<p>See also filters See <a href="#filters">filters</a>, for more complex searches.
</p>
<hr>
<a name="packages"></a>
<div class="header">
<p>
Next: <a href="#rename" accesskey="n" rel="next">rename</a>, Previous: <a href="#processes" accesskey="p" rel="previous">processes</a>, Up: <a href="#Cfagent-reference" accesskey="u" rel="up">Cfagent reference</a> [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Variable-Index" title="Index" rel="index">Index</a>]</p>
</div>
<a name="Packages"></a>
<h3 class="section">4.32 Packages</h3>
<a name="index-packages"></a>
<a name="index-Checking-for-installed-packages"></a>
<p>The packages action allows you to check for the existance of packages
on the system, as determined by the package database you select. Optionally,
if a package install command was specified, the package can be installed
if it is not there.
</p>
<p>This operation is set up such that it tries not to make assumptions about
the package manager in use. For example, it should be possible to use
RPM on a Solaris box.
</p>
<p>The syntax summary is:
</p>
<table class="cartouche" border="1"><tr><td>
<p><!-- /@w -->
</p><div class="smallexample">
<pre class="smallexample">
packages:
<var>class</var>::
<var>package-name</var>
pkgmgr=<b>none</b>/<var>rpm/dpkg/sun/aix/portage/freebsd</var>
cmp=<b>eq</b>/<var>lt/gt/ge/le/ne</var>
version=<var>version-string</var>
define=<var>class-list</var>(,:.)
elsedefine=<var>class-list</var>(,:.)
action=<b>none</b>/<var>install/remove/upgrade/fix</var>
ifelapsed=<var>mins</var>
expireafter=<var>mins</var>
audit=<var>true/on</var>/<var>false/off</var>
inform=<var>true/on</var>/<var>false/off</var>
EXAMPLES:
packages:
# install newpackage 1.10 if newpackage 1.0 or greater isn't installed
newpackage-1.10 action=install
cmp=ge
version=1.0
# upgrade any installed versions of compromised to at least 1.2
compromised-1.2 action=upgrade
version=1.2
cmp=le
# Make sure that version 1.2 is installed
compromised-1.2 action=fix
version=1.2
cmp=le
# remove any version of useless
useless action=remove
version=0.1
cmp=ge
</pre></div>
</td></tr></table>
<dl compact="compact">
<dt><code>action</code></dt>
<dd><a name="index-action_003d"></a>
<p>Determines the action taken if the comparison matches.
</p>
<ul>
<li> <code>install</code>
Install this package if the version comparison does not match.
</li><li> <code>upgrade</code>
Upgrade this package if the version comparison does match.
</li><li> <code>fix</code>
Install or Upgrade this package if the version comparison does match.
</li><li> <code>remove</code>
Uninstall this package if the version comparison does match.
</li></ul>
</dd>
<dt><code>cmp</code></dt>
<dd><a name="index-cmp_003d"></a>
<p>Determines how the version of the installed package will be compared to
that specified by the <code>version</code> attribute. Possible values include:
</p>
<ul>
<li> <code>eq</code>
The version installed must be equal to <code>version</code>
</li><li> <code>lt</code>
The version installed must be less than <code>version</code>
</li><li> <code>gt</code>
The version installed must be greater than <code>version</code>
</li><li> <code>le</code>
The version installed must be less than or equal to <code>version</code>
</li><li> <code>ge</code>
The version installed must be creater than or equal to <code>version</code>
</li><li> <code>ne</code>
The version installed must not be equal to <code>version</code>
</li></ul>
<p>The default value for this attribute is <code>eq</code>.
</p>
<p>Note that <code>cmp</code> is used differently for install versus upgrade, fix and remove.
The action is performed when false for install, but when true for upgrade, fix or remove.
</p>
</dd>
<dt><code>version</code></dt>
<dd><a name="index-version_003d"></a>
<p>Specifies the package manager specific version string to match. If
this is not specified, then any version matches, and the value of
the <code>cmp</code> attribute is ignored. See the allowed values of
<code>pkgmgr</code> below for an explation of how each package manager
will interpret this.
</p>
</dd>
<dt><code>pkgmgr</code></dt>
<dd><a name="index-pkgmgr_003d"></a>
<p>Selects the package manager database to query. This defaults to either
the value of the <code>DefaultPkgMgr</code> variable, or if that is not set,
there is no default. In that case, no checking will be done unless
<code>pkgmgr</code> is set explicitly for each package. Note that the default
value ’‘<samp>none</samp>’’ listed is merely a pseudo-value, and cannot actually
be used, since it would make no sense anyway.
</p>
<p>Each package manager will interpret the <code>version</code> and <code>cmp</code>
attributes in its own way. For example, when you use
<code>pkgmgr=rpm</code>, the comparison will be done with the same rules that
RPM use if it were not being run through cfengine. Freebsd actually
invokes the standard system utility to do the comparisons for it, etc.
</p>
<p>Currently, the following package managers are supported:
</p>
<dl compact="compact">
<dt><code>rpm</code></dt>
<dd><a name="index-RPM-Database-Queries"></a>
<p>This uses the rpm command, which cfengine expects to find as <samp>/bin/rpm</samp>
to query the machine’s RPM database. The <code>rpm</code> check assumes that you
are using a version of RPM that understands the concept of an epoch,
which means that you will want to use RPM version 3.0.3 or greater.
Versions as early as 2.5.6 may work, but it is doubtful. If multiple
packages of the same name are installed (i.e. kernel), then the check
considers the package to be installed at the specified version if
<b>at least one</b> of them satisifies the criteria specified by <code>cmp</code> and
<code>version</code>.
</p>
<p>The format of a RPM version string is: [epoch:]version[-release]. The
version[-release] can be seen by simply running: <code>rpm -q <pkg></code>.
In order to see the epoch, you must use a query format, like this:
<code>rpm -q --queryformat "%{EPOCH}:%{VERSION}-%{RELEASE}\n" <pkg></code>.
Most packages do not have an epoch, and will print ‘<samp>(none)</samp>’ in the
epoch space. In recent incarnations of RPM, the absense of an epoch
is interpreted as 0. This is also how cfengine will interpret it.
<em>Be careful with this. If the installed version
of a package has an epoch greater than 0, and you do not specify the epoch,
unexpected results may happen.</em> For example, if you have a package installed,
‘<samp>foo-1:2.0-1</samp>’, and you specify a <code>version=3.0-1</code> and a
<code>cmp=gt</code>, the check will be true, because the installed version has
an epoch of 1, and you did not specify an epoch, which implies you wanted
an epoch of 0. The rule here is basically to always check the epoch of
the package you really want, and specify it. It may take a few extra
extra seconds to check, but it will save you lots of headaches later.
</p>
</dd>
<dt><code>portage</code></dt>
<dd><a name="index-Gentoo-Package-Database-Queries"></a>
<p>This uses the emerge command to install packages on a Gentoo Linux
system. The ‘portage’ Python module is used to query the system and
find installed packages. The <i>package_name</i> and <i>version</i> support
any package that conforms to the Gentoo package naming specification
<a href="http://www.gentoo.org/proj/en/devrel/handbook/handbook.xml?part=2&chap=1#doc_chap2_sect2">http://www.gentoo.org/proj/en/devrel/handbook/handbook.xml?part=2&chap=1#doc_chap2_sect2</a>,
and even most of those in the Portage tree that do not. Because
Gentoo package atoms are flexible, you can use the name of the
package, along with a <i>version</i> and the <i>cmp</i> cfengine logic, or
you can put the comparison operator and version in the <i>package_name</i>
field and leave out the <i>cmp</i> operator. Because cfengine builds the
install string out of the package name, and ignores the <i>version</i>
you were comparing against, using a package atom with a version is the
only way to have a specific version emerged.
</p>
<div class="smallexample">
<pre class="smallexample">
packages:
any::
# if the version of tar is less than 1.16-r2,
# then the *latest* version of tar will be installed:
app-arch/tar cmp=ge version=1.16-r2 action=install
# This is equivalent, but uses the package atom to
# define the version comparison:
>=app-arch/tar-1.16-r2 action=install
</pre></div>
</dd>
<dt><code>dpkg</code></dt>
<dd><a name="index-Debian-Package-Database-Queries"></a>
<p>Please document me!
</p>
</dd>
<dt><code>sun</code></dt>
<dd><a name="index-Sun-Package-Database-Queries"></a>
<p>Please document me!
</p>
</dd>
<dt><code>freebsd</code></dt>
<dd><a name="index-FreeBSD-Package-Database-Queries"></a>
<p>FreeBSD has fully working install/upgrade/delete management for
packages. You can either get the latest version from a package repository,
or define the explicit version to install.
</p>
<div class="smallexample">
<pre class="smallexample">
# install new package from FreeBSD ports tree
control:
DefaultPkgMgr = ( freebsd )
FreeBSDInstallCommand = ( "/usr/sbin/pkg_add -r %s" )
packages:
bsdsar action=install
# install a specific version from a local repository
control:
DefaultPkgMgr = ( freebsd )
FreeBSDInstallCommand = ( "/usr/sbin/pkg_add http://server/path/%s" )
packages:
bsdsar-1.10_2 action=install
</pre></div>
<p>Note that specifying the version of the package that is part of the freebsd package filename is required if not using "-r" mode.
It does not use this version for comparison, just for the package filename to install.
</p>
<p>You can also backgrade if you know that 1.2 is bad for instance.
</p>
<div class="smallexample">
<pre class="smallexample">packages:
bsdsar-1.10_2 action=upgrade
version=1.10_2
cmp=gt
</pre></div>
<p>The only gotcha about FreeBSD installation is trying to specify the package
source location. Due to the unfortunate fact that freebsd doesn’t provide a
command line option – only an environment variable – for specifying
the source repository, you have a few options.
</p>
<p>Get it from the main FreeBSD binary package home:
</p>
<div class="smallexample">
<pre class="smallexample"> FreeBSDInstallCommand = ( "/usr/sbin/pkg_add -r %s" )
</pre></div>
<p>Get it from a mounted directory or http server
</p>
<div class="smallexample">
<pre class="smallexample"> FreeBSDInstallCommand = ( "/usr/sbin/pkg_add /nfs/packages/%s" )
FreeBSDInstallCommand = ( "/usr/sbin/pkg_add http://server/path/%s" )
</pre></div>
<p>Or write a script that tells pkg_add where to find it, like so:
</p>
<div class="smallexample">
<pre class="smallexample"> FreeBSDInstallCommand = ( "/var/cfengine/packages/pkginstall %s" )
</pre></div>
<p>such as
</p>
<div class="smallexample">
<pre class="smallexample">#!/bin/sh
PACKAGESITE=http://my.local.repository/packages/
export PACKAGESITE
/usr/sbin/pkg_add -r $*
</pre></div>
</dd>
</dl>
</dd>
<dt><code>define</code></dt>
<dd><p>Specifies the list of classes to define if the specified package/version was
installed (prior to actions taken if any)
</p>
</dd>
<dt><code>elsedefine</code></dt>
<dd><p>Specifies the list of classes to define if the specified package/version was not
installed (prior to actions taken if any)
</p>
</dd>
<dt><code>action</code></dt>
<dd><p>Specifies whether the packages should actually do anything about the
situation it finds. The default for this is to do nothing.
</p>
<p>For <code>install</code>, the action will be taken if the comparison returns false.
</p>
<p>For <code>upgrade</code> and <code>remove</code>, the action will be taken if the comparison returns false.
</p>
<p>The classes in <code>define</code> and <code>elsedefine</code> will always be defined,
as applicable, regardless of the action specified.
</p>
<dl compact="compact">
<dt><code>install</code></dt>
<dd><p>Installs the package using the command associated with the selected
package manager, if it is not currently on the system at the requested
version, as follows:
</p>
<ul>
<li> RPM -
RPMInstallCommand
</li><li> DPKG -
DPKGInstallCommand
</li><li> SUN -
SUNInstallCommand
</li><li> Gentoo -
PortageInstallCommand
</li><li> FreeBSD -
FreeBSDInstallCommand
</li></ul>
<p>Each variable is of the format:
</p>
<div class="smallexample">
<pre class="smallexample">FOOInstallCommand = ( "/usr/bin/foo --args %s --more-args" )
</pre></div>
<p>The —args are of course optional. For FreeBSD and Sun, the %s is replaced with the package name
that was checked, and found to not be installed. For all other package managers the %s can have
a space separated list of package names.
</p>
</dd>
<dt><code>upgrade</code></dt>
<dd><p>Upgrades the package using the commands associated with the selected
package manager, first removal of the old package then installation of the new package.
Note that on some package managers this action is unnecessary because the package manager
will "do the right thing" when told to install a newer version.
</p>
<ul>
<li> FreeBSD -
FreeBSDRemoveCommand followed by FreeBSDInstallCommand
Portage -
Upgrade is generally not necessary since emerge will do the upgrade for you.
</li></ul>
</dd>
<dt><code>remove</code></dt>
<dd><p>Removes the package(s) using the command associated with the selected
package manager, if a matching package is found on the system, as follows:
</p>
<div class="smallexample">
<pre class="smallexample">FOORemoveCommand = ( "/usr/bin/foo --args %s --more-args" )
</pre></div>
<p>The —args are of course optional. The %s is replaced with a space-separated
list of the package names that were checked, and found to be installed.
</p></dd>
</dl>
</dd>
</dl>
<p>NOTE: classes are defined according to the result of the check, not
any action performed as a result of that check. In otherwords, if for
example you have a situation where a package is not installed,
and the action= is set to install, the classes in <code>elsedefine</code> will
be defined <b>regardless</b> of whether or not the install was successful.
Assuming the package installed, the next run of cfagent will pick up that
fact. This has to be done since the package installs are batched, so there
is no reliable way to know if a given package was installed successfully.
</p>
<p>Examples:
</p>
<div class="smallexample">
<pre class="smallexample">packages:
redhat_8_0::
m4 version=0:1.4.1-11 cmp=eq pkgmgr=rpm elsedefine=needsm4
</pre></div>
<p>In this first example, we are looking for the m4 package at exactly version
0:1.4.1-11. The installed m4 package on a redhat_8_0 box has no epoch
which is the same as zero. Specifying it will keep you out of trouble. This
check will cause <code>needsm4</code> to be defined if the exact version of
m4 specified is not installed.
</p>
<div class="smallexample">
<pre class="smallexample">control:
redhat:;
DefaultPkgMgr = ( rpm )
gentoo::
DefaultPkgMgr = ( portage )
packages:
redhat_8_0::
make version=0:4.5-2 cmp=ge define=hasmake elsedefine=needsmake
</pre></div>
<p>In the second example, we use the DefaultPkgMgr variable to set the default
for the <code>pkgmgr</code> attribute to <code>rpm</code>. The actual version of make
installed on recent redhat_8_0 machine is 1:3.79.1-14. Since the check is
for greater than or equal to this version, the hasmake class will be
defined.
</p>
<div class="smallexample">
<pre class="smallexample">control:
redhat:;
DefaultPkgMgr = ( rpm )
RPMInstallCommand = ( "/usr/sbin/up2date %s" )
packages:
redhat_8_0::
make define=hasmake elsedefine=needsmake action=install
</pre></div>
<p>This example is much like the second example, except that if the package is
not installed, cfengine will attempt to install it using the command in
RPMInstallCommand, replacing the %s with the package name, <code>make</code>.
If there were multiple packages specified in this way, the package installation
would occur at the end of the package checks, and one command would be run,
with %s replaced with a list of all package names. In this example we chose
not to use a version spec, but it is allowed, and as always, is optional.
</p>
<p>NOTE here that if make was not installed when the check is made,
<code>needsmake</code> is defined, regardless of whether or not the
install succeeds. If the install is successful, the next cfagent
run will define <code>hasmake</code>.
</p>
<hr>
<a name="rename"></a>
<div class="header">
<p>
Next: <a href="#required" accesskey="n" rel="next">required</a>, Previous: <a href="#packages" accesskey="p" rel="previous">packages</a>, Up: <a href="#Cfagent-reference" accesskey="u" rel="up">Cfagent reference</a> [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Variable-Index" title="Index" rel="index">Index</a>]</p>
</div>
<a name="rename-1"></a>
<h3 class="section">4.33 rename</h3>
<p>As of version 2.1.0 rename is a synonym for disable, See <a href="#disable">disable</a>.
</p>
<hr>
<a name="required"></a>
<div class="header">
<p>
Next: <a href="#resolve" accesskey="n" rel="next">resolve</a>, Previous: <a href="#rename" accesskey="p" rel="previous">rename</a>, Up: <a href="#Cfagent-reference" accesskey="u" rel="up">Cfagent reference</a> [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Variable-Index" title="Index" rel="index">Index</a>]</p>
</div>
<a name="required-1"></a>
<h3 class="section">4.34 required</h3>
<p>This is a synonym for disks, See <a href="#disks">disks</a>.
</p>
<hr>
<a name="resolve"></a>
<div class="header">
<p>
Next: <a href="#scli" accesskey="n" rel="next">scli</a>, Previous: <a href="#required" accesskey="p" rel="previous">required</a>, Up: <a href="#Cfagent-reference" accesskey="u" rel="up">Cfagent reference</a> [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Variable-Index" title="Index" rel="index">Index</a>]</p>
</div>
<a name="resolve-1"></a>
<h3 class="section">4.35 resolve</h3>
<a name="index-DNS"></a>
<a name="index-Resolver-configuration"></a>
<a name="index-resolv_002econf"></a>
<a name="index-resolve-1"></a>
<p>The file <code>/etc/resolv.conf</code> specifies the default nameserver for
each host, as well as the local domain name. This file can also contain
other information, but these are the only two things cfengine currently
cares about. In specifying nameservers you should use the dotted
numerical form of the IP addresses since your system may not understand
the text form if it is not correctly configured. You may list as many
nameservers as you wish, with the default server at the top of the list.
The resolver normally ignores entries if you add more than three. The
statement:
</p>
<div class="smallexample">
<pre class="smallexample">
resolve:
mygroup::
129.240.22.35
129.240.22.222
129.240.2.3
</pre></div>
<p>declares a list of nameservers for hosts in the group or class
<code>mygroup</code>. When you add the <code>resolve</code> command to the
<code>actionsequence</code>, this declaration together with the <code>domain</code>
variable (set here to <code>uio.no</code>) results in a
<code>/etc/resolv.conf</code> file of the form:
</p>
<p><!-- /@w -->
</p><div class="smallexample">
<pre class="smallexample">
domain uio.no
nameserver 129.240.22.35
nameserver 129.240.22.222
nameserver 129.240.2.3
</pre></div>
<p>Note that the <code>resolve</code> action does not delete anything from the
file <code>/etc/resolv.conf</code> unless the <code>EmptyResolvConf</code> variable is set
to ’true’ . It adds nameservers which do not previously exist and
reorders the lines of servers which do exist.
</p>
<p>As of version 1.3.11, you may use a quoted string to add non-nameserver
lines to this file. For example:
</p>
<div class="smallexample">
<pre class="smallexample">
resolve:
mygroup::
129.240.22.35
129.240.22.222
"# Comment line"
"order bind, files"
</pre></div>
<p>If the line begins with a non-numeric character, the word ‘nameserver’
is not added to the line.
</p>
<hr>
<a name="scli"></a>
<div class="header">
<p>
Next: <a href="#shellcommands" accesskey="n" rel="next">shellcommands</a>, Previous: <a href="#resolve" accesskey="p" rel="previous">resolve</a>, Up: <a href="#Cfagent-reference" accesskey="u" rel="up">Cfagent reference</a> [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Variable-Index" title="Index" rel="index">Index</a>]</p>
</div>
<a name="scli-1"></a>
<h3 class="section">4.36 scli</h3>
<p>SCLI is an SNMP command line interpreter written by Jürgen
Schönwaelder of the Jacobs University of Bremen. It is a command
interpreter used to simplify the interaction with SNMP enabled
devices. SNMP is a stateless, UDP based network protocol for
communicating with supporting hardware. The SNMP model does not fit
very comfortably with the cfengine “responsibility for self”
paradigm, but at some level SCLI can be viewed as just another form of
interpreted script. SCLI adds a level of user friendliness and
stateful behaviour to SNMP through its shell-like interface. This
turns out to be both a help and a hindrance to cfagent.
</p>
<p>The intermingling of stateful and stateless processes in the dialogue
between cfengine and scli makes their integration non-trivial. Several
compromises have to be made to aid usability and these could lead to
difficulties in the practical use of the tools later.
</p>
<p>The scli section of a cfagent configuration is a single script. The lines
are passed as a collective object to the scli interpreter, not line-by-line
as in other cases.
</p>
<p>The basic approach is to open a pipe for the reading and writing of
dialogue with the interpreter. There are some limitations to Unix
pipes however, in particular input and output are separated which
makes per-transaction error control essentially impossible. A
work-around for this has been used in the test phase.
</p>
<p>The cfengine interface is a special case of the <code>shellcommands</code>
interface, passing commands to SCLI instead of to <samp>/bin/sh</samp>.
The command options are the same as those below for <code>shellcommands</code>.
</p>
<table class="cartouche" border="1"><tr><td>
<p><!-- /@w -->
</p><div class="smallexample">
<pre class="smallexample">shellcommands:
<var>class</var>::
"<var>scli-string</var>" <var>shellcommand options</var>
"<var>scli-string</var>"
</pre></div>
</td></tr></table>
<a name="index-scli-command-interpreter"></a>
<a name="index-SNMP"></a>
<p><i>This integration was funded by the IST-EMANICS Network of Excellence in Network and
Service Management, of which Oslo University College and the Jacobs University of
Bremen are members</i>.
</p>
<hr>
<a name="shellcommands"></a>
<div class="header">
<p>
Next: <a href="#strategies" accesskey="n" rel="next">strategies</a>, Previous: <a href="#scli" accesskey="p" rel="previous">scli</a>, Up: <a href="#Cfagent-reference" accesskey="u" rel="up">Cfagent reference</a> [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Variable-Index" title="Index" rel="index">Index</a>]</p>
</div>
<a name="shellcommands-1"></a>
<h3 class="section">4.37 shellcommands</h3>
<p>Cfengine focuses on fairly simple-minded tasks in order to be as general
as possible. In many cases, you will therefore want to write a script to
do something special on your system. You can still take advantage of
the classes you have defined by executing these scripts or shell
commands from this section.
</p>
<p>The syntax is simply to quote the command you wish to be executed.
</p>
<table class="cartouche" border="1"><tr><td>
<p><!-- /@w -->
</p><div class="smallexample">
<pre class="smallexample">shellcommands:
<var>class</var>::
"<var>command-string</var>"
timeout=<var>seconds</var>
useshell=<b>true</b><var>/false</var>
umask=<var>octal number</var>
owner=<var>uid</var>
group=<var>gid</var>
background=<b>false</b><var>/true</var>
chdir=<var>directory</var>
chroot=<var>directory</var>
preview=<var>true</var>/<b>false</b>
inform=<b>false</b><var>/true</var>
audit=<var>true/on</var>/<var>false/off</var>
noabspath=<b>false</b><var>/true</var>
ifelapsed=<var>mins</var>
expireafter=<var>mins</var>
define=<var>class-list</var>
elsedefine=<var>class-list</var>
</pre></div>
</td></tr></table>
<a name="index-umask-2"></a>
<dl compact="compact">
<dt><code><var>command-string</var></code></dt>
<dd><p>This is the command to be executed.
</p>
</dd>
<dt><code><var>timeout</var></code></dt>
<dd><p>If you set the optional <var>timeout</var> parameter, then cfengine
will abort the specified shellcommand if it exceeds
the given time-limit (specified in seconds).
This can be useful for avoiding hung programs caused by hung
network connections, etc. Timeouts are generated by alarm interrupts
within a single agent. This can be contrasted with <code>expireafter</code>
in which a second agent is required to interrupt a command.
<a name="index-timeout_003d-in-shellcommands"></a>
<a name="index-How-can-I-set-a-timeout-for-a-shell-command_003f"></a>
<a name="index-How-can-I-avoid-hanging-shellcommands_003f"></a>
<a name="index-Hanging-commands_002c-timeouts"></a>
</p>
</dd>
<dt><code><var>useshell</var></code></dt>
<dd><p>Some program lines, especially those that do not use any shell-specific
capabilities (such as redirection and wildcard expansion) can be run without the shell.
This is typically more secure, as the command line is not altered by the
user or by the system. It is also faster, as the shell does not have
to be spawned in order to run the given command. Use the <var>useshell</var>
parameter to tell cfengine to not use the shell to run this shellcommand.
</p>
</dd>
<dt><code><var>umask</var></code></dt>
<dd><p>The umask affects the permissions given to a file created by this shellcommand.
The umask specifies, specifically, the permissions that are to be taken away.
</p>
</dd>
<dt><code><var>owner</var></code></dt>
<dt><code><var>group</var></code></dt>
<dd><p>The user and group ID’s of the process can be set (using the <var>owner</var>
and <var>group</var> parameters respectively) to restrict the
permissions of the shellcommand. This can only be done if cfengine is
executed by root; otherwise, the user and group will remain that of the
the user who started cfengine.
</p>
</dd>
<dt><code><var>background</var></code></dt>
<dd><p>Run this command in the background if this is specified true. This will make
cfengine run faster, but no tests can be made (at least directly) on the results
of this command. Also when jobs are backgrounded, the output in verbose mode
can be somewhat erratic due to the unsychnronized streams.
</p>
</dd>
<dt><code><var>chdir</var></code></dt>
<dd><p>Change to the specified directory before running this command.
</p>
</dd>
<dt><code><var>chroot</var></code></dt>
<dd><p>The <code>chroot</code> option changes the process root directory of the
command, creating a ‘sandbox’ which the process cannot escape from. Best
used together with a change of owner (using the <code>owner</code> parameter),
since a root process can break out of a chrooted environment.
</p>
</dd>
<dt><code><var>preview</var></code></dt>
<dd><p>The <code>preview</code> option means that the shellcommand will also be executed during
the <code><span class="nolinebreak">--dry-run</span></code><!-- /@w --> (<code>-n</code>) options. This allows cfengine to be more aware
of the results of scripts which define classes. This option should be used
with care.
</p>
<p>Scripts should conform to the protocol of not executing unnecessary commands
when the classes <code>opt_dry_run</code> is defined.
<a name="index-Previewing-shellcommands"></a>
<a name="index-_002d_002ddry_002drun-option"></a>
</p>
</dd>
<dt><code><var>inform</var></code></dt>
<dt><code><var>noabspath</var></code></dt>
<dd><p>Normally, cfagent requires the command string to begin with a ‘<samp>/</samp>’
since it is dangerous to rely on an implicit path. However, sometimes it
it is appropriate to override this. This behavior can be overridden using
the <var>noabspath</var> parameter.
<a name="index-noabspath"></a>
<a name="index-noabspath-1"></a>
<a name="index-Shellcommands-must-start-with-absolute-path"></a>
<a name="index-Absolute-path-and-shellcommands"></a>
</p>
</dd>
<dt><code><var>ifelapsed</var></code></dt>
<dd><p>The shellcommand specified will not be run unless the specified amount of
time (in minutes) has elapsed since the command was previously run.
</p>
</dd>
<dt><code><var>expireafter</var></code></dt>
<dd><p>If this amount of time (in minutes) has elapsed since the command started,
then the command is aborted by a second agent that is patrolling the system.
</p>
</dd>
<dt><code><var>define</var></code></dt>
<dd><p>Define the specified classes if the command finishes successfully.
</p>
</dd>
<dt><code><var>elsedefine</var></code></dt>
<dd><p>Define the specified classes if the command does not finish successfully.
</p>
</dd>
</dl>
<p>Variable substitution works within the strings. Here are some examples.
</p>
<div class="smallexample">
<pre class="smallexample">
shellcommands:
sun4::
"/usr/lib/find/updatedb"
AllHomeServers.Sunday::
"/dir/noseyparker /$(site)/$(host)/u1 $(sysadm) nomail"
AllBinaryServers.sun4.Saturday::
"/usr/etc/catman -w -M /usr/local/man"
"/usr/etc/catman -w -M /usr/local/X11R5/man"
"/usr/etc/catman -w -M /usr/man"
"/usr/etc/catman -w -M /usr/local/gnu/man"
</pre></div>
<p>If you need to write more advanced scripts which make detailed use of the
classes defined by cfengine, use the <code>$(allclasses)</code> variable to send
a complete list of classes to your script. An enviornment variable,
CFALLCLASSES, is set and is in the format
</p>
<div class="smallexample">
<pre class="smallexample">
CFALLCLASSES=class1:class2:class3...
</pre></div>
<p>This variable is kept up-to-date at any given time with only the classes
which are defined. The command line option ‘<samp>-u</samp>’ or
‘<samp>--use-env</samp>’ can be used to define an environment variable which
will be inherited by all scripts and contains the same information.
This is not the standard approach, since some systems cannot
cope with this rapid change of environment and generate a Bus Error.
<a name="index-CFALLCLASSES-1"></a>
<a name="index-allclasses-variable"></a>
<a name="index-Scripts-and-class-information"></a>
<a name="index-Class-information_002c-passing-to-scripts"></a>
</p>
<p>Commands can be iterated over variable lists, provided there is
at least one space between each variable. For example:
</p>
<div class="smallexample">
<pre class="smallexample">
control:
actionsequence =
(
shellcommands
)
var1 = ( a:b:c )
var2 = ( x:y:z )
shellcommands:
"/bin/echo $(var1) $(var2)"
</pre></div>
<p>This iterates over all values of the list variables. See <a href="#Iteration-over-lists">Iteration over lists</a>.
<a name="index-Iterating-over-lists-in-shellcommands"></a>
If you are iterating over a list, the time limit (in seconds) which is
specified in the <var>timeout</var> parameter applies to each separate
iteration, not to the sum total of all the iterations.
<a name="index-Timeouts-during-iterations"></a>
</p>
<hr>
<a name="strategies"></a>
<div class="header">
<p>
Next: <a href="#tidy" accesskey="n" rel="next">tidy</a>, Previous: <a href="#shellcommands" accesskey="p" rel="previous">shellcommands</a>, Up: <a href="#Cfagent-reference" accesskey="u" rel="up">Cfagent reference</a> [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Variable-Index" title="Index" rel="index">Index</a>]</p>
</div>
<a name="strategies-1"></a>
<h3 class="section">4.38 strategies</h3>
<a name="index-Gaming-stratgies"></a>
<a name="index-Strategy_002c-random"></a>
<a name="index-Randomizing-strategy"></a>
<p>Strategies (introduced in cfengine version 2.0)
are a way of picking from a set of classes randomly.
Each class is a possible course of action.
A strategy group (of classes) is defined as follows:
</p>
<div class="smallexample">
<pre class="smallexample">strategies:
{ my_strategy_alias
class1: "2"
class2: "3"
class3: "$(value)"
class4: "6"
class5: "1"
}
tidy:
class1.Hr00::
/home pat=*.mp3 age=0
class2.Hr02::
/home pat=*.wav age=0
</pre></div>
<p>The idea here is to randomly pick from a selected set of
classes.
</p>
<p>Specifically, each strategy is a class which is defined with a certain
probability. An integer weight is provided in quotes to represent the
probability weight of the associated class. When cfengine is run,
it randomly picks one of the classes from each strategy.
Using strategies, you can choose different ways of
configuring or protecting a system, at random, thus confounding
environmental attempts to break into the system.
</p>
<p>Note that each strategy has a formal name (such as ‘<samp>my_strategy_alias</samp>’
in the example), but this name is not used to
attach a strategy to an action the same way that filters or ACLs are.
</p>
<hr>
<a name="tidy"></a>
<div class="header">
<p>
Next: <a href="#unmount" accesskey="n" rel="next">unmount</a>, Previous: <a href="#strategies" accesskey="p" rel="previous">strategies</a>, Up: <a href="#Cfagent-reference" accesskey="u" rel="up">Cfagent reference</a> [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Variable-Index" title="Index" rel="index">Index</a>]</p>
</div>
<a name="tidy-1"></a>
<h3 class="section">4.39 tidy</h3>
<a name="index-Tidying-files"></a>
<a name="index-Deleting-files"></a>
<a name="index-tidy-1"></a>
<p>The tidy function is used to delete (remove permanently) unwanted files
from a system. It is useful for tidying up in <code>/tmp</code> or cleaning
out <code>core</code> files from users’ home directories. The form of an
entry is:
</p>
<table class="cartouche" border="1"><tr><td>
<p><!-- /@w -->
</p><div class="smallexample">
<pre class="smallexample">tidy:
<var>class</var>::
<var>/directory</var>
pattern/include=<var>wildcard</var>
recurse=<var>number/inf</var>
age=<var>days</var>
size=<var>number/empty</var>
type=<var>ctime/mtime/</var><b>atime</b>
dirlinks=<var>keep/tidy/delete</var>
rmdirs=<var>[true/all]/[<b>false/none</b>]/sub</var>
links=<b>stop/keep</b><var>/traverse/tidy</var>
compress=<var>true/on</var>/<b>false/off</b>
define=<var>classlist</var>
elsedefine=<var>classlist</var>
syslog=<var>true/on</var>/<var>false/off</var>
inform=<var>true/on</var>/<var>false/off</var>
audit=<var>true/on</var>/<var>false/off</var>
ifelapsed=<var>mins</var>
expireafter=<var>mins</var>
filter=<var>filter alias</var>
ignore=<var>pattern</var>
exclude=<var>pattern</var>
xdev=<var>true/on</var>/<b>false/off</b>
</pre></div>
</td></tr></table>
<p>Note that, each of the options below
can be written in either upper or lower case and abbreviated by any
unique abbreviation.
<a name="index-p_003d"></a>
<a name="index-pattern"></a>
<a name="index-a_003d-1"></a>
<a name="index-age"></a>
<a name="index-r_003d-1"></a>
<a name="index-recurse-1"></a>
<a name="index-compress"></a>
<a name="index-Compression-during-tidy"></a>
</p>
<dl compact="compact">
<dt><code><var>/directory</var></code></dt>
<dd><p>This is the directory name to directories which mark the start of a
search for files matching certain wildcards. The wildcard <code>home</code>
may be used instead of an explicit directory, in which case cfengine
iterates over all home directories. It is compulsory to specify a
directory.
</p>
</dd>
<dt><code>pattern=<var>wildcard</var> or include=<var>wildcard</var></code></dt>
<dd><p>A wildcard or filename to match the files you wish to be deleted. The
pattern may contain the special symbols ‘<samp>?</samp>’ which matches a single
character and ‘<samp>*</samp>’ which matches any number of characters as in the
shell. These two options are synonymous, as of version 2.0.x.
Note that, this pattern is processed as a filter before any other filter
and, for safety reasons, it defaults to nothing. Thus, if you want to
use a filter to select the files, you should set ‘<samp>pattern=*</samp>’, else
the filter will not see any files at all.
<a name="index-pattern_003d-and-filtering"></a>
<a name="index-Wildcards"></a>
</p>
</dd>
<dt><code>exclude=<var>wildcard</var></code></dt>
<dd><p>This does not work for the home directive; use the global ignore list for this.
</p>
</dd>
<dt><code>ignore=<var>wildcard</var></code></dt>
<dd><p>This does not work for the home directive; use the global ignore list for this.
</p>
</dd>
<dt><code>recurse=<var>number/inf</var></code></dt>
<dd><p>This specifier tells cfengine whether or not to recurse into
subdirectories. If the value is zero, only the named file or directory
is affected. If the value is 1, it will open at most one level of
subdirectory and affect the files within this scope. If the value is
<code>inf</code> then cfengine opens all subdirectories and files beginning
from the specified filename. See <a href="#Recursion">Recursion</a>.
</p>
</dd>
<dt><code>age=<var>days</var></code></dt>
<dd><p>The age of a file in days represents a minimum <em>access</em> time
elapsed before the file will be deleted. In other word a file will be
deleted if it has not been accessed for <var>days</var> days.
</p>
</dd>
<dt><code>links=<var>stop/traverse/tidy</var></code></dt>
<dd><p>Normally cfengine does not descend into subdirectories which are pointed
to by symbolic links. If you wish to force it to do so (without using
the <code>-l</code> command line option) you may give this option the value
<code>true</code>, or <code>traverse</code>, or <code>follow</code>. To specify no
recursion you set the value <code>false</code> or <code>stop</code>.
<a name="index-Links_002c-traversing-in-searches-1"></a>
<a name="index-_002dl-1"></a>
<a name="index-_002dl-option-1"></a>
Note that the value set here in the cfengine program <em>always
overrides</em> the value set by the <code>-l</code> command line option, so you
can protect certain actions from this command line option by specifying
a negative value here. If you specify no value here, the behaviour is
determined by what you specify on the command line.
</p>
<p>The value <code>links=tidy</code> has the same effect as the ‘<samp>-L</samp>’ command
line option except that here it may be specified per item rather than
globally. Setting this value causes links which point to non-existent
files to be deleted. This feature will not work on commands with the
‘<samp>home</samp>’ wildcard feature. If you want to clean up old links you
should either user a <code>files</code> command or the command line option
which sets the tidy feature globally.
<a name="index-Deleting-stale-links-1"></a>
<a name="index-Links_002c-deleting-stale-1"></a>
</p>
</dd>
<dt><code>size=><var>number/empty</var></code></dt>
<dd><p>Old syntax <code>size=<var>number/empty</var></code>.
The value of this parameter decides the size of files to be deleted.
Files larger than this value will be deleted if they also are older than
the time specified in <code>age</code>. The default size is zero so that any
file which gets matched by another critereon is deleted. However, if you
want to single out only totally empty files, the <code>empty</code> may be used.
With this option only empty files, nevery files with anything in them,
will be deleted, if older than <code>age</code>. By default, the filesizes
are in kilobytes, but kilobytes and megabytes may also be specified by
appending b,k,m to the numbers. Only the first character after the
number is significant so you may write the numbers however it might be
convenient, e.g. <kbd>14k</kbd>, <kbd>14kB</kbd>, <kbd>14kilobytes</kbd>, the same as
for <code>disable</code>.
<a name="index-Specifying-file-sizes"></a>
<a name="index-File-sizes_002c-specifying"></a>
<a name="index-Megabytes_002c-filesize-unit"></a>
<a name="index-Kilobyte_002c-filesize-unit"></a>
<a name="index-Empty-files"></a>
<a name="index-Tidying-empty-files"></a>
</p>
</dd>
<dt><code>type=<var>ctime/mtime/atime</var></code></dt>
<dd><p>This value is used to set the type of time comparison made using
<code>age</code>. The default is to compare access times (atime) or
the last time the file was read. A comparison by modification
time (mtime) uses the last time the contents of the file was
changed. The ctime parameter is the last time the contents, owner
or permissions of the file were changed. Note that on directories,
mtime is always used for comparisons, since the very act of stat’ing
alters atime and makes this comparison meaningless.
</p>
</dd>
<dt><code>dirlinks=<var>keep/tidy/delete</var></code></dt>
<dd><p>This value is used to decide whether cfengine will delete
links which point to directories. The default value is to keep
the links. Note that, if the <code>travlinks</code> option is switched on,
cfengine will not tidy or delete links which point to directories,
instead it follows them into the subdirectory. This is a supplement
to the <code>rmdirs</code> option. You need both to make links
to directories disappear. Note that, even if <code>travlinks</code>
is set to true, cfagent will not follow symbolic links that are
not owned by the agent user ID; this is to prevent link race attacks,
in which users with write access could divert the agent to another part
of the filesystem,
<a name="index-Security_002c-link-races-and-travlinks"></a>
<a name="index-travlinks"></a>
</p>
<a name="index-Tidy-by-ctime_002c-mtime_002c-atime"></a>
<a name="index-ctime-tidies"></a>
<a name="index-mtime-tidies"></a>
<a name="index-atime-tidies"></a>
</dd>
<dt><code>rmdirs=<var>true/false/all/sub</var></code></dt>
<dd><p>Normally cfengine will not delete directories. If this option is
set to ‘true’ then cfengine will delete any directories which
are <em>empty</em>. Non-empty directories will not be touched and no
message will be given unless in verbose mode. Note that this
option overrides the above option <code>dirlinks</code>, so that even
links which point to empty directories will be removed.
If this is set to ‘sub’ then the topmost directory will not
be removed, only sub-directories.
</p>
<a name="index-rmdirs"></a>
<a name="index-Removing-directories"></a>
<a name="index-Deleting-directories"></a>
<a name="index-Directories_002c-deleting"></a>
</dd>
<dt><code>define=<var>classlist</var></code></dt>
<dd><p>The colon, comma or dot separated list of classes becomes defined
if any file matching the specified pattern is deleted.
</p>
</dd>
<dt><code>xdev</code></dt>
<dd><p>Prevents cfengine from descending into file systems that are not on the
same device as the root of the rescurion path.
<a name="index-xdev-2"></a>
</p>
</dd>
</dl>
<p>Take a look at the following example:
</p>
<div class="smallexample">
<pre class="smallexample">tidy:
AllHomeServers::
home pattern=core R=inf age=0
home pattern=*~ R=inf age=7
home pattern=#* R=inf age=30
any::
/tmp/ pat=* R=inf age=1
/ pat=core R=2 age=0
/etc pat=hosts.equiv r=0 age=0
</pre></div>
<p>In the first example, all hosts in the group <code>AllHomeServers</code>
iterate a search over all user home directories looking for ‘core’ files
(older than zero days) and <code>emacs</code> backup files ‘<samp>*~</samp>’,
‘<samp>#*</samp>’ older than seven days.
</p>
<p>The default values for these options are the empty string for the
wildcard pattern, zero for the recursion and a specification of the age
is compulsory.
</p>
<a name="index-_002ecfengine_002erm"></a>
<a name="index-_002ecfengine_002erm-1"></a>
<p>When cfengine tidies users’ home directories, it keeps a log of all the
files it deletes each time it is run. This means that, in case of
accidents, the user can see that the file has been deleted and restore
it from backup. The log file is called <code>.cfengine.rm</code> and it is
placed in the home directory of each user. The file is owned by root,
but is readable to the user concerned.
</p>
<hr>
<a name="unmount"></a>
<div class="header">
<p>
Previous: <a href="#tidy" accesskey="p" rel="previous">tidy</a>, Up: <a href="#Cfagent-reference" accesskey="u" rel="up">Cfagent reference</a> [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Variable-Index" title="Index" rel="index">Index</a>]</p>
</div>
<a name="unmount-1"></a>
<h3 class="section">4.40 unmount</h3>
<a name="index-Unmounting-filesystems"></a>
<a name="index-unmount-1"></a>
<p>The unmount function unmounts non-required filesystems and removes the
appropriate entry from the filesystem table (<code>/etc/fstab</code> or
equivalent). The syntax is simply
</p>
<table class="cartouche" border="1"><tr><td>
<p><!-- /@w -->
</p><div class="smallexample">
<pre class="smallexample">unmount:
<var>class</var>::
<var>mounthost</var>:<var>filesystem</var>
deletedir=<var><b>true</b>/false</var>
deletefstab=<var><b>true</b>/false</var>
force=<var>true/<b>false</b></var>
ifelapsed=<var>mins</var>
expireafter=<var>mins</var>
</pre></div>
</td></tr></table>
<p>The options allow you to temporarily unmount a directory without actually
removing it from the filesystem table. The option <code>force</code> is not currently
implemented and will likely have to be system dependent.
For example:
</p>
<div class="smallexample">
<pre class="smallexample">unmount:
physics::
libraryserver:/$(site)/libraryserver/data
</pre></div>
<p>If the device is busy then the actual unmount will not take place until
it becomes free, or the machine is rebooted. This feature should work
on AIX systems, in spite of these machines inherent peculiarities in the
form of the filesystem table.
</p>
<p>Some users do not mount filesystems on a directory of the same name as the
source directory. This can lead to confusion.
Note, if you have problems removing a mounted filesystem, try using
the mountpoint of the filesystem, rather than the name of the filesystem itself,
in the unmount command.
</p>
<hr>
<a name="Cfservd_002econf-and-cfrun-reference"></a>
<div class="header">
<p>
Next: <a href="#Cfexecd-reference" accesskey="n" rel="next">Cfexecd reference</a>, Previous: <a href="#Cfagent-reference" accesskey="p" rel="previous">Cfagent reference</a>, Up: <a href="#Top" accesskey="u" rel="up">Top</a> [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Variable-Index" title="Index" rel="index">Index</a>]</p>
</div>
<a name="Cfservd-and-cfrun-reference"></a>
<h2 class="chapter">5 Cfservd and cfrun reference</h2>
<table class="menu" border="0" cellspacing="0">
<tr><td align="left" valign="top">• <a href="#cfservd-control" accesskey="1">cfservd control</a>:</td><td> </td><td align="left" valign="top">
</td></tr>
<tr><td align="left" valign="top">• <a href="#admit-grant-and-deny" accesskey="2">admit grant and deny</a>:</td><td> </td><td align="left" valign="top">
</td></tr>
<tr><td align="left" valign="top">• <a href="#cfrun" accesskey="3">cfrun</a>:</td><td> </td><td align="left" valign="top">
</td></tr>
<tr><td align="left" valign="top">• <a href="#Firewalls-and-NATs" accesskey="4">Firewalls and NATs</a>:</td><td> </td><td align="left" valign="top">
</td></tr>
</table>
<p>The server daemon is controlled by a file called
<samp>cfservd.conf</samp>.
<a name="index-cfservd_002econf-file"></a>
The syntax of this configuration file is deliberately modelled on
cfengine’s own configuration file, but despite the similarities, they are separate.
</p>
<p>You can use <code>groups</code> and <code>import</code> in both files
to break up files into convenient modules and to import
common resources, such as lists of groups.
</p>
<p>Note that the classes in the <samp>cfservd.conf</samp> file do not tell you the
classes of host which have access to files and directories, but rather
which classes of host pay attention to the access and deny commands when
the file is parsed.
</p>
<p>Authentication is not by class or group but by hostname, like
the <samp>/etc/exports</samp> file on most Unix systems. The syntax for the
file is as follows:
</p>
<table class="cartouche" border="1"><tr><td>
<p><!-- /@w -->
</p><div class="smallexample">
<pre class="smallexample">
control:
<var>classes</var>::
domain = ( <var>DNS-domain-name</var> )
cfrunCommand = ( "<var>script/filename</var>" ) # Quoted
MaxConnections = ( <var>maximum number of forked daemons</var> )
# ChecksumDatabase = ( <var>filename</var> ) - deprecated
IfElapsed = ( <var>time-in-minutes</var> )
DenyBadClocks = ( <var>false</var> )
AllowConnectionsFrom = ( <var>IP numbers</var> )
DenyConnectionsFrom = ( <var>IP numbers</var> )
AllowMultipleConnectionsFrom = ( <var>IP numbers</var> )
TrustKeysFrom = ( <var>IP numbers</var> )
AllowUsers = ( mark systemuser )
LogAllConnections = ( <var>false/true</var> )
LogEncryptedTransfers = ( <var>false/true</var> )
SkipVerify = ( <var>IP numbers</var> )
DynamicAddresses = ( <var>IP numbers</var> )
BindToInterface = ( <var>IP number</var>/<var>hostname</var> )
HostnameKeys = ( <var>true/false</var> )
groups:
<var>Group definitions</var>
import:
<var>Files to import</var>
admit: | grant:
<var>classes</var>::
/<var>file-or-directory</var>
<var>wildcards/hostnames</var>
deny:
<var>classes</var>::
/<var>file-or-directory</var>
<var>wildcards/hostnames</var> root=<var>hostlist</var> encrypt=<var>true/on</var>
</pre></div>
</td></tr></table>
<a name="index-Iteration-in-server-rules"></a>
<a name="index-cfservd_002econf-iteration"></a>
<p>Iteration of variables is allowed, hence:
</p>
<p><!-- /@w -->
</p><div class="smallexample">
<pre class="smallexample"> control:
Split = ( " " )
hostlist = ( "10.10.10.1 10.10.10.2 10.10.10.3" )
dirs = ( "bin etc lib" )
base = ( /usr )
#########################################################
admit:
$(base)/$(dirs) $(hostlist)
</pre></div>
<p>results in:
</p>
<div class="smallexample">
<pre class="smallexample"> Path: /usr/bin (encrypt=0)
Admit: 10.10.10.1 10.10.10.2 10.10.10.3 root=
Path: /usr/etc (encrypt=0)
Admit: 10.10.10.1 10.10.10.2 10.10.10.3 root=
Path: /usr/lib (encrypt=0)
Admit: 10.10.10.1 10.10.10.2 10.10.10.3 root=
</pre></div>
<p>The file consists of a control section and access information.
</p>
<hr>
<a name="cfservd-control"></a>
<div class="header">
<p>
Next: <a href="#admit-grant-and-deny" accesskey="n" rel="next">admit grant and deny</a>, Previous: <a href="#Cfservd_002econf-and-cfrun-reference" accesskey="p" rel="previous">Cfservd.conf and cfrun reference</a>, Up: <a href="#Cfservd_002econf-and-cfrun-reference" accesskey="u" rel="up">Cfservd.conf and cfrun reference</a> [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Variable-Index" title="Index" rel="index">Index</a>]</p>
</div>
<a name="control-cfservd"></a>
<h3 class="section">5.1 control cfservd</h3>
<table class="menu" border="0" cellspacing="0">
<tr><td align="left" valign="top">• <a href="#IP-address-ranges" accesskey="1">IP address ranges</a>:</td><td> </td><td align="left" valign="top">
</td></tr>
<tr><td align="left" valign="top">• <a href="#AllowConnectionsFrom" accesskey="2">AllowConnectionsFrom</a>:</td><td> </td><td align="left" valign="top">
</td></tr>
<tr><td align="left" valign="top">• <a href="#AllowMultipleConnectionsFrom" accesskey="3">AllowMultipleConnectionsFrom</a>:</td><td> </td><td align="left" valign="top">
</td></tr>
<tr><td align="left" valign="top">• <a href="#AllowUsers" accesskey="4">AllowUsers</a>:</td><td> </td><td align="left" valign="top">
</td></tr>
<tr><td align="left" valign="top">• <a href="#AutoExecCommand" accesskey="5">AutoExecCommand</a>:</td><td> </td><td align="left" valign="top">
</td></tr>
<tr><td align="left" valign="top">• <a href="#AutoExecInterval" accesskey="6">AutoExecInterval</a>:</td><td> </td><td align="left" valign="top">
</td></tr>
<tr><td align="left" valign="top">• <a href="#BindToInterface-in-cfservd" accesskey="7">BindToInterface in cfservd</a>:</td><td> </td><td align="left" valign="top">
</td></tr>
<tr><td align="left" valign="top">• <a href="#ChecksumDatabase-in-cfservd" accesskey="8">ChecksumDatabase in cfservd</a>:</td><td> </td><td align="left" valign="top">
</td></tr>
<tr><td align="left" valign="top">• <a href="#cfrunCommand" accesskey="9">cfrunCommand</a>:</td><td> </td><td align="left" valign="top">
</td></tr>
<tr><td align="left" valign="top">• <a href="#DenyBadClocks">DenyBadClocks</a>:</td><td> </td><td align="left" valign="top">
</td></tr>
<tr><td align="left" valign="top">• <a href="#DenyConnectionsFrom">DenyConnectionsFrom</a>:</td><td> </td><td align="left" valign="top">
</td></tr>
<tr><td align="left" valign="top">• <a href="#cfservd-HostnameKeys">cfservd HostnameKeys</a>:</td><td> </td><td align="left" valign="top">
</td></tr>
<tr><td align="left" valign="top">• <a href="#cfservd-IfElapsed">cfservd IfElapsed</a>:</td><td> </td><td align="left" valign="top">
</td></tr>
<tr><td align="left" valign="top">• <a href="#LogAllConnections">LogAllConnections</a>:</td><td> </td><td align="left" valign="top">
</td></tr>
<tr><td align="left" valign="top">• <a href="#LogEncryptedTransfers">LogEncryptedTransfers</a>:</td><td> </td><td align="left" valign="top">
</td></tr>
<tr><td align="left" valign="top">• <a href="#MaxConnections">MaxConnections</a>:</td><td> </td><td align="left" valign="top">
</td></tr>
<tr><td align="left" valign="top">• <a href="#TrustKeysFrom">TrustKeysFrom</a>:</td><td> </td><td align="left" valign="top">
</td></tr>
<tr><td align="left" valign="top">• <a href="#DynamicAddresses">DynamicAddresses</a>:</td><td> </td><td align="left" valign="top">
</td></tr>
</table>
<hr>
<a name="IP-address-ranges"></a>
<div class="header">
<p>
Next: <a href="#AllowConnectionsFrom" accesskey="n" rel="next">AllowConnectionsFrom</a>, Previous: <a href="#cfservd-control" accesskey="p" rel="previous">cfservd control</a>, Up: <a href="#cfservd-control" accesskey="u" rel="up">cfservd control</a> [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Variable-Index" title="Index" rel="index">Index</a>]</p>
</div>
<a name="IP-address-ranges-1"></a>
<h4 class="subsection">5.1.1 IP address ranges</h4>
<p>In the access control lists below, host ranges can be specified in a
number of ways i) as substrings, ii) as address ranges denoted by the
"-" hyphen, or iii) as CIDR (Classless Inter Domain Routing) notation.
For example
</p>
<div class="smallexample">
<pre class="smallexample">128.39.73
128.39.74.10/23
128.39.74-75.10-22
2001:700:700:3:290:27ff:fea2:4730-4790
2001:700:700:3:290:27ff:fea2:4730/64
</pre></div>
<p>In the CIDR notation, the slash followed by a number indicates the
netmask, or the number of bits which are common to a group of hosts.
Normally, this is connected to a specific subnet, but here it simply
represents the number of bits from the left which are fixed for matching;
all remaining bits are wildcards.
The following forms are equivalent:
</p>
<div class="smallexample">
<pre class="smallexample">128.39.74.
128.39.74.10/24
128.39.74.1-254
</pre></div>
<hr>
<a name="AllowConnectionsFrom"></a>
<div class="header">
<p>
Next: <a href="#AllowMultipleConnectionsFrom" accesskey="n" rel="next">AllowMultipleConnectionsFrom</a>, Previous: <a href="#IP-address-ranges" accesskey="p" rel="previous">IP address ranges</a>, Up: <a href="#cfservd-control" accesskey="u" rel="up">cfservd control</a> [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Variable-Index" title="Index" rel="index">Index</a>]</p>
</div>
<a name="AllowConnectionsFrom-1"></a>
<h4 class="subsection">5.1.2 AllowConnectionsFrom</h4>
<p>This variable allows a list
of numerical IP masks to be specified, which cfservd will allow connections from.
If the list is not empty and a host whose IP address is not specified
attempts to connect to the daemon, its connection will be closed
immediately.
This can be used to prevent hanging connection attacks from malicous
hosts and other denial of service attacks which would bind thread
resources.
</p>
<div class="smallexample">
<pre class="smallexample"> control:
AllowConnectionsFrom = ( 128.39.89 192.2.0.10 )
</pre></div>
<a name="index-AllowConnectionsFrom-variable"></a>
<a name="index-Hanging-connections-attacks"></a>
<a name="index-Denial-of-service-attacks"></a>
<hr>
<a name="AllowMultipleConnectionsFrom"></a>
<div class="header">
<p>
Next: <a href="#AllowUsers" accesskey="n" rel="next">AllowUsers</a>, Previous: <a href="#AllowConnectionsFrom" accesskey="p" rel="previous">AllowConnectionsFrom</a>, Up: <a href="#cfservd-control" accesskey="u" rel="up">cfservd control</a> [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Variable-Index" title="Index" rel="index">Index</a>]</p>
</div>
<a name="AllowMultipleConnectionsFrom-1"></a>
<h4 class="subsection">5.1.3 AllowMultipleConnectionsFrom</h4>
<p>This variable should contain a list of IP wildcards to hosts which are
allowed simultaneous sessions on the server. Hosts which are not in this
list are allowed to connect only once, i.e. they must terminate and
reconnect in order to establish a new session. This is to prevent a
possible attacker from opening multiple sockets and never closing them,
resulting in a denial of service attack. Hosts IP’s can be placed here
if they could have overlapping copy sessions (e.g. long backup transfers
which can run over time). This prevents the error message "Multiple
connections denied/spam shield".
</p>
<hr>
<a name="AllowUsers"></a>
<div class="header">
<p>
Next: <a href="#AutoExecCommand" accesskey="n" rel="next">AutoExecCommand</a>, Previous: <a href="#AllowMultipleConnectionsFrom" accesskey="p" rel="previous">AllowMultipleConnectionsFrom</a>, Up: <a href="#cfservd-control" accesskey="u" rel="up">cfservd control</a> [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Variable-Index" title="Index" rel="index">Index</a>]</p>
</div>
<a name="AllowUsers-1"></a>
<h4 class="subsection">5.1.4 AllowUsers</h4>
<p>This list determines which users are to be allowed to connect to the daemon.
Note that there is no way of identifying users except by their public keys.
If a malicious asserts their identity, when no public key for the named
user is known to the server, then they could spoof the identity of that
user. All users who should be allowed to connect need to be here.
This applies to use of cfrun.
<a name="index-cfrun_002c-limiting-users-on-server"></a>
<a name="index-Key-security-of-users"></a>
</p>
<p><!-- /@w -->
</p><div class="smallexample">
<pre class="smallexample">
AllowUsers = ( mark root )
</pre></div>
<p>In other words, this is a "security by obscurity" first defence against
picking up bad keys, when the server is in trust mode, with respect to a
host. The attacker must know a valid user name in order to even try
their luck entering into a key dialogue.
</p>
<p>This reduces the probability that spoofing can be successful. The only
real defence against spoofing is to make sure that all required public keys
are installed in advance, and to switch off trust.
</p>
<a name="index-AllowUsers"></a>
<a name="index-AllowUsers-in-cfservd"></a>
<hr>
<a name="AutoExecCommand"></a>
<div class="header">
<p>
Next: <a href="#AutoExecInterval" accesskey="n" rel="next">AutoExecInterval</a>, Previous: <a href="#AllowUsers" accesskey="p" rel="previous">AllowUsers</a>, Up: <a href="#cfservd-control" accesskey="u" rel="up">cfservd control</a> [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Variable-Index" title="Index" rel="index">Index</a>]</p>
</div>
<a name="AutoExecCommand-1"></a>
<h4 class="subsection">5.1.5 AutoExecCommand</h4>
<p>This variable no longer exists in cfengine version 2.
</p>
<hr>
<a name="AutoExecInterval"></a>
<div class="header">
<p>
Next: <a href="#BindToInterface-in-cfservd" accesskey="n" rel="next">BindToInterface in cfservd</a>, Previous: <a href="#AutoExecCommand" accesskey="p" rel="previous">AutoExecCommand</a>, Up: <a href="#cfservd-control" accesskey="u" rel="up">cfservd control</a> [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Variable-Index" title="Index" rel="index">Index</a>]</p>
</div>
<a name="AutoExecInterval-1"></a>
<h4 class="subsection">5.1.6 AutoExecInterval</h4>
<p>This variable no longer exists in version 2 of cfengine.
<a name="index-AutoExecInterval-variable"></a>
</p>
<hr>
<a name="BindToInterface-in-cfservd"></a>
<div class="header">
<p>
Next: <a href="#ChecksumDatabase-in-cfservd" accesskey="n" rel="next">ChecksumDatabase in cfservd</a>, Previous: <a href="#AutoExecInterval" accesskey="p" rel="previous">AutoExecInterval</a>, Up: <a href="#cfservd-control" accesskey="u" rel="up">cfservd control</a> [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Variable-Index" title="Index" rel="index">Index</a>]</p>
</div>
<a name="BindToInterface-in-cfservd-1"></a>
<h4 class="subsection">5.1.7 BindToInterface in cfservd</h4>
<p>If this is set to a specific IP address of an IP configured interface,
cfservd will listen for connections only on that interface. On Multi-homed
hosts this allows one to restrict the traffic to one interface. Note, Unix
only allows one or all interfaces to be selected. An interface must be
configured with an IP address in order to be bound.
<a name="index-Multihomed-hosts-1"></a>
<a name="index-BindToInterface-1"></a>
<a name="index-Binding-to-one-interface-only-1"></a>
</p>
<hr>
<a name="ChecksumDatabase-in-cfservd"></a>
<div class="header">
<p>
Next: <a href="#cfrunCommand" accesskey="n" rel="next">cfrunCommand</a>, Previous: <a href="#BindToInterface-in-cfservd" accesskey="p" rel="previous">BindToInterface in cfservd</a>, Up: <a href="#cfservd-control" accesskey="u" rel="up">cfservd control</a> [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Variable-Index" title="Index" rel="index">Index</a>]</p>
</div>
<a name="ChecksumDatabase-in-cfservd-1"></a>
<h4 class="subsection">5.1.8 ChecksumDatabase in cfservd</h4>
<p>(This variable is deprecated as of version 2.1.21. The location of the
database will be fixed internally.)
</p>
<p>This is the path and filename to a database which will cache
MD5 checksum values server-side. This optimization is only available
if you have the Berkeley database library ‘<samp>libdb</samp>’ on your
system. If this variable is not defined, no database caching
will be used and checksum values will be computed directly on
request. The utility of this solution is a trade-off between
the time it takes to compute the checksum versus the time
for a disk-based lookup.
<a name="index-ChecksumDatabase-variable"></a>
<a name="index-MD5-checksums-take-a-long-time-to-compute_002e"></a>
<a name="index-Checksums-take-too-long-to-compute_002e"></a>
</p>
<hr>
<a name="cfrunCommand"></a>
<div class="header">
<p>
Next: <a href="#DenyBadClocks" accesskey="n" rel="next">DenyBadClocks</a>, Previous: <a href="#ChecksumDatabase-in-cfservd" accesskey="p" rel="previous">ChecksumDatabase in cfservd</a>, Up: <a href="#cfservd-control" accesskey="u" rel="up">cfservd control</a> [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Variable-Index" title="Index" rel="index">Index</a>]</p>
</div>
<a name="cfrunCommand-1"></a>
<h4 class="subsection">5.1.9 cfrunCommand</h4>
<p>This string is the command which you would like to be executed
remotely by the <code>cfrun</code> command. Note that you must, in addition,
authorize access to this file in the <code>admit</code> section. The access
rule should (as usual) be to the actual file object path, not
including any symbolic links.
</p>
<a name="index-cfrunCommand-variable"></a>
<hr>
<a name="DenyBadClocks"></a>
<div class="header">
<p>
Next: <a href="#DenyConnectionsFrom" accesskey="n" rel="next">DenyConnectionsFrom</a>, Previous: <a href="#cfrunCommand" accesskey="p" rel="previous">cfrunCommand</a>, Up: <a href="#cfservd-control" accesskey="u" rel="up">cfservd control</a> [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Variable-Index" title="Index" rel="index">Index</a>]</p>
</div>
<a name="DenyBadClocks-1"></a>
<h4 class="subsection">5.1.10 DenyBadClocks</h4>
<p>If this is set to <code>off</code>, cfservd will not deny access to clients whose
clocks are off by more than one hour. The default is to deny access to
systems whose clocks differ by more than one hour. This can prevent
messages of the form ‘Can’t stat’ file when remote copying.
<a name="index-DenyBadClocks-variable"></a>
<a name="index-Can_0027t-stat-error-when-remote-copying"></a>
</p>
<hr>
<a name="DenyConnectionsFrom"></a>
<div class="header">
<p>
Next: <a href="#cfservd-HostnameKeys" accesskey="n" rel="next">cfservd HostnameKeys</a>, Previous: <a href="#DenyBadClocks" accesskey="p" rel="previous">DenyBadClocks</a>, Up: <a href="#cfservd-control" accesskey="u" rel="up">cfservd control</a> [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Variable-Index" title="Index" rel="index">Index</a>]</p>
</div>
<a name="DenyConnectionsFrom-1"></a>
<h4 class="subsection">5.1.11 DenyConnectionsFrom</h4>
<p>Hosts which are included by the allow-list above can be explicitly
denied access using this list.
</p>
<div class="smallexample">
<pre class="smallexample"> control:
DenyConnectionsFrom = ( 128.39.89.76 ) # rogue host
</pre></div>
<a name="index-DenyConnectionsFrom-variable"></a>
<hr>
<a name="cfservd-HostnameKeys"></a>
<div class="header">
<p>
Next: <a href="#cfservd-IfElapsed" accesskey="n" rel="next">cfservd IfElapsed</a>, Previous: <a href="#DenyConnectionsFrom" accesskey="p" rel="previous">DenyConnectionsFrom</a>, Up: <a href="#cfservd-control" accesskey="u" rel="up">cfservd control</a> [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Variable-Index" title="Index" rel="index">Index</a>]</p>
</div>
<a name="HostnameKeys-in-cfservd"></a>
<h4 class="subsection">5.1.12 HostnameKeys in cfservd</h4>
<p>If this variable is set to true/on, it causes cfservd to
lookup and store trusted public keys according to their
DNS fully qualified host name, instead of using the IP address.
This can be useful in environments where hosts do not have fixed
IP addresses, but do have fixed hostnames.
</p>
<div class="smallexample">
<pre class="smallexample">
HostnameKeys = ( on )
</pre></div>
<p>This method of storing keys is not recommended for sites with
fixed IP addresses, since it removes one security barrier
from a potential attacker by potentially allowing DNS spoofing.
</p>
<hr>
<a name="cfservd-IfElapsed"></a>
<div class="header">
<p>
Next: <a href="#LogAllConnections" accesskey="n" rel="next">LogAllConnections</a>, Previous: <a href="#cfservd-HostnameKeys" accesskey="p" rel="previous">cfservd HostnameKeys</a>, Up: <a href="#cfservd-control" accesskey="u" rel="up">cfservd control</a> [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Variable-Index" title="Index" rel="index">Index</a>]</p>
</div>
<a name="IfElapsed-in-cfservd"></a>
<h4 class="subsection">5.1.13 IfElapsed in cfservd</h4>
<p>The <code>IfElapsed</code> anti-spamming filter is also built into
<code>cfservd</code> so that a remote user cannot even get as far as
causing cfengine to parse its input files (which could
be used for spamming in itself). The time is in minutes,
the default is one hour.
</p>
<hr>
<a name="LogAllConnections"></a>
<div class="header">
<p>
Next: <a href="#LogEncryptedTransfers" accesskey="n" rel="next">LogEncryptedTransfers</a>, Previous: <a href="#cfservd-IfElapsed" accesskey="p" rel="previous">cfservd IfElapsed</a>, Up: <a href="#cfservd-control" accesskey="u" rel="up">cfservd control</a> [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Variable-Index" title="Index" rel="index">Index</a>]</p>
</div>
<a name="LogAllConnections-1"></a>
<h4 class="subsection">5.1.14 LogAllConnections</h4>
<p>If set to true, every successful connection will be logged to syslog.
This could be useful for identifying abuses of the service, if the server
should come under attack, e.g. a denial of service attack. The IP address
can then be excluded from the allowed connections list.
</p>
<hr>
<a name="LogEncryptedTransfers"></a>
<div class="header">
<p>
Next: <a href="#MaxConnections" accesskey="n" rel="next">MaxConnections</a>, Previous: <a href="#LogAllConnections" accesskey="p" rel="previous">LogAllConnections</a>, Up: <a href="#cfservd-control" accesskey="u" rel="up">cfservd control</a> [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Variable-Index" title="Index" rel="index">Index</a>]</p>
</div>
<a name="LogEncryptedTransfers-1"></a>
<h4 class="subsection">5.1.15 LogEncryptedTransfers</h4>
<p>If set to true, every successful request for a file that is granted
access only with an encrypted connection is logged in syslog.
</p>
<hr>
<a name="MaxConnections"></a>
<div class="header">
<p>
Next: <a href="#TrustKeysFrom" accesskey="n" rel="next">TrustKeysFrom</a>, Previous: <a href="#LogEncryptedTransfers" accesskey="p" rel="previous">LogEncryptedTransfers</a>, Up: <a href="#cfservd-control" accesskey="u" rel="up">cfservd control</a> [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Variable-Index" title="Index" rel="index">Index</a>]</p>
</div>
<a name="MaxConnections-1"></a>
<h4 class="subsection">5.1.16 MaxConnections</h4>
<p>This integer value sets a limit on the maximum number of
child daemon threads which cfservd will ‘fork’ in order
to handle remote requests. The default value is ten.
<a name="index-MaxConnections-variable"></a>
</p>
<hr>
<a name="TrustKeysFrom"></a>
<div class="header">
<p>
Next: <a href="#DynamicAddresses" accesskey="n" rel="next">DynamicAddresses</a>, Previous: <a href="#MaxConnections" accesskey="p" rel="previous">MaxConnections</a>, Up: <a href="#cfservd-control" accesskey="u" rel="up">cfservd control</a> [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Variable-Index" title="Index" rel="index">Index</a>]</p>
</div>
<a name="TrustKeysFrom-1"></a>
<h4 class="subsection">5.1.17 TrustKeysFrom</h4>
<p>Hosts which are included in this list are automatically
trusted, if cfservd does not know their public key. This
allows public keys to be exchanged. Cfservd will not automatically
accept a public key from a host it does not know, since the
key will be used to assert strong authentication later.
Once a public key has been associated with an IP address, it
will never be updated, unless the existing key is deleted by hand.
</p>
<div class="smallexample">
<pre class="smallexample"> control:
TrustKeysFrom = ( 128.39.89.76 ) # trusted host
TrustKeysFrom = ( 128.39.89.76/24 ) # trusted subnet
</pre></div>
<a name="index-TrustKeysFrom-variable"></a>
<hr>
<a name="DynamicAddresses"></a>
<div class="header">
<p>
Previous: <a href="#TrustKeysFrom" accesskey="p" rel="previous">TrustKeysFrom</a>, Up: <a href="#cfservd-control" accesskey="u" rel="up">cfservd control</a> [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Variable-Index" title="Index" rel="index">Index</a>]</p>
</div>
<a name="DynamicAddresses-1"></a>
<h4 class="subsection">5.1.18 DynamicAddresses</h4>
<p>Hosts which are included in this list are assumed to have IP addresses which
can change with time, e.g. hosts which are given IP addresses by DHCP
or a BOOTP like protocol.
<a name="index-DHCP-addresses"></a>
</p>
<div class="smallexample">
<pre class="smallexample"> control:
DynamicAddresses = ( 128.39.74.100-200 ) # DHCP range
</pre></div>
<a name="index-DynamicAddresses-variable"></a>
<p>If cfservd receives a connection from an IP address that is in this list,
and trustkey is <em>true</em>, the existing key for that IP address can be
replaced with a new key, and the old key is recorded in a "used keys"
list, access is granted. If trust is switched off, the server looks
in the "used key list" to see if the key has been seen before. If not
access is refused. If it has been seen before – it uses this earlier
trust to accept the connection and replace the IP-key binding.
<a name="index-DHCP-1"></a>
<a name="index-Dynamic-addresses"></a>
</p>
<p>Note that used keys are kept in a database for easy lookup, whereas
fixed keys are kept in files for easy administration. If host keys
change or are reinstalled on the dynamically allocated hosts, then
this database should probably be deleted to purge keys that become
illegal.
</p>
<p>DHCP addresses have no effect on hosts that use IPV6, since IPV6 addresses
are generally issued based on an interface MAC address and do not therefore
change.
<a name="index-IPV6-and-DHCP"></a>
</p>
<hr>
<a name="admit-grant-and-deny"></a>
<div class="header">
<p>
Next: <a href="#cfrun" accesskey="n" rel="next">cfrun</a>, Previous: <a href="#cfservd-control" accesskey="p" rel="previous">cfservd control</a>, Up: <a href="#Cfservd_002econf-and-cfrun-reference" accesskey="u" rel="up">Cfservd.conf and cfrun reference</a> [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Variable-Index" title="Index" rel="index">Index</a>]</p>
</div>
<a name="admit_002c-grant-and-deny"></a>
<h3 class="section">5.2 admit, grant and deny</h3>
<table class="menu" border="0" cellspacing="0">
<tr><td align="left" valign="top">• <a href="#root_003d" accesskey="1">root=</a>:</td><td> </td><td align="left" valign="top">
</td></tr>
<tr><td align="left" valign="top">• <a href="#encrypt_003d" accesskey="2">encrypt=</a>:</td><td> </td><td align="left" valign="top">
</td></tr>
<tr><td align="left" valign="top">• <a href="#SkipVerify" accesskey="3">SkipVerify</a>:</td><td> </td><td align="left" valign="top">
</td></tr>
</table>
<hr>
<a name="root_003d"></a>
<div class="header">
<p>
Next: <a href="#encrypt_003d" accesskey="n" rel="next">encrypt=</a>, Previous: <a href="#admit-grant-and-deny" accesskey="p" rel="previous">admit grant and deny</a>, Up: <a href="#admit-grant-and-deny" accesskey="u" rel="up">admit grant and deny</a> [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Variable-Index" title="Index" rel="index">Index</a>]</p>
</div>
<a name="root_003d-1"></a>
<h4 class="subsection">5.2.1 <code>root=</code></h4>
<p>This list specifies the names of hosts which are to have read
access to files, regardless of the owner of the file. This effectively
gives root users on connecting hosts privileges to non-root owned
files on the server, but not vice-versa, similar to the NFS root mapping,
except that there is no question of a client being able to modify files
on the server. Caution: cfservd trusts the DNS service, so be aware that
cache poisoning attacks are a possible way of bypassing access controls.
</p>
<p><b>Cfservd requires you to grant access to files without following any symbolic
links. You must grant access to the real file or directory in order to access
the file object.</b> This is a security feature in case parties with login access
to the server could grant access to additional files by having the permission
to create symbolic links in a transitory directory, e.g. <samp>/tmp</samp>.
<a name="index-Symbolic-links-in-admit"></a>
<a name="index-Links-in-access-control"></a>
<a name="index-Access-control-by-directory"></a>
<a name="index-Access-control-and-symlinks"></a>
</p>
<p>As of version 2.0.4: Once a verified host address has been identified with a functioning
public/private key authentication, the IP address is added to the SkipVerify
list, so that time is not wasted in verifying reverse lookups, when the
identify can be verified more efficiently and securely by a key mechanism.
<a name="index-SkipVerify-and-public_002dprivate-keys"></a>
<a name="index-Caching-of-reverse-lookups"></a>
<a name="index-Reverse-lookup-and-SkipVerify"></a>
<a name="index-SkipVerify"></a>
</p>
<hr>
<a name="encrypt_003d"></a>
<div class="header">
<p>
Next: <a href="#SkipVerify" accesskey="n" rel="next">SkipVerify</a>, Previous: <a href="#root_003d" accesskey="p" rel="previous">root=</a>, Up: <a href="#admit-grant-and-deny" accesskey="u" rel="up">admit grant and deny</a> [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Variable-Index" title="Index" rel="index">Index</a>]</p>
</div>
<a name="encrypt_003dtrue"></a>
<h4 class="subsection">5.2.2 <code>encrypt=true</code></h4>
<p>If this option is set, cfservd will only serve the named files
if the copy access type is <code>secure</code>, i.e. on an encrypted
link. This presupposes that cfengine has been compiled with
a working OpenSSL library.
</p>
<hr>
<a name="SkipVerify"></a>
<div class="header">
<p>
Previous: <a href="#encrypt_003d" accesskey="p" rel="previous">encrypt=</a>, Up: <a href="#admit-grant-and-deny" accesskey="u" rel="up">admit grant and deny</a> [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Variable-Index" title="Index" rel="index">Index</a>]</p>
</div>
<a name="SkipVerify-1"></a>
<h4 class="subsection">5.2.3 SkipVerify</h4>
<p>If connecting hosts use a Network Address Translator in order to share an IP address,
reverse lookup will fail to give a correct verification of host identity.
You can switch off cfservd’s verification of IP host identity for specific IP addresses
or patterns using this command. E.g.
</p>
<div class="smallexample">
<pre class="smallexample">
SkipVerify = ( 192.0.0.10 192.0.2. )
</pre></div>
<p>This does not affect key verification.
</p>
<p>NOTE!! This is a security risk because it means that cfservd implicitly
trusts the connecting hosts! You should be very careful in using
Network Address Translators in a secure environment. It is not recommended
for sites which require a high level of security.
<a name="index-Network-Address-Translators"></a>
<a name="index-Security-risk"></a>
</p>
<hr>
<a name="cfrun"></a>
<div class="header">
<p>
Next: <a href="#Firewalls-and-NATs" accesskey="n" rel="next">Firewalls and NATs</a>, Previous: <a href="#admit-grant-and-deny" accesskey="p" rel="previous">admit grant and deny</a>, Up: <a href="#Cfservd_002econf-and-cfrun-reference" accesskey="u" rel="up">Cfservd.conf and cfrun reference</a> [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Variable-Index" title="Index" rel="index">Index</a>]</p>
</div>
<a name="cfrun-1"></a>
<h3 class="section">5.3 <code>cfrun</code></h3>
<p>The general syntactic form of the <code>cfrun</code> command is
</p>
<table class="cartouche" border="1"><tr><td>
<p><!-- /@w -->
</p><div class="smallexample">
<pre class="smallexample">
cfrun -<var>option</var> --<var>longoption</var> <var>class1</var> <var>class2 ...</var>
</pre></div>
</td></tr></table>
<p>Since <code>cfrun</code> addresses remote hosts, there is an ambiguity in
whether options are intended for the <code>cfrun</code> command itself, on the local
host, or whether they are to be passed on to the agent on the remote hosts.
To clarify this distinction, the arguments are organized as follows:
</p>
<table class="cartouche" border="1"><tr><td>
<p><!-- /@w -->
</p><div class="smallexample">
<pre class="smallexample">
cfrun -<var>local options</var> -- <var>remote options</var> -- <var>remote classes</var>
</pre></div>
</td></tr></table>
<p>Local options are processed by <code>cfrun</code> on the local host; remote options
are passed on as options to the remote <code>cfagent</code> (actually to the
command defined in <code>cfrunCommand</code> in the file <samp>cfservd.conf</samp>;
remote classes are processed by the remote <code>cfservd</code> service, and specifiy
classes which must be satisfied by the remote host in order to invoke the
remote command.
</p>
<p>The ‘<samp>-q</samp>’ and ‘<samp>-I</samp>’ options are
always assumed when executing cfengine remotely, so that <code>SplayTime</code> is
effectively zero when polling hosts serially, and the output always
shows what is happening on the remote hosts.
<a name="index-SplayTime-in-cfrun"></a>
</p>
<a name="index-_002dT-in-cfrun_002e"></a>
<a name="index-Trust_002c-key-exchange-with-cfrun"></a>
<p>On connecting to a remote host, cfengine attempts to obtain credentials
by exchanging keys. Unknown keys, in a key exchange, need to be explicitly
accepted on trust. Normally, the interactive <code>cfrun</code> program prompts
the user explicitly, (like in the secure shell, <code>ssh</code>, connections).
This can be annoying if there are many hosts to connect to.
The ‘<samp>-T</samp>’ option tells cfengine to trust all new keys. This option
should be used with caution, and only at times when one is sure that the
hosts one is connecting to are trustworthy.
</p>
<p>Each host evaluates the classes sent by <code>cfrun</code>
and decides whether cfengine should be invoked.
<a name="index-Running-cfrun"></a>
Only hosts which belong to the classes defined on the <code>cfrun</code>
command line are executed. This allows you to single out groups of hosts
which should execute cfengine, based on the very classes which you have
defined for your configuration. If no classes are sent on the command
line, then all hosts are run.
</p>
<p><code>cfrun</code> uses a configuration file which is located under the
<code>CFINPUTS</code> directory in order to determine which hosts and in
which order it should try to connect. Because cfengine always uses a
reliable TCP protocol for connections, it verifies each connection
rather than simply broadcasting openly. Using this file you can even
simulate broadcasting to hosts outside your subnet.
<a name="index-Broadcasts-to-the-cfengine-service_002e"></a>
</p>
<p>This file should contain every host name you ever want to
configure remotely, because you can still select subsets of
the file by specifying classes which the remote host will understand.
If the remote host is not in one of the classes you specify when you
run <code>cfrun</code>, then it will simply ignore the request. Conversely,
if you do not place a host in this file, it will never be contacted
when you use the <code>cfrun</code> command. The format of the file
is as follows
</p>
<table class="cartouche" border="1"><tr><td>
<p><!-- /@w -->
</p><div class="smallexample">
<pre class="smallexample">
#
# Comment ..
#
domain=<var>my.domain</var>
access=<var>user1</var>,<var>user2</var>
outputdir=<var>directory</var>
maxchild=<var>number limit</var>
hostnamekeys=<var>true/false</var>
bindtointerface=<var>IP address</var>
<var>hostname1</var> <var>options</var>
<var>hostname2</var>:<var>port</var> <var>options</var>
...
include=cfrun.site1.external.hosts
include=cfrun.site1.internal.hosts
include=cfrun.site2.private.hosts
include=cfrun.site2.shared.hosts
</pre></div>
</td></tr></table>
<a name="index-hostnamekeys"></a>
<a name="index-include-in-cfrun"></a>
<p>If the option <code>outputdir</code> is present, cfrun forks a separate
process for each host and passes the output to files in a named directory.
The <code>maxchild</code> line limits the number of forked processes.
</p>
<p>It is important to add the domain-name to this file.
The options you specifiy in this file, per host, are added to those
you might specify on the command line when invoking cfengine remotely.
For instance, you might know of a bug on one host and decide not to
perform interface configuration on that one machine. You would write
a line like this:
</p>
<div class="smallexample">
<pre class="smallexample">
funny.domain -- -i # problem host
</pre></div>
<a name="index-Running-cfengine-from-a-single-master-host"></a>
<a name="index-Running-cfengine-from-a-single-master-host-1"></a>
<p>You could use <code>cfrun</code> inside one of your cfengine configuration
files in order to remotely execute cfengine on all of the other network
machines, by setting up a host list. The disadvantage however is that
cfengine has to poll the systems on the network, which means that
cfengine cannot be working in parallel on all hosts.
</p>
<p>Some other examples:
</p>
<div class="smallexample">
<pre class="smallexample">
e.g. cfrun -- -- linux Run on all linux machines
cfrun -- -p Ping and parse on all hosts
cfrun -v -- -p Ping all, local verbose
cfrun -v -- -k -- solaris Local verbose, all solaris, but no copy
</pre></div>
<p>Amongst the local options, one may specify a subset of the hosts which are to
be contacted by cfrun, i.e. to avoid processing the entire list of hosts. For
example, to contact only host1 and host2, given that they are already in
the list of hosts.
</p>
<div class="smallexample">
<pre class="smallexample">
cfrun -v host1 host2
cfrun -v host1 host2 -- -p
</pre></div>
<a name="index-Contacting-specific-hosts-with-cfrun"></a>
<hr>
<a name="Firewalls-and-NATs"></a>
<div class="header">
<p>
Previous: <a href="#cfrun" accesskey="p" rel="previous">cfrun</a>, Up: <a href="#Cfservd_002econf-and-cfrun-reference" accesskey="u" rel="up">Cfservd.conf and cfrun reference</a> [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Variable-Index" title="Index" rel="index">Index</a>]</p>
</div>
<a name="Firewalls-and-NATs-1"></a>
<h3 class="section">5.4 Firewalls and NATs</h3>
<p>Firewalls and Network Address Translators (NAT) can be a problem for
addressing. Suppose you have a firewall and with a private IP-range
behind the firewall. You want to update the nodes from a central
host. You can do a two stage configuration: first update the firewall and
then update from the firewall to the nodes.
</p>
<p>But suppose you already use SNAT (Source Network Address Translation) and DNAT
(Destination ...) for the nodes. With DNAT you can say that socket 22000
on the firewall is routed to <var>host-name</var>:5308. DNAT gives us the
possibilty to update the nodes from a central server in one step instead
of two.
</p>
<p>If the port command is given cfrun uses this to connect to the client
instead of the default (5308) one.
Here is an example (<samp>cfrun.hosts</samp>):
</p>
<div class="smallexample">
<pre class="smallexample">domain=example.org
access=mark,sigmund
hostnamekeys=true
node1.example.org
node2.example.org:22000 -DNis
node2.example.org:22001
</pre></div>
<a name="index-HostnameKeys"></a>
<p>This connects to: 1) node1 with standard port, 2) node2 with port 22000 and extra options -DNis
and, 3) node2 with port 22000.
</p>
<a name="index-NAT"></a>
<a name="index-Network-address-translator"></a>
<a name="index-Changing-cfengine-port"></a>
<a name="index-Port_002c-connecting-to-different"></a>
<hr>
<a name="Cfexecd-reference"></a>
<div class="header">
<p>
Next: <a href="#Problem-solving" accesskey="n" rel="next">Problem solving</a>, Previous: <a href="#Cfservd_002econf-and-cfrun-reference" accesskey="p" rel="previous">Cfservd.conf and cfrun reference</a>, Up: <a href="#Top" accesskey="u" rel="up">Top</a> [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Variable-Index" title="Index" rel="index">Index</a>]</p>
</div>
<a name="Cfexecd-reference-1"></a>
<h2 class="chapter">6 Cfexecd reference</h2>
<p>In wrapper mode (non-forking, non-daemon mode), cfagent is run by adding a
line to the root crontab file of each system:
</p>
<div class="smallexample">
<pre class="smallexample">0,30 * * * * /usr/local/sbin/cfexecd -F
</pre></div>
<p>This is enough to ensure that cfengine will get run. Any output generated
by this job, will be stored in <samp>/var/cfengine/outputs</samp>.
</p>
<p>The program <code>cfexecd</code> operates as a wrapper for cfagent. It has the
following options:
</p>
<div class="smallexample">
<pre class="smallexample">-h (--help)
-d (--debug)
-v (--verbose)
-q (--no-splay)
-F (--no-fork)
-1 (--once)
-g (--foreground)
-p (--parse-only)
-L (--ld-library-path)
</pre></div>
<a name="index-_002fvar_002fcfengine_002foutput"></a>
<a name="index-_002fvar_002fcfengine_002foutput-1"></a>
<a name="index-Output-logs"></a>
<p>In addition, if you add the following to the file <samp>cfagent.conf</samp>,
the system administrator will be emailed a summary of any output:
</p>
<div class="smallexample">
<pre class="smallexample">
control:
smtpserver = ( mailhub.example.org ) # site MTA which can talk smtp
sysadm = ( mark@example.org ) # mail address of sysadm
EmailMaxLines = ( <var>n</var> ) # max lines of output to email
OutputPrefix = ( "!" ) # Line prefix
</pre></div>
<p>Fill in suitable values for these variables. <code>EmailMaxLines</code> may
be set to 0 to disable email output, a postive integer to set a limit,
or <code>inf</code> to email the whole output regardless of its size. If
undefined, <code>EmailMaxLines</code> defaults to 100.
</p>
<a name="index-Mailing-output"></a>
<a name="index-smtpserver-1"></a>
<a name="index-sysadm-3"></a>
<a name="index-EmailMaxLines"></a>
<a name="index-cfexecd"></a>
<p>An alternative, or additional way to run cfengine, is to run the <samp>cfexecd</samp>
program is daemon mode (without the ‘<samp>-F</samp>’) option. In this mode, the daemon
lives in the background and sleeps, activating only in accordance with
a scheduling policy. The default policy is to run once every hour (equivalent
to <code>Min00_05</code>). Here is how you would modify <samp>cfagent.conf</samp> in
order to make the daemon execute cfagent every half-hour:
</p>
<div class="smallexample">
<pre class="smallexample"> control:
# When should cfexecd in daemon mode wake up the agent?
schedule = ( Min00_05 Min30_35 )
</pre></div>
<p>Note that the time specifications are the basic cfengine <em>time classes</em>.
Although one of these methods should suffice,
no harm will arise from running both cron and the cfexecd side-by-side.
Locking mechanisms are used by <code>cfagent</code> to ensure that no contention will occur.
<a name="index-Mailing-output-1"></a>
<a name="index-smtpserver-2"></a>
<a name="index-sysadm-4"></a>
<a name="index-cfexecd-1"></a>
</p>
<p>Note, that if problems with library path for compiled-in libraries occur, an
explicit library path can be specified with the ‘<samp>-L</samp>’ option.
</p>
<div class="smallexample">
<pre class="smallexample">0,30 * * * * /usr/local/sbin/cfexecd -F -L /local/iu/lib:/local/lib:/local/gnu/lib
</pre></div>
<p>The output generated by a cfagent run is collected and stored with
date stamps in the <samp>outputs</samp> subdirectory of the work directory
(usually <samp>/var/cfengine/outputs</samp>). If cfengine has a valid smtp
server configured it will attempt to E-mail new reports to the system
administrator. Duplicate reports are suppressed however for a period
of one day. Thus, if one has a repeating message, then it will only be
sent by E-mail once per day – this feature is meant to prevent
cfagent from spamming administators with multiple, indentical reports.
As soon a report different from the previous one is received, the
memory is reset.
</p>
<p>Note: this repeated message suppression feature cannot work if you include
time dependent data in messages, i.e. if you include the date or time in an
alert, then clearly the message will be a different message each time. Output
from cfengine should not contain the time or date, except in the E-mail header.
</p>
<a name="index-Mail-from-cfexecd"></a>
<a name="index-Spam-suppression"></a>
<hr>
<a name="Problem-solving"></a>
<div class="header">
<p>
Next: <a href="#Example-configuration-file" accesskey="n" rel="next">Example configuration file</a>, Previous: <a href="#Cfexecd-reference" accesskey="p" rel="previous">Cfexecd reference</a>, Up: <a href="#Top" accesskey="u" rel="up">Top</a> [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Variable-Index" title="Index" rel="index">Index</a>]</p>
</div>
<a name="Problem-solving-1"></a>
<h2 class="chapter">7 Problem solving</h2>
<table class="menu" border="0" cellspacing="0">
<tr><td align="left" valign="top">• <a href="#cf_002epreconf-bootstrap-file" accesskey="1">cf.preconf bootstrap file</a>:</td><td> </td><td align="left" valign="top">
</td></tr>
<tr><td align="left" valign="top">• <a href="#cfrc-resource-file" accesskey="2">cfrc resource file</a>:</td><td> </td><td align="left" valign="top">
</td></tr>
</table>
<hr>
<a name="cf_002epreconf-bootstrap-file"></a>
<div class="header">
<p>
Next: <a href="#cfrc-resource-file" accesskey="n" rel="next">cfrc resource file</a>, Previous: <a href="#Problem-solving" accesskey="p" rel="previous">Problem solving</a>, Up: <a href="#Problem-solving" accesskey="u" rel="up">Problem solving</a> [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Variable-Index" title="Index" rel="index">Index</a>]</p>
</div>
<a name="cf_002epreconf-bootstrap-file-1"></a>
<h3 class="section">7.1 cf.preconf bootstrap file</h3>
<a name="index-cf_002epreconf-bootstrap-file"></a>
<a name="index-cf_002epreconf"></a>
<a name="index-Bootstrap-file"></a>
<a name="index-Deadlock"></a>
<a name="index-Hung-machine"></a>
<p>In some cases you will want to run cfengine on a system to configure it
from scratch. If the system is in a very bad way, it might not even be
able to parse the cfengine configuration file, perhaps because the
network was not properly configured or the DNS (Domain Name Service) was
out of action. To help prevent this situation, cfengine looks for a
script called <code>cf.preconf</code> which gets executed prior to parsing and
can be used to perform any emergency tests. This file needs only
contain enough to get the system to parse the configuration files.
</p>
<p><code>cf.preconf</code> may be any script in any language. It need not exist
at all! It is fed one argument by cfengine, namely the system hard-class
for the current system (e.g. <code>ultrix</code>). Here is an example:
</p>
<div class="smallexample">
<pre class="smallexample">#!/bin/sh
#
# cf.preconf is an emergency/bootstrap file to get things going
# in case cfengine is unable to parse its config file
#
backupdir=/iu/nexus/local/iu/etc
#
# If these files don't exist, you might not be able to parse cfagent.conf
#
if [ ! -s /etc/resolv.conf ]; then
echo Patching basics resolv.conf file
cat > /etc/resolv.conf << XX
domain iu.hioslo.no
nameserver 128.39.89.10
XX
fi
#
# SVR4
#
if [ "$1" = "solaris" ]; then
if [ ! -s "/etc/passwd" ]; then
echo Patching missing passwd file
/bin/cp $backupdir/passwd /etc/passwd
fi
if [ ! -s "/etc/shadow" ]; then
echo Patching missing passwd file
/bin/cp $backupdir/shadow /etc/shadow
fi
fi
#
# BSD 4.3
#
if [ "$1" = "linux" ]; then
if [ ! -s "/etc/passwd" ]
then
echo Patching missing passwd file
/bin/cp $backupdir/passwd.linux /etc/passwd
fi
fi
</pre></div>
<a name="index-_002fetc_002fhost_002econf"></a>
<a name="index-_002fetc_002fhost_002econf-1"></a>
<a name="index-_002dx-option"></a>
<a name="index-_002dx-option-1"></a>
<p>Note - in some circumstances, it might be appropriate to exit cfengine
altogether after this script. If the script outputs a string containing
the text "cfengine-preconf-abort", then cfagent will abort execution
immediately after this.
</p>
<a name="index-Emergency-abort"></a>
<a name="index-Abort-cfengine-after-cf_002epreconf"></a>
<hr>
<a name="cfrc-resource-file"></a>
<div class="header">
<p>
Previous: <a href="#cf_002epreconf-bootstrap-file" accesskey="p" rel="previous">cf.preconf bootstrap file</a>, Up: <a href="#Problem-solving" accesskey="u" rel="up">Problem solving</a> [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Variable-Index" title="Index" rel="index">Index</a>]</p>
</div>
<a name="cfrc-resource-file-1"></a>
<h3 class="section">7.2 cfrc resource file</h3>
<a name="index-cfrc-resource-file"></a>
<a name="index-Resource-file"></a>
<a name="index-cfrc"></a>
<p>If, for some reason you are not satisfied with the defaults which
cfengine uses, then you can change them by making an entry in the
resource file. The default values are defined in the source code file
<code>classes.c</code> in the distribution. The format of the resource file
is:
</p>
<div class="smallexample">
<pre class="smallexample">hardclass.variable: value
</pre></div>
<p>For example, you might want to forget about where your HPUX system
mounts its mail directory and mount it under <code>/usr/spool/mail</code>. In
this case you would add the line:
</p>
<div class="smallexample">
<pre class="smallexample">hpux.maildir: /usr/spool/mail
</pre></div>
<p>To redefine the filesystem table for GNU/linux, you would write:
</p>
<div class="smallexample">
<pre class="smallexample">linux.fstab: /etc/linuxfstab
</pre></div>
<p>The full list of re-definable resources is:
</p>
<div class="smallexample">
<pre class="smallexample"> mountcomm # command used to mount filesystems
unmountcomm # command used to unmount filesystems
ethernet # name of the ethernet device
mountopts # options to above mount command
fstab # the name of the filesystemtable
maildir # the location of the mail directory
netstat # the full path to netstat and options
pscomm # the path to the system's ps command
psopts # the options used by ps (default aux/ef)
</pre></div>
<p>You should never need to redefine resources unless you decide to do something
non-standard. Interested readers are referred to the values in <code>classes.c</code>.
</p>
<a name="index-Adding-new-classes"></a>
<a name="index-Support-for-new-systems"></a>
<a name="index-New-systems_002c-support-for"></a>
<p>Cfengine is easily extensible so as to support a variety of
architectures. You can even add your own. To do so you need, first of
all, to define a new class for the operating system concerned. The file
<em>classes.c</em> has been separated off from the remainder of the source
code so that you can easily see which data structures need to be
extended.
</p>
<p>To make life as straightforward as possible, three unused classes have
been defined. They are called (unremarkably) <em>unused1</em>,
<em>unused2</em> and <em>unused3</em>. If you add any further classes, it
will be necessary to increase the constant <em>clssattr</em> defined in
<em>cf.defs.h</em> by one for every new addition. You do not need to
change <em>clssattr</em> if you simple replace one of the unused classes
by a real class.
</p>
<p>To see fully the impact of what you need to do, you should make a search
for the strings <em>unused?</em> in all of the source files. Certain
special cases need to be handled for each operating system. For
example, the form of the filesystem table is quite radically different
on some systems such as AIX. One thing you must do is to fill in the
default values for the new operating system in the file
<em>classes.c</em>.
</p>
<p>If you fill in the details for a new operating system before it finds
its way into a new release, you might consider sending the details to
the bug list in the next paragraph.
</p>
<hr>
<a name="Example-configuration-file"></a>
<div class="header">
<p>
Next: <a href="#Variable-Index" accesskey="n" rel="next">Variable Index</a>, Previous: <a href="#Problem-solving" accesskey="p" rel="previous">Problem solving</a>, Up: <a href="#Top" accesskey="u" rel="up">Top</a> [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Variable-Index" title="Index" rel="index">Index</a>]</p>
</div>
<a name="Example-configuration-files"></a>
<h2 class="chapter">8 Example configuration files</h2>
<a name="index-Example-configuration-files"></a>
<p>Here is a sample from a large configuration file, just to give you
some ideas. The file is broken up into manageable pieces for
convenience.
</p>
<table class="menu" border="0" cellspacing="0">
<tr><td align="left" valign="top">• <a href="#cfagent_002econf" accesskey="1">cfagent.conf</a>:</td><td> </td><td align="left" valign="top">
</td></tr>
<tr><td align="left" valign="top">• <a href="#cf_002egroups" accesskey="2">cf.groups</a>:</td><td> </td><td align="left" valign="top">
</td></tr>
<tr><td align="left" valign="top">• <a href="#cf_002emain" accesskey="3">cf.main</a>:</td><td> </td><td align="left" valign="top">
</td></tr>
<tr><td align="left" valign="top">• <a href="#cf_002esite" accesskey="4">cf.site</a>:</td><td> </td><td align="left" valign="top">
</td></tr>
<tr><td align="left" valign="top">• <a href="#cf_002emotd" accesskey="5">cf.motd</a>:</td><td> </td><td align="left" valign="top">
</td></tr>
<tr><td align="left" valign="top">• <a href="#cf_002eusers" accesskey="6">cf.users</a>:</td><td> </td><td align="left" valign="top">
</td></tr>
<tr><td align="left" valign="top">• <a href="#cf_002esolaris" accesskey="7">cf.solaris</a>:</td><td> </td><td align="left" valign="top">
</td></tr>
<tr><td align="left" valign="top">• <a href="#cf_002elinux" accesskey="8">cf.linux</a>:</td><td> </td><td align="left" valign="top">
</td></tr>
<tr><td align="left" valign="top">• <a href="#cf_002efreebsd" accesskey="9">cf.freebsd</a>:</td><td> </td><td align="left" valign="top">
</td></tr>
<tr><td align="left" valign="top">• <a href="#cfservd_002econf">cfservd.conf</a>:</td><td> </td><td align="left" valign="top">
</td></tr>
</table>
<hr>
<a name="cfagent_002econf"></a>
<div class="header">
<p>
Next: <a href="#cf_002egroups" accesskey="n" rel="next">cf.groups</a>, Previous: <a href="#Example-configuration-file" accesskey="p" rel="previous">Example configuration file</a>, Up: <a href="#Example-configuration-file" accesskey="u" rel="up">Example configuration file</a> [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Variable-Index" title="Index" rel="index">Index</a>]</p>
</div>
<a name="cfagent_002econf-1"></a>
<h3 class="section">8.1 cfagent.conf</h3>
<a name="index-cfagent_002econf"></a>
<p><!-- /@w -->
</p><div class="smallexample">
<pre class="smallexample">#####################################################################
#
# CFENGINE CONFIGURATION FOR site = iu.hioslo.no
#
# This file is for root only.
#
######################################################################
###
#
# BEGIN cfagent.conf
#
###
import:
#
# Split things up to keep things tidy
#
any::
cf.groups
cf.main
cf.site
cf.motd
hpux:: cf.hpux
linux:: cf.linux
solaris:: cf.solaris
sun4:: cf.sun4
ultrix:: cf.ultrix
freebsd:: cf.freebsd
#
# Do you want to do this ?
#
AllHomeServers:: cf.users
###
#
# END cfengine.conf
#
###
</pre></div>
<hr>
<a name="cf_002egroups"></a>
<div class="header">
<p>
Next: <a href="#cf_002emain" accesskey="n" rel="next">cf.main</a>, Previous: <a href="#cfagent_002econf" accesskey="p" rel="previous">cfagent.conf</a>, Up: <a href="#Example-configuration-file" accesskey="u" rel="up">Example configuration file</a> [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Variable-Index" title="Index" rel="index">Index</a>]</p>
</div>
<a name="cf_002egroups-1"></a>
<h3 class="section">8.2 cf.groups</h3>
<a name="index-cf_002egroups"></a>
<p><!-- /@w -->
</p><div class="smallexample">
<pre class="smallexample">##############################################################
#
# cf.groups - for iu.hioslo.no
#
# This file contains all group/class definitions
#
#################################################################
###
#
# BEGIN cf.groups
#
###
groups:
#
# Define some groups
#
iu = ( nexus ferengi regula borg dax lore axis worf daystrom voyager
aud1 aud2 aud3 aud4 bajor ds9 takpah takpeh nostromo galron
thistledown rama chaos pc-steinarj pc-hildeh way jart kosh )
diskless = ( regula ferengi lore )
standalone = ( nexus axis dax borg worf daystrom voyager
aud1 aud2 aud3 aud4 bajor ds9 takpah takpeh
nostromo galron thistledown rama pc-torejo
pc-steinarj pc-hildeh )
AllHomeServers = ( nexus )
AllBinaryServers = ( nexus borg )
XBootServer = ( nexus )
WWWServers = ( nexus )
FTPserver = ( nexus )
NameServers = ( nexus )
PasswdServer = ( nexus )
BackupHost = ( nexus )
MailHub = ( nexus )
MailClients = ( iu -nexus )
###
#
# END cf.groups
#
###
</pre></div>
<hr>
<a name="cf_002emain"></a>
<div class="header">
<p>
Next: <a href="#cf_002esite" accesskey="n" rel="next">cf.site</a>, Previous: <a href="#cf_002egroups" accesskey="p" rel="previous">cf.groups</a>, Up: <a href="#Example-configuration-file" accesskey="u" rel="up">Example configuration file</a> [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Variable-Index" title="Index" rel="index">Index</a>]</p>
</div>
<a name="cf_002emain-1"></a>
<h3 class="section">8.3 cf.main</h3>
<a name="index-cf_002emain"></a>
<p><!-- /@w -->
</p><div class="smallexample">
<pre class="smallexample">##############################################################
#
# cf.main - for iu.hioslo.no
#
# This file contains generic config stuff
#
#################################################################
###
#
# BEGIN cf.main
#
###
control:
access = ( root ) # Only root should run this
site = ( iu )
domain = ( iu.hioslo.no )
sysadm = ( drift@iu.hioslo.no )
repository = ( /var/spool/cfengine )
netmask = ( 255.255.255.0 )
timezone = ( MET )
nfstype = ( nfs )
sensiblesize = ( 1000 )
sensiblecount = ( 2 )
editfilesize = ( 20000 )
mountpattern = ( /$(site)/$(host) )
homepattern = ( u? )
#
# If we undefine this with cfengine -N longjob
# then we switch off all jobs labelled with this class
#
addclasses = ( longjob )
#
# Macros & constants are inherited downwards in imports
# but are not passed up to parent files. Good idea to
# define them all here
#
masterfiles = ( /iu/nexus/local/iu )
main_server = ( nexus )
cfbin = ( /iu/nexus/local/gnu/lib/cfengine/bin )
gnu = ( /local/gnu )
ftp = ( /local/iu/ftp )
nisslave = ( dax )
nisfiles = ( /iu/nexus/local/iu/etc )
#
# The action sequence for daily (full) runs and
# for hourly updates (called with -DHourly)
#
Hr00::
actionsequence =
(
copy
mountall
mountinfo
checktimezone
netconfig
resolve
unmount
shellcommands
addmounts
links.Prepare
files.Prepare
directories
links.Rest
mailcheck
mountall
required
tidy
disable
editfiles
files.Rest
processes
)
!Hr00::
actionsequence =
(
resolve
shellcommands
copy
editfiles
processes
links
)
force::
actionsequence =
(
files.Prepare.Rest
tidy
)
######################################################################
homeservers:
iu:: nexus
binservers:
iu.solaris:: nexus
iu.linux:: borg
mailserver:
any:: nexus:/var/mail
mountables:
any::
nexus:/iu/nexus/u1
nexus:/iu/nexus/u2
nexus:/iu/nexus/u3
nexus:/iu/nexus/u4
nexus:/iu/nexus/u5
nexus:/iu/nexus/u6
nexus:/iu/nexus/ua
nexus:/iu/nexus/ud
nexus:/iu/nexus/local
nexus:/opt/NeWSprint
nexus:/opt/AcroRead
borg:/iu/borg/local
dax:/iu/dax/local
miscmounts:
linux||freebsd:: nexus:/iu/nexus/local /iu/nexus/local ro
######################################################################
broadcast:
ones
defaultroute:
cadeler30-gw
######################################################################
resolve:
128.39.89.10 # nexus
158.36.85.10 # samson.hioslo.no
129.241.1.99
######################################################################
tidy:
#
# Some global tidy-ups
#
/tmp/ pat=* r=inf A=1
/var/tmp pat=* r=inf A=1
/ pat=core r=1 A=0
/etc pat=core r=1 A=0
######################################################################
ignore: # Don't check or tidy these directories
/local/lib/gnu/emacs/lock/
/local/tmp
ftp
projects
/local/bin/top
/local/lib/tex/fonts
/local/iu/etc
/local/etc
/local/iu/httpd/conf
/usr/tmp/locktelelogic
/usr/tmp/lockIDE
RootMailLog
#
# Emacs lock files etc
#
!*
/local/lib/xemacs
#
# X11 keeps X server data in /tmp/.X11
# better not delete this!
#
.X11
#
# Some users like to give a file or two 777 protection here
# so netsurfers can update a log or counter when running as
# `nobody'
#
www
#####################################################################
disable:
/etc/hosts.equiv
/etc/nologin
/usr/lib/sendmail.fc
###
#
# END cf.main
#
###
</pre></div>
<hr>
<a name="cf_002esite"></a>
<div class="header">
<p>
Next: <a href="#cf_002emotd" accesskey="n" rel="next">cf.motd</a>, Previous: <a href="#cf_002emain" accesskey="p" rel="previous">cf.main</a>, Up: <a href="#Example-configuration-file" accesskey="u" rel="up">Example configuration file</a> [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Variable-Index" title="Index" rel="index">Index</a>]</p>
</div>
<a name="cf_002esite-1"></a>
<h3 class="section">8.4 cf.site</h3>
<a name="index-cf_002esite"></a>
<p><!-- /@w -->
</p><div class="smallexample">
<pre class="smallexample">##############################################################
#
# cf.site - for iu.hioslo.no
#
# This file contains site specific data
#
#################################################################
###
#
# BEGIN cf.site
#
###
links:
Prepare::
/local -> /$(site)/$(binserver)/local
/usr/local -> /local
dax::
/iu/dax/local +> /iu/nexus/local
/projects -> /iu/dax/local/projects
/iu/nexus/u1/sowille/data -> /iu/dax/scratch/data
XBootServer::
#
# Set up a /local/tftpboot area where all X terminal
# stuff will be kept.
#
/tftpboot -> /local/tftpboot
/local/tftpboot/td/configs -> /local/tftpboot/td/examples/configs
/etc/bootptab -> /tftpboot/bootptab
/tftpboot/usr/lib/X11/td -> /tftpboot/td
NameServers::
/etc/named.boot -> /local/iu/named/named.boot
MailHub::
/etc/mail/sendmail.cf ->! /iu/nexus/local/mail/sendmail.cf
MailClients.solaris::
/etc/mail/sendmail.cf ->! /iu/nexus/local/mail/client.cf
nexus::
/local/bin +> /local/latex/bin
#############################################################
disable:
#
# We run Berkeley sendmail and the config files are
# all under /iu/nexus/local/lib/mail
#
/etc/aliases
WWWServers.Sunday::
#
# Disabling these log files weekly prevents them from
# growing so enormous that they fill the disk!
#
/local/iu/httpd/logs/access_log rotate=empty
/local/iu/httpd/logs/agent_log rotate=empty
/local/iu/httpd/logs/error_log rotate=empty
/local/iu/httpd/logs/referer_log rotate=empty
#
# CERT warning, security fix
#
any::
/usr/lib/expreserve
FTPserver.Sunday.Hr00::
/local/iu/xferlog rotate=3
#################################################################
files:
Prepare::
/etc/motd m=0644 r=0 o=root act=touch
/.cshrc m=0644 r=0 o=root act=touch
PasswdServer::
/local/iu/etc/passwd m=0644 o=root g=other action=fixplain
/local/iu/etc/shadow m=0644 o=root g=other action=fixplain
WWWServers.Rest::
/local/iu/www m=775 g=www act=fixall r=inf
/local/iu/httpd/conf m=664 o=root g=www act=fixall r=inf
/local/iu/www/cgi-bin-public/count_file m=777 o=root g=www act=fixplain
FTPserver::
#
# Make sure anonymous ftp areas have the correct
# protection, or logins won't be able to read
# files - or perhaps a security risk. This is
# Solaris 2 specific...
#
$(ftp)/pub mode=755 o=ftp g=ftp r=inf act=fixall
$(ftp)/Obin mode=111 o=root g=other act=fixall
$(ftp)/etc mode=111 o=root g=other act=fixdirs
$(ftp)/usr/bin/ls mode=111 o=root g=other act=fixall
$(ftp)/dev mode=555 o=root g=other act=fixall
$(ftp)/usr mode=555 o=root g=other act=fixdirs
Prepare::
/etc/shells mode=0644 action=touch
AllBinaryServers.Rest.longjob::
/local mode=-0002 r=inf owner=root,bin group=0,1,2,3,4,5,6,7,staff
links=tidy action=fixall
/local/iu/RootMailLog m=0666 action=touch
dax.Rest::
/iu/dax/scratch r=0 o=root mode=1777 action=fixall
/iu/dax/local/projects r=0 o=root mode=755 action=fixdirs
nexus::
/local/mail/sendmail.cf o=root m=444 act=fixplain
/iu/nexus/ua/robot/.rhosts o=robot m=600 act=touch
/local/iu/named/pz o=root m=644 act=fixall r=1
/local/latex/lib/tex/texmf/fonts owner=root
mode=1666
recurse=inf
action=fixall
#################################################################
tidy:
#
# Make sure the file repository doesn't fill up
#
/var/spool/cfengine pattern=* age=3
/var pattern=core age=0 r=inf
/var/spool/mqueue pattern=* age=14 type=mtime
BackupHost::
# Here we tidy old backup tar files from the backup area
# A special tmp area gets cleared every 4 days. The files
# are created by Audun's backup help script (see shellcommands)
/iu/nexus/backup1 pat=* age=7
#################################################################
shellcommands:
PasswdServer::
# Build and install the BSD compatible passwd file
# from the master passwd/shadow file on Solaris
"/local/iu/bin/BuildPasswdFiles"
"/local/iu/bin/BuildGroupFiles"
BackupHost.Sunday.Hr00|BackupHost.Wednesday.Hr00::
#
# Make a system backup of /iu/nexus/u? with Audun's script
#
"$(cfbin)/cfbackup -p -f /iu/nexus/backup1 -s /iu/nexus/ud"
"$(cfbin)/cfbackup -p -f /iu/nexus/backup1 -s /iu/nexus/ua"
"$(cfbin)/cfbackup -p -f /iu/nexus/backup1 -s /iu/nexus/u1"
"$(cfbin)/cfbackup -p -f /iu/nexus/backup1 -s /iu/nexus/u2"
"$(cfbin)/cfbackup -p -f /iu/nexus/backup2 -s /iu/nexus/u3"
"$(cfbin)/cfbackup -p -f /iu/nexus/backup2 -s /iu/nexus/u4"
"$(cfbin)/cfbackup -p -f /iu/nexus/backup2 -s /iu/nexus/u5"
"$(cfbin)/cfbackup -p -f /iu/nexus/backup2 -s /iu/nexus/u6"
nexus.Sunday.longjob.Hr00::
#
# See how much rubbish users have accumulated each Sunday
#
"$(cfbin)/noseyparker /iu/nexus/u1 $(sysadm) "
"$(cfbin)/noseyparker /iu/nexus/u2 $(sysadm) "
"$(cfbin)/noseyparker /iu/nexus/u3 $(sysadm) "
"$(cfbin)/noseyparker /iu/nexus/u4 $(sysadm) "
"$(cfbin)/noseyparker /iu/nexus/u5 $(sysadm) "
"$(cfbin)/noseyparker /iu/nexus/u6 $(sysadm) "
"$(cfbin)/noseyparker /iu/nexus/ua $(sysadm) nomail"
"$(cfbin)/noseyparker /iu/nexus/ud $(sysadm) nomail"
nexus.longjob.Hr00::
#
# Update the GNU find/locate database each night
#
"$(gnu)/lib/locate/updatedb"
"/local/iu/bin/newhomepage.sh"
###############################################################
editfiles:
#
# cfengine installs itself as a cron job - sneaky! :)
#
{ /var/spool/cron/crontabs/root
AppendIfNoSuchLine "0 * * * * $(cfbin)/cfwrap $(cfbin)/cfhourly"
}
FTPserver::
{ /etc/shells
AppendIfNoSuchLine "/bin/tcsh"
AppendIfNoSuchLine "/local/gnu/bin/bash"
}
XBootServer::
{ /etc/inetd.conf
AppendIfNoSuchLine
"bootp dgram udp wait root /local/bin/bootpd bootpd -i -d"
}
nexus::
{ /iu/nexus/ua/robot/.rhosts
AppendIfNoSuchLine "borg"
AppendIfNoSuchLine "borg.iu.hioslo.no"
AppendIfNoSuchLine "aud4"
AppendIfNoSuchLine "aud4.iu.hioslo.no"
}
dax::
{ /etc/system
AppendIfNoSuchLine "set pt_cnt=128"
}
######################################################################
required:
#
# Any host must have a /local, /usr/local fs. Check that
# it exists and looks sensible. (i.e. not empty)
#
/$(site)/$(binserver)/local
######################################################################
copy:
#
# NIS seems broken at IU, so here we use NFS to fudge
# a file distribution as a temporary solution. Actually
# this makes the system work faster without NIS!
#
$(nisfiles)/services dest=/etc/services o=root g=other mode=0644
$(nisfiles)/hosts.deny dest=/etc/hosts.deny o=root mode=0644
!debian::
$(nisfiles)/hosts dest=/etc/hosts o=root g=other mode=0644
PasswdServer::
/etc/passwd dest=$(nisfiles)/passwd o=root g=other mode=0644
/etc/shadow dest=$(nisfiles)/shadow o=root g=other mode=0644
nexus::
/local/iu/etc/dfstab dest=/etc/dfs/dfstab o=root mode=0744
solaris.!PasswdServer::
$(nisfiles)/passwd dest=/etc/passwd o=root g=other mode=0644
$(nisfiles)/shadow dest=/etc/shadow o=root g=other mode=0600
$(nisfiles)/group.solaris dest=/etc/group o=root g=other mode=0644
linux::
$(nisfiles)/passwd.linux dest=/etc/passwd o=root g=other mode=0644
$(nisfiles)/group.linux dest=/etc/group o=root g=other mode=0644
###############################################################
processes:
"eggdrop" signal=kill
"irc" signal=kill
"ping" signal=kill
"NetXRay" signal=kill
"netxray" signal=kill
"ypserv" signal=kill
"ypbind" signal=kill
"rarpd" signal=kill
"rpc.boot" signal=kill
"README" signal=kill # You don't sh README !
!XBootServer::
"bootp" signal=kill
#
# These processes are not killed every hour, but once a day
# when cfengine runs at night. Note that there are often
# hanging pine and elm processes. These programs crash and
# go berserk, using hundreds of hours of CPU time.
#
Hr00::
"cron" signal=hup # HUP these to update their config
"inetd" signal=hup
"/local/sdt/sdt/bin" signal=term # For those elektro dudes who forget
# to log out
"netscape" signal=kill
"pine" signal=kill
"elm" signal=kill
###
#
# END cf.site
#
###
</pre></div>
<hr>
<a name="cf_002emotd"></a>
<div class="header">
<p>
Next: <a href="#cf_002eusers" accesskey="n" rel="next">cf.users</a>, Previous: <a href="#cf_002esite" accesskey="p" rel="previous">cf.site</a>, Up: <a href="#Example-configuration-file" accesskey="u" rel="up">Example configuration file</a> [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Variable-Index" title="Index" rel="index">Index</a>]</p>
</div>
<a name="cf_002emotd-1"></a>
<h3 class="section">8.5 cf.motd</h3>
<a name="index-cf_002emotd"></a>
<p><!-- /@w -->
</p><div class="smallexample">
<pre class="smallexample">
##################################################################
#
# cf.motd
#
# This file is used to set the message of the day file on
# each host
#
##################################################################
#####
#
# BEGIN cf.motd
#
#####
control:
#
# This points to the file containing general text
#
masterfile = ( /iu/nexus/local/iu/etc/motd-master )
local_message = ( /etc/motd.local )
editfiles:
{ /etc/motd
BeginGroupIfFileIsNewer "$(masterfile)"
EmptyEntireFilePlease
InsertFile "$(masterfile)"
InsertFile "$(local_message)"
PrependIfNoSuchLine "This system is running $(class):$(arch)"
EndGroup
}
#####
#
# BEGIN cf.motd
#
#####
</pre></div>
<hr>
<a name="cf_002eusers"></a>
<div class="header">
<p>
Next: <a href="#cf_002esolaris" accesskey="n" rel="next">cf.solaris</a>, Previous: <a href="#cf_002emotd" accesskey="p" rel="previous">cf.motd</a>, Up: <a href="#Example-configuration-file" accesskey="u" rel="up">Example configuration file</a> [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Variable-Index" title="Index" rel="index">Index</a>]</p>
</div>
<a name="cf_002eusers-1"></a>
<h3 class="section">8.6 cf.users</h3>
<p>Whether or not you perform any special services for users, with or
without their consent is entirely a matter of local policy. In a school
or college situation, users are often uncooperative and some are even
irresponsible. This file shows you what you could do in an environment
with inexperienced users, but please don’t feel as though you have to be
this totalitarian.
</p>
<p><!-- /@w -->
</p><div class="smallexample">
<pre class="smallexample">#################################################################
#
# cf.users - for iu.hioslo.no
#
# This file contains user specific actions
#
#################################################################
###
#
# BEGIN cf.users
#
###
ignore:
robot
tidy:
longjob::
#
# Some users just don't understand what they are doing
# and this is safest, allbeit totalitarian
#
home pat=.rhosts age=0
#
# Tidy up users' home dirs
#
home pat=core r=inf age=0
home pat=a.out r=inf age=1
home p=*% r=inf age=2
home p=*~ r=inf age=2
home p=#* r=inf age=1
home p=*.dvi r=inf age=14 type=ctime
home p=*.log r=inf age=2
home p=Log.* r=inf age=3
home p=CKP r=inf age=1
home p=BAK r=inf age=1
home p=log r=inf age=0
home p=*.o r=inf age=0
home p=*.aux r=inf age=3
home p=*.zip r=inf age=7
home/.deleted p=* r=inf age=0
home/.wastebacket p=* r=inf age=14
home/www p=*~ r=inf age=1
#
# Clear the big cache files netscape creates
#
home/.netscape-cache p=cache????* r=inf age=0
home/.MCOM-cache p=cache????* r=inf age=0
home/.netscape/cache p=* r=inf age=0
#################################################################
files:
AllHomeServers.longjob.rest::
#
# Check users files are not writable to the world
# and there are no stale links (pointing nowhere)
#
home mode=o-w recurse=inf action=fixall # links=tidy
home/.xsession mode=755 action=fixall
home/.cshrc mode=755 action=fixall
#################################################################
copy:
Hr00.longjob::
#
# Make sure each user has an up to date standard
# setup. Cshrc just sources in a big standard file
# which is kept in ~user/../.setupfiles/cshrc
# to reduce disk wastage
#
$(masterfiles)/lib/Cshrc dest=home/.cshrc
$(masterfiles)/lib/tkgrc dest=home/.tkgrc
$(masterfiles)/lib/fvwm2rc dest=home/.fvwm2rc
###
#
# END cf.users
#
###
</pre></div>
<hr>
<a name="cf_002esolaris"></a>
<div class="header">
<p>
Next: <a href="#cf_002elinux" accesskey="n" rel="next">cf.linux</a>, Previous: <a href="#cf_002eusers" accesskey="p" rel="previous">cf.users</a>, Up: <a href="#Example-configuration-file" accesskey="u" rel="up">Example configuration file</a> [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Variable-Index" title="Index" rel="index">Index</a>]</p>
</div>
<a name="cf_002esolaris-1"></a>
<h3 class="section">8.7 cf.solaris</h3>
<p><!-- /@w -->
</p><div class="smallexample">
<pre class="smallexample">#################################################################
#
# cf.solaris - for iu.hioslo.no
#
# This file contains Solaris specific patches
#
#################################################################
###
#
# BEGIN cf.solaris
#
###
directories:
#
# httpd/netscape want this to exist for some bizarre reason
#
/usr/lib/X11/nls
################################################################
tidy:
/var/log pattern=syslog.* age=0
MailHub::
/var/mail pattern=lp age=0
#################################################################
files:
#
# If this doesn't exist fork will not work and the
# system will not even be able to run the /etc/rc
# scripts at boottime
#
/etc/system o=root g=root m=644 action=touch
/var/log/syslog o=root m=666 action=touch
#############################################################
copy:
#
# Some standard setup files, can't link because
# machine won't boot if their not on / partition.
#
/local/bin/tcsh dest=/bin/tcsh mode=755
/local/iu/etc/nsswitch.standalone dest=/etc/nsswitch.conf
#
# Our named server uses a newer BIND
# Put this here so that it will be preserved under
# Solaris reinstallation
#
NameServers::
/local/iu/sbin/in.named dest=/usr/sbin/in.named mode=555
/local/iu/sbin/in.named.reload dest=/usr/sbin/in.named.reload mode=555
/local/iu/sbin/in.named.restart dest=/usr/sbin/in.named.restart mode=555
/local/iu/sbin/in.ndc dest=/usr/sbin/in.ndc mode=555
/local/iu/sbin/named-xfer dest=/usr/sbin/named-xfer mode=555
/local/iu/lib/nslookup.help dest=/usr/lib/nslookup.help mode=444
any::
/local/iu/lib/libresolv.a dest=/usr/lib/libresolv.a mode=444
/local/iu/lib/libresolv.so.2 dest=/usr/lib/libresolv.so.2 mode=444
/local/bin/nslookup dest=/usr/sbin/nslookup mode=444
##############################################################
editfiles:
{ /etc/netmasks
AppendIfNoSuchLine "128.39 255.255.255.0"
}
{ /etc/defaultrouter
AppendIfNoSuchLine "128.39.89.1"
}
{ /usr/openwin/lib/app-defaults/XConsole
AppendIfNoSuchLine "XConsole.autoRaise: on"
}
#
# CERT security patch for vold vulnerability
#
{ /etc/rmmount.conf
HashCommentLinesContaining "action cdrom"
HashCommentLinesContaining "action floppy"
}
##############################################################
disable:
/etc/.login type=file
/etc/aliases
#
# These files are ENORMOUS, don't let them fill the disk
#
Wednesday::
/var/lp/logs/lpsched rotate=empty
/var/adm/wtmpx rotate=empty
/var/adm/wtmp rotate=empty
##############################################################
files:
/etc/passwd m=0644 o=root g=other action=fixplain
/etc/shadow m=0600 o=root g=other action=fixplain
/etc/defaultrouter m=0644 o=root g=other action=touch
/var/adm/wtmpx m=0664 o=adm g=adm action=touch
/var/adm/wtmp m=0644 o=root g=adm action=touch
/var/adm/utmp m=0644 o=root g=adm action=fixplain
/var/adm/utmpx m=0664 o=adm g=adm action=fixplain
/tmp m=1777 action=fixdirs
##############################################################
disable:
#
# CERT security patch
#
/usr/openwin/bin/kcms_calibrate
/usr/openwin/bin/kcms_configure
/usr/bin/admintool
################################################################
shellcommands:
AllBinaryServers.Saturday.longjob.Hr00::
#
# Make sure the man -k / apropos data are up to date
#
"/usr/bin/catman -M /local/man"
"/usr/bin/catman -M /local/X11R5/man"
"/usr/bin/catman -M /usr/man"
"/usr/bin/catman -M /local/gnu/man"
"/usr/bin/catman -M /usr/openwin/share/man"
"/usr/bin/catman -M /local/X11R5/man"
"/usr/bin/catman -M /usr/share/man"
################################################################
editfiles:
#
# A painless way to add an rc.local script to the rc files
# under Solaris without having to fight though inittab
#
{ /etc/rc3.d/S15nfs.server
AppendIfNoSuchLine "sh /local/iu/etc/rc.local"
}
#
# umask defined when inetd starts is inherited by all subprocesses
# including ftpd which saves with mode 666 (!) unless we do this
#
{ /etc/rc2.d/S72inetsvc
PrependIfNoSuchLine "umask 022"
}
###
#
# END cf.solaris
#
###
</pre></div>
<hr>
<a name="cf_002elinux"></a>
<div class="header">
<p>
Next: <a href="#cf_002efreebsd" accesskey="n" rel="next">cf.freebsd</a>, Previous: <a href="#cf_002esolaris" accesskey="p" rel="previous">cf.solaris</a>, Up: <a href="#Example-configuration-file" accesskey="u" rel="up">Example configuration file</a> [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Variable-Index" title="Index" rel="index">Index</a>]</p>
</div>
<a name="cf_002elinux-1"></a>
<h3 class="section">8.8 cf.linux</h3>
<p><!-- /@w -->
</p><div class="smallexample">
<pre class="smallexample">#################################################################
#
# cf.linux - for iu.hioslo.no
#
# This file contains debian linux specific patches
#
#################################################################
###
#
# BEGIN cf.linux
#
###
files:
/etc/printcap m=644 o=root action=fixplain
#
# Cert advisories
#
/bin/mount m=755 o=root action=fixall
/bin/umount m=755 o=root action=fixall
#######################################################################
disable:
#
# Cert advisories
#
/sbin/dip-3.3.7n
########################################################################
links:
/local/bin/tcsh -> /bin/tcsh
/local/lib/mail -> /$(site)/$(main_server)/local/lib/mail
########################################################################
editfiles:
#
# Samba default mode needs to be set...
#
{ /etc/smb.conf
ReplaceAll "700" With "644"
}
#
# Linux date is very stupid and needs a very careful
# TZ definition, otherwise it loses
#
{ /etc/csh.cshrc
AppendIfNoSuchLine "setenv TZ 'MET-1MET DST-2,M3.5.0/2,M10.5.0/3'"
}
#
# resolv+ ordering
#
{ /etc/host.conf
PrependIfNoSuchLine "order bind"
}
#
# Should have been configured already (!)
#
{ /etc/ld.so.conf
AppendIfNoSuchLine "/usr/X11R6/lib"
}
#
# Kill annoying messages
#
{ /etc/cron.daily/standard
HashCommentLinesContaining "security"
}
#########################################################################
shellcommands:
Hr00::
#
# Find/locate database
#
"/usr/bin/updatedb"
###
#
# END cf.linux
#
###
</pre></div>
<hr>
<a name="cf_002efreebsd"></a>
<div class="header">
<p>
Next: <a href="#cfservd_002econf" accesskey="n" rel="next">cfservd.conf</a>, Previous: <a href="#cf_002elinux" accesskey="p" rel="previous">cf.linux</a>, Up: <a href="#Example-configuration-file" accesskey="u" rel="up">Example configuration file</a> [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Variable-Index" title="Index" rel="index">Index</a>]</p>
</div>
<a name="cf_002efreebsd-_002f-cf_002enetbsd"></a>
<h3 class="section">8.9 cf.freebsd / cf.netbsd</h3>
<p>FreeBSD, OpenBSD and NetBSD are sufficiently similar to have a single
file for all.
</p>
<div class="smallexample">
<pre class="smallexample">#################################################################
#
# cf.bsd - for iu.hioslo.no
#
# This file contains bsd specific patches
#
#################################################################
###
#
# BEGIN cf.bsd
#
###
links:
/usr/spool -> /var/spool
/local/bin/tcsh -> /bin/tcsh
/local/bin/perl -> /usr/bin/perl
/usr/lib/sendmail -> /usr/sbin/sendmail
#################################################################
files:
/usr/tmp mode=1777 owner=root action=fixall
#################################################################
editfiles:
#
# Comment out all lines to shut up this annoying cfengine-like
# script, which sends mail every day!!!
#
{ /etc/crontab
HashCommentLinesContaining "daily"
HashCommentLinesContaining "weekly"
HashCommentLinesContaining "monthly"
}
#################################################################
copy:
$(masterfiles)/etc/printcap.client dest=/etc/printcap mode=0644
#########################################################################
shellcommands:
Hr00::
"/usr/libexec/locate.updatedb"
"/usr/bin/makewhatis /usr/share/man:/usr/X11R6/man"
###
#
# END cf.bsd
#
###
</pre></div>
<hr>
<a name="cfservd_002econf"></a>
<div class="header">
<p>
Previous: <a href="#cf_002efreebsd" accesskey="p" rel="previous">cf.freebsd</a>, Up: <a href="#Example-configuration-file" accesskey="u" rel="up">Example configuration file</a> [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Variable-Index" title="Index" rel="index">Index</a>]</p>
</div>
<a name="cfservd_002econf-tutorial"></a>
<h3 class="section">8.10 cfservd.conf tutorial</h3>
<a name="index-cf_002esite-1"></a>
<p><!-- /@w -->
</p><div class="smallexample">
<pre class="smallexample">#########################################################
#
# This is a cfservd config file
#
#########################################################
#
# Could import cf.groups here and use a structure like
# in cfengine.conf, cf.main, cf.groups
#
control:
public = ( /usr/local/publicfiles )
almost_public = ( /usr/local/almostpublicfiles )
cfrunCommand = ( /iu/nexus/ud/mark/comp/Tests/cfrun-command )
MaxConnections = ( 10 )
#########################################################
admit: # or grant:
$(public) *
$(almost_public) *.iu.hioslo.no *.gnu.ai.mit.edu
/etc/passwd *.iu.hioslo.no
#
# Who can exec cfengine remotely?
#
$(cfrunCommand) *.iu.hioslo.no
#########################################################
deny:
$(public)/special *.moneyworld.com
</pre></div>
<hr>
<a name="Variable-Index"></a>
<div class="header">
<p>
Next: <a href="#Concept-Index" accesskey="n" rel="next">Concept Index</a>, Previous: <a href="#Example-configuration-file" accesskey="p" rel="previous">Example configuration file</a>, Up: <a href="#Top" accesskey="u" rel="up">Top</a> [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Variable-Index" title="Index" rel="index">Index</a>]</p>
</div>
<a name="Variable-Index-1"></a>
<h2 class="unnumbered">Variable Index</h2>
<table><tr><th valign="top">Jump to: </th><td><a class="summary-letter" href="#Variable-Index_vr_symbol-1"><b>!</b></a>
<a class="summary-letter" href="#Variable-Index_vr_symbol-2"><b>$</b></a>
<a class="summary-letter" href="#Variable-Index_vr_symbol-3"><b>+</b></a>
<a class="summary-letter" href="#Variable-Index_vr_symbol-4"><b>-</b></a>
<a class="summary-letter" href="#Variable-Index_vr_symbol-5"><b>.</b></a>
<a class="summary-letter" href="#Variable-Index_vr_symbol-6"><b>/</b></a>
<br>
<a class="summary-letter" href="#Variable-Index_vr_letter-A"><b>A</b></a>
<a class="summary-letter" href="#Variable-Index_vr_letter-B"><b>B</b></a>
<a class="summary-letter" href="#Variable-Index_vr_letter-C"><b>C</b></a>
<a class="summary-letter" href="#Variable-Index_vr_letter-D"><b>D</b></a>
<a class="summary-letter" href="#Variable-Index_vr_letter-E"><b>E</b></a>
<a class="summary-letter" href="#Variable-Index_vr_letter-F"><b>F</b></a>
<a class="summary-letter" href="#Variable-Index_vr_letter-G"><b>G</b></a>
<a class="summary-letter" href="#Variable-Index_vr_letter-H"><b>H</b></a>
<a class="summary-letter" href="#Variable-Index_vr_letter-I"><b>I</b></a>
<a class="summary-letter" href="#Variable-Index_vr_letter-L"><b>L</b></a>
<a class="summary-letter" href="#Variable-Index_vr_letter-M"><b>M</b></a>
<a class="summary-letter" href="#Variable-Index_vr_letter-N"><b>N</b></a>
<a class="summary-letter" href="#Variable-Index_vr_letter-O"><b>O</b></a>
<a class="summary-letter" href="#Variable-Index_vr_letter-P"><b>P</b></a>
<a class="summary-letter" href="#Variable-Index_vr_letter-R"><b>R</b></a>
<a class="summary-letter" href="#Variable-Index_vr_letter-S"><b>S</b></a>
<a class="summary-letter" href="#Variable-Index_vr_letter-T"><b>T</b></a>
<a class="summary-letter" href="#Variable-Index_vr_letter-U"><b>U</b></a>
<a class="summary-letter" href="#Variable-Index_vr_letter-V"><b>V</b></a>
<a class="summary-letter" href="#Variable-Index_vr_letter-W"><b>W</b></a>
<a class="summary-letter" href="#Variable-Index_vr_letter-Z"><b>Z</b></a>
</td></tr></table>
<table class="index-vr" border="0">
<tr><td></td><th align="left">Index Entry</th><td> </td><th align="left"> Section</th></tr>
<tr><td colspan="4"> <hr></td></tr>
<tr><th><a name="Variable-Index_vr_symbol-1">!</a></th><td></td><td></td></tr>
<tr><td></td><td valign="top"><a href="#index-_0021-1"><code>!</code></a>:</td><td> </td><td valign="top"><a href="#Cfengine-classes">Cfengine classes</a></td></tr>
<tr><td colspan="4"> <hr></td></tr>
<tr><th><a name="Variable-Index_vr_symbol-2">$</a></th><td></td><td></td></tr>
<tr><td></td><td valign="top"><a href="#index-_0024_0028arch_0029"><code>$(arch)</code></a>:</td><td> </td><td valign="top"><a href="#Special-variables">Special variables</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-_0024_0028binserver_0029"><code>$(binserver)</code></a>:</td><td> </td><td valign="top"><a href="#Special-variables">Special variables</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-_0024_0028class_0029"><code>$(class)</code></a>:</td><td> </td><td valign="top"><a href="#Special-variables">Special variables</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-_0024_0028colon_0029"><code>$(colon)</code></a>:</td><td> </td><td valign="top"><a href="#Special-variables">Special variables</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-_0024_0028cr_0029"><code>$(cr)</code></a>:</td><td> </td><td valign="top"><a href="#Special-variables">Special variables</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-_0024_0028date_0029"><code>$(date)</code></a>:</td><td> </td><td valign="top"><a href="#Special-variables">Special variables</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-_0024_0028dblquote_0029"><code>$(dblquote)</code></a>:</td><td> </td><td valign="top"><a href="#Special-variables">Special variables</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-_0024_0028dollar_0029"><code>$(dollar)</code></a>:</td><td> </td><td valign="top"><a href="#Special-variables">Special variables</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-_0024_0028domain_0029"><code>$(domain)</code></a>:</td><td> </td><td valign="top"><a href="#Special-variables">Special variables</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-_0024_0028faculty_0029"><code>$(faculty)</code></a>:</td><td> </td><td valign="top"><a href="#Special-variables">Special variables</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-_0024_0028fqhost_0029"><code>$(fqhost)</code></a>:</td><td> </td><td valign="top"><a href="#Special-variables">Special variables</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-_0024_0028host_0029"><code>$(host)</code></a>:</td><td> </td><td valign="top"><a href="#Special-variables">Special variables</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-_0024_0028ipaddress_0029"><code>$(ipaddress)</code></a>:</td><td> </td><td valign="top"><a href="#Special-variables">Special variables</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-_0024_0028lf_0029"><code>$(lf)</code></a>:</td><td> </td><td valign="top"><a href="#Special-variables">Special variables</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-_0024_0028n_0029"><code>$(n)</code></a>:</td><td> </td><td valign="top"><a href="#Special-variables">Special variables</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-_0024_0028quote_0029"><code>$(quote)</code></a>:</td><td> </td><td valign="top"><a href="#Special-variables">Special variables</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-_0024_0028site_0029"><code>$(site)</code></a>:</td><td> </td><td valign="top"><a href="#Special-variables">Special variables</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-_0024_0028spc_0029"><code>$(spc)</code></a>:</td><td> </td><td valign="top"><a href="#Special-variables">Special variables</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-_0024_0028sysadm_0029"><code>$(sysadm)</code></a>:</td><td> </td><td valign="top"><a href="#Special-variables">Special variables</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-_0024_0028tab_0029"><code>$(tab)</code></a>:</td><td> </td><td valign="top"><a href="#Special-variables">Special variables</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-_0024_0028timezone_0029"><code>$(timezone)</code></a>:</td><td> </td><td valign="top"><a href="#Special-variables">Special variables</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-_0024_0028version_0029"><code>$(version)</code></a>:</td><td> </td><td valign="top"><a href="#Special-variables">Special variables</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-_0024_0028year_0029"><code>$(year)</code></a>:</td><td> </td><td valign="top"><a href="#Special-variables">Special variables</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-_0024_007bEmailMaxLines_007d"><code>${EmailMaxLines}</code></a>:</td><td> </td><td valign="top"><a href="#Special-variables">Special variables</a></td></tr>
<tr><td colspan="4"> <hr></td></tr>
<tr><th><a name="Variable-Index_vr_symbol-3">+</a></th><td></td><td></td></tr>
<tr><td></td><td valign="top"><a href="#index-_002b"><code>+</code></a>:</td><td> </td><td valign="top"><a href="#groups">groups</a></td></tr>
<tr><td colspan="4"> <hr></td></tr>
<tr><th><a name="Variable-Index_vr_symbol-4">-</a></th><td></td><td></td></tr>
<tr><td></td><td valign="top"><a href="#index-_002dD-option-1"><code>-D option</code></a>:</td><td> </td><td valign="top"><a href="#Cfengine-classes">Cfengine classes</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-_002dD-option-2"><code>-D option</code></a>:</td><td> </td><td valign="top"><a href="#addclasses">addclasses</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-_002dl"><code>-l</code></a>:</td><td> </td><td valign="top"><a href="#Syntax">Syntax</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-_002dL"><code>-L</code></a>:</td><td> </td><td valign="top"><a href="#Single-links">Single links</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-_002dl-1"><code>-l</code></a>:</td><td> </td><td valign="top"><a href="#tidy">tidy</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-_002dN-option"><code>-N option</code></a>:</td><td> </td><td valign="top"><a href="#Cfengine-classes">Cfengine classes</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-_002dN-option-1"><code>-N option</code></a>:</td><td> </td><td valign="top"><a href="#addclasses">addclasses</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-_002dx-option-1"><code>-x option</code></a>:</td><td> </td><td valign="top"><a href="#cf_002epreconf-bootstrap-file">cf.preconf bootstrap file</a></td></tr>
<tr><td colspan="4"> <hr></td></tr>
<tr><th><a name="Variable-Index_vr_symbol-5">.</a></th><td></td><td></td></tr>
<tr><td></td><td valign="top"><a href="#index-_002ecfengine_002erm-1"><code>.cfengine.rm</code></a>:</td><td> </td><td valign="top"><a href="#tidy">tidy</a></td></tr>
<tr><td colspan="4"> <hr></td></tr>
<tr><th><a name="Variable-Index_vr_symbol-6">/</a></th><td></td><td></td></tr>
<tr><td></td><td valign="top"><a href="#index-_002fetc_002fhost_002econf-1"><code>/etc/host.conf</code></a>:</td><td> </td><td valign="top"><a href="#cf_002epreconf-bootstrap-file">cf.preconf bootstrap file</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-_002fvar_002fcfengine_002foutput-1"><code>/var/cfengine/output</code></a>:</td><td> </td><td valign="top"><a href="#Cfexecd-reference">Cfexecd reference</a></td></tr>
<tr><td colspan="4"> <hr></td></tr>
<tr><th><a name="Variable-Index_vr_letter-A">A</a></th><td></td><td></td></tr>
<tr><td></td><td valign="top"><a href="#index-a_003d"><code>a=</code></a>:</td><td> </td><td valign="top"><a href="#Syntax">Syntax</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-a_003d-1"><code>a=</code></a>:</td><td> </td><td valign="top"><a href="#tidy">tidy</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-AbortClasses-1"><code>AbortClasses</code></a>:</td><td> </td><td valign="top"><a href="#control">control</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-AccessedBefore_0028_0029"><code>AccessedBefore()</code></a>:</td><td> </td><td valign="top"><a href="#Examples-setting-classes">Examples setting classes</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-action"><code>action</code></a>:</td><td> </td><td valign="top"><a href="#Syntax">Syntax</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-action_003d"><code>action=</code></a>:</td><td> </td><td valign="top"><a href="#packages">packages</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-actionsequence"><code>actionsequence</code></a>:</td><td> </td><td valign="top"><a href="#control">control</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-actionsequence-1"><code>actionsequence</code></a>:</td><td> </td><td valign="top"><a href="#actionsequence">actionsequence</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-AddClasses"><code>AddClasses</code></a>:</td><td> </td><td valign="top"><a href="#addclasses">addclasses</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-AddInstallable"><code>AddInstallable</code></a>:</td><td> </td><td valign="top"><a href="#addinstallable">addinstallable</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-addmounts"><code>addmounts</code></a>:</td><td> </td><td valign="top"><a href="#actionsequence">actionsequence</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-age"><code>age</code></a>:</td><td> </td><td valign="top"><a href="#tidy">tidy</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-alerts"><code>alerts</code></a>:</td><td> </td><td valign="top"><a href="#alerts">alerts</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-AllowUsers"><code>AllowUsers</code></a>:</td><td> </td><td valign="top"><a href="#AllowUsers">AllowUsers</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-Auditing-1"><code>Auditing</code></a>:</td><td> </td><td valign="top"><a href="#Auditing">Auditing</a></td></tr>
<tr><td colspan="4"> <hr></td></tr>
<tr><th><a name="Variable-Index_vr_letter-B">B</a></th><td></td><td></td></tr>
<tr><td></td><td valign="top"><a href="#index-backup_003d"><code>backup=</code></a>:</td><td> </td><td valign="top"><a href="#copy">copy</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-BindToInterface"><code>BindToInterface</code></a>:</td><td> </td><td valign="top"><a href="#BindToInterface-in-cfagent">BindToInterface in cfagent</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-BindToInterface-1"><code>BindToInterface</code></a>:</td><td> </td><td valign="top"><a href="#BindToInterface-in-cfservd">BindToInterface in cfservd</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-binserver"><code>binserver</code></a>:</td><td> </td><td valign="top"><a href="#Single-links">Single links</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-binserver-1"><code>binserver</code></a>:</td><td> </td><td valign="top"><a href="#Link-Children">Link Children</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-binservers"><code>binservers</code></a>:</td><td> </td><td valign="top"><a href="#binservers">binservers</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-broadcast"><code>broadcast</code></a>:</td><td> </td><td valign="top"><a href="#broadcast">broadcast</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-bymatch"><code>bymatch</code></a>:</td><td> </td><td valign="top"><a href="#processes">processes</a></td></tr>
<tr><td colspan="4"> <hr></td></tr>
<tr><th><a name="Variable-Index_vr_letter-C">C</a></th><td></td><td></td></tr>
<tr><td></td><td valign="top"><a href="#index-cf_002epreconf"><code>cf.preconf</code></a>:</td><td> </td><td valign="top"><a href="#cf_002epreconf-bootstrap-file">cf.preconf bootstrap file</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-CFALLCLASSES-2"><code>CFALLCLASSES</code></a>:</td><td> </td><td valign="top"><a href="#Cfagent-Runtime-Options">Cfagent Runtime Options</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-CFALLCLASSES-3"><code>CFALLCLASSES</code></a>:</td><td> </td><td valign="top"><a href="#Special-variables">Special variables</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-cfinputs_005fversion"><code>cfinputs_version</code></a>:</td><td> </td><td valign="top"><a href="#Special-variables">Special variables</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-cfrc"><code>cfrc</code></a>:</td><td> </td><td valign="top"><a href="#cfrc-resource-file">cfrc resource file</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-ChangedBefore_0028_0029"><code>ChangedBefore()</code></a>:</td><td> </td><td valign="top"><a href="#Examples-setting-classes">Examples setting classes</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-ChecksumDatabase-1"><code>ChecksumDatabase</code></a>:</td><td> </td><td valign="top"><a href="#ChecksumDatabase-in-cfagent">ChecksumDatabase in cfagent</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-ChecksumPurge-1"><code>ChecksumPurge</code></a>:</td><td> </td><td valign="top"><a href="#ChecksumPurge">ChecksumPurge</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-ChecksumUpdates-1"><code>ChecksumUpdates</code></a>:</td><td> </td><td valign="top"><a href="#ChecksumUpdates">ChecksumUpdates</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-checktimezone"><code>checktimezone</code></a>:</td><td> </td><td valign="top"><a href="#actionsequence">actionsequence</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-childlinks"><code>childlinks</code></a>:</td><td> </td><td valign="top"><a href="#actionsequence">actionsequence</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-cmp_003d"><code>cmp=</code></a>:</td><td> </td><td valign="top"><a href="#packages">packages</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-CompressCommand-1"><code>CompressCommand</code></a>:</td><td> </td><td valign="top"><a href="#CompressCommand">CompressCommand</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-control"><code>control</code></a>:</td><td> </td><td valign="top"><a href="#control">control</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-create"><code>create</code></a>:</td><td> </td><td valign="top"><a href="#create">create</a></td></tr>
<tr><td colspan="4"> <hr></td></tr>
<tr><th><a name="Variable-Index_vr_letter-D">D</a></th><td></td><td></td></tr>
<tr><td></td><td valign="top"><a href="#index-directories"><code>directories</code></a>:</td><td> </td><td valign="top"><a href="#actionsequence">actionsequence</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-disable"><code>disable</code></a>:</td><td> </td><td valign="top"><a href="#actionsequence">actionsequence</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-disable-1"><code>disable</code></a>:</td><td> </td><td valign="top"><a href="#disable">disable</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-domain-1"><code>domain</code></a>:</td><td> </td><td valign="top"><a href="#control">control</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-domain-2"><code>domain</code></a>:</td><td> </td><td valign="top"><a href="#domain">domain</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-DryRun-1"><code>DryRun</code></a>:</td><td> </td><td valign="top"><a href="#dryrun">dryrun</a></td></tr>
<tr><td colspan="4"> <hr></td></tr>
<tr><th><a name="Variable-Index_vr_letter-E">E</a></th><td></td><td></td></tr>
<tr><td></td><td valign="top"><a href="#index-editbinaryfilesize"><code>editbinaryfilesize</code></a>:</td><td> </td><td valign="top"><a href="#editbinaryfilesize">editbinaryfilesize</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-editfiles"><code>editfiles</code></a>:</td><td> </td><td valign="top"><a href="#actionsequence">actionsequence</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-editfilesize"><code>editfilesize</code></a>:</td><td> </td><td valign="top"><a href="#control">control</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-editfilesize-1"><code>editfilesize</code></a>:</td><td> </td><td valign="top"><a href="#editfilesize">editfilesize</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-EditSplit"><code>EditSplit</code></a>:</td><td> </td><td valign="top"><a href="#EditSplit">EditSplit</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-EmailMaxLines"><code>EmailMaxLines</code></a>:</td><td> </td><td valign="top"><a href="#Cfexecd-reference">Cfexecd reference</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-empty"><code>empty</code></a>:</td><td> </td><td valign="top"><a href="#disable">disable</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-EmptyResolvConf"><code>EmptyResolvConf</code></a>:</td><td> </td><td valign="top"><a href="#emptyresolvconf">emptyresolvconf</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-Exclamation"><code>Exclamation</code></a>:</td><td> </td><td valign="top"><a href="#exclamation">exclamation</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-exclude_003d"><code>exclude=</code></a>:</td><td> </td><td valign="top"><a href="#Syntax">Syntax</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-exec"><code><code>exec</code></code></a>:</td><td> </td><td valign="top"><a href="#Setting-variables-with-functions">Setting variables with functions</a></td></tr>
<tr><td colspan="4"> <hr></td></tr>
<tr><th><a name="Variable-Index_vr_letter-F">F</a></th><td></td><td></td></tr>
<tr><td></td><td valign="top"><a href="#index-FileExtensions"><code>FileExtensions</code></a>:</td><td> </td><td valign="top"><a href="#fileextension">fileextension</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-files"><code>files</code></a>:</td><td> </td><td valign="top"><a href="#actionsequence">actionsequence</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-files-1"><code>files</code></a>:</td><td> </td><td valign="top"><a href="#files">files</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-filter"><code>filter</code></a>:</td><td> </td><td valign="top"><a href="#filters">filters</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-force_003d"><code>force=</code></a>:</td><td> </td><td valign="top"><a href="#copy-example">copy example</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-force_003d-1"><code>force=</code></a>:</td><td> </td><td valign="top"><a href="#disks">disks</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-freespace_003d-1"><code>freespace=</code></a>:</td><td> </td><td valign="top"><a href="#disks">disks</a></td></tr>
<tr><td colspan="4"> <hr></td></tr>
<tr><th><a name="Variable-Index_vr_letter-G">G</a></th><td></td><td></td></tr>
<tr><td></td><td valign="top"><a href="#index-g_003d"><code>g=</code></a>:</td><td> </td><td valign="top"><a href="#Syntax">Syntax</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-group"><code>group</code></a>:</td><td> </td><td valign="top"><a href="#Syntax">Syntax</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-groups-2"><code>groups</code></a>:</td><td> </td><td valign="top"><a href="#groups">groups</a></td></tr>
<tr><td colspan="4"> <hr></td></tr>
<tr><th><a name="Variable-Index_vr_letter-H">H</a></th><td></td><td></td></tr>
<tr><td></td><td valign="top"><a href="#index-home"><code>home</code></a>:</td><td> </td><td valign="top"><a href="#Syntax">Syntax</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-HomePattern"><code>HomePattern</code></a>:</td><td> </td><td valign="top"><a href="#homepattern">homepattern</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-homepattern"><code>homepattern</code></a>:</td><td> </td><td valign="top"><a href="#mountables">mountables</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-homeservers"><code>homeservers</code></a>:</td><td> </td><td valign="top"><a href="#homeservers">homeservers</a></td></tr>
<tr><td colspan="4"> <hr></td></tr>
<tr><th><a name="Variable-Index_vr_letter-I">I</a></th><td></td><td></td></tr>
<tr><td></td><td valign="top"><a href="#index-IgnoreInterfaceRegex"><code>IgnoreInterfaceRegex</code></a>:</td><td> </td><td valign="top"><a href="#IgnoreInterfaceRegex">IgnoreInterfaceRegex</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-import"><code>import</code></a>:</td><td> </td><td valign="top"><a href="#import">import</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-include_003d"><code>include=</code></a>:</td><td> </td><td valign="top"><a href="#Syntax">Syntax</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-interface-configuration"><code>interface configuration</code></a>:</td><td> </td><td valign="top"><a href="#interfaces">interfaces</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-InterfaceName-1"><code>InterfaceName</code></a>:</td><td> </td><td valign="top"><a href="#interfacename">interfacename</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-IsDir_0028_0029"><code>IsDir()</code></a>:</td><td> </td><td valign="top"><a href="#Examples-setting-classes">Examples setting classes</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-IsLink_0028_0029"><code>IsLink()</code></a>:</td><td> </td><td valign="top"><a href="#Examples-setting-classes">Examples setting classes</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-IsNewerThan_0028_0029"><code>IsNewerThan()</code></a>:</td><td> </td><td valign="top"><a href="#Examples-setting-classes">Examples setting classes</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-IsPlain_0028_0029"><code>IsPlain()</code></a>:</td><td> </td><td valign="top"><a href="#Examples-setting-classes">Examples setting classes</a></td></tr>
<tr><td colspan="4"> <hr></td></tr>
<tr><th><a name="Variable-Index_vr_letter-L">L</a></th><td></td><td></td></tr>
<tr><td></td><td valign="top"><a href="#index-l_003d"><code>l=</code></a>:</td><td> </td><td valign="top"><a href="#Syntax">Syntax</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-LastSeen-1"><code>LastSeen</code></a>:</td><td> </td><td valign="top"><a href="#lastseen">lastseen</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-LastSeenExpireAfter"><code>LastSeenExpireAfter</code></a>:</td><td> </td><td valign="top"><a href="#lastseenexpireafter">lastseenexpireafter</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-LD_005fLIBRARY_005fPATH"><code>LD_LIBRARY_PATH</code></a>:</td><td> </td><td valign="top"><a href="#control">control</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-link"><code>link</code></a>:</td><td> </td><td valign="top"><a href="#Syntax">Syntax</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-linkchildren"><code>linkchildren</code></a>:</td><td> </td><td valign="top"><a href="#Files-linkchildren">Files linkchildren</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-linkchildren-1"><code>linkchildren</code></a>:</td><td> </td><td valign="top"><a href="#Link-Children">Link Children</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-links"><code>links</code></a>:</td><td> </td><td valign="top"><a href="#actionsequence">actionsequence</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-links-1"><code>links</code></a>:</td><td> </td><td valign="top"><a href="#links">links</a></td></tr>
<tr><td colspan="4"> <hr></td></tr>
<tr><th><a name="Variable-Index_vr_letter-M">M</a></th><td></td><td></td></tr>
<tr><td></td><td valign="top"><a href="#index-m_003d"><code>m=</code></a>:</td><td> </td><td valign="top"><a href="#Syntax">Syntax</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-mailcheck"><code>mailcheck</code></a>:</td><td> </td><td valign="top"><a href="#actionsequence">actionsequence</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-mailcheck-1"><code>mailcheck</code></a>:</td><td> </td><td valign="top"><a href="#mailserver">mailserver</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-mailserver"><code>mailserver</code></a>:</td><td> </td><td valign="top"><a href="#mailserver">mailserver</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-MaxCfengines"><code>MaxCfengines</code></a>:</td><td> </td><td valign="top"><a href="#Special-variables">Special variables</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-methods"><code>methods</code></a>:</td><td> </td><td valign="top"><a href="#methods">methods</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-miscmounts"><code>miscmounts</code></a>:</td><td> </td><td valign="top"><a href="#miscmounts">miscmounts</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-mode"><code>mode</code></a>:</td><td> </td><td valign="top"><a href="#Syntax">Syntax</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-module"><code>module</code></a>:</td><td> </td><td valign="top"><a href="#actionsequence">actionsequence</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-moduledirectory"><code>moduledirectory</code></a>:</td><td> </td><td valign="top"><a href="#moduledirectory">moduledirectory</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-mountables"><code>mountables</code></a>:</td><td> </td><td valign="top"><a href="#homeservers">homeservers</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-mountables-1"><code>mountables</code></a>:</td><td> </td><td valign="top"><a href="#mountables">mountables</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-mountall"><code>mountall</code></a>:</td><td> </td><td valign="top"><a href="#actionsequence">actionsequence</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-mountinfo"><code>mountinfo</code></a>:</td><td> </td><td valign="top"><a href="#actionsequence">actionsequence</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-mountpattern"><code>mountpattern</code></a>:</td><td> </td><td valign="top"><a href="#mountpattern">mountpattern</a></td></tr>
<tr><td colspan="4"> <hr></td></tr>
<tr><th><a name="Variable-Index_vr_letter-N">N</a></th><td></td><td></td></tr>
<tr><td></td><td valign="top"><a href="#index-netconfig"><code>netconfig</code></a>:</td><td> </td><td valign="top"><a href="#actionsequence">actionsequence</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-netmask-1"><code>netmask</code></a>:</td><td> </td><td valign="top"><a href="#control">control</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-netmask-2"><code>netmask</code></a>:</td><td> </td><td valign="top"><a href="#netmask">netmask</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-nfstype-1"><code>nfstype</code></a>:</td><td> </td><td valign="top"><a href="#control">control</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-nfstype-2"><code>nfstype</code></a>:</td><td> </td><td valign="top"><a href="#nfstype">nfstype</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-noabspath-1"><code>noabspath</code></a>:</td><td> </td><td valign="top"><a href="#shellcommands">shellcommands</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-none"><code>none</code></a>:</td><td> </td><td valign="top"><a href="#methods">methods</a></td></tr>
<tr><td colspan="4"> <hr></td></tr>
<tr><th><a name="Variable-Index_vr_letter-O">O</a></th><td></td><td></td></tr>
<tr><td></td><td valign="top"><a href="#index-o_003d"><code>o=</code></a>:</td><td> </td><td valign="top"><a href="#Syntax">Syntax</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-ones-1"><code>ones</code></a>:</td><td> </td><td valign="top"><a href="#broadcast">broadcast</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-OutputPrefix"><code>OutputPrefix</code></a>:</td><td> </td><td valign="top"><a href="#Special-variables">Special variables</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-owner"><code>owner</code></a>:</td><td> </td><td valign="top"><a href="#Syntax">Syntax</a></td></tr>
<tr><td colspan="4"> <hr></td></tr>
<tr><th><a name="Variable-Index_vr_letter-P">P</a></th><td></td><td></td></tr>
<tr><td></td><td valign="top"><a href="#index-p_003d"><code>p=</code></a>:</td><td> </td><td valign="top"><a href="#tidy">tidy</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-packages-1"><code>packages</code></a>:</td><td> </td><td valign="top"><a href="#actionsequence">actionsequence</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-pattern"><code>pattern</code></a>:</td><td> </td><td valign="top"><a href="#tidy">tidy</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-pkgmgr_003d"><code>pkgmgr=</code></a>:</td><td> </td><td valign="top"><a href="#packages">packages</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-processes"><code>processes</code></a>:</td><td> </td><td valign="top"><a href="#actionsequence">actionsequence</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-purge_003d"><code>purge=</code></a>:</td><td> </td><td valign="top"><a href="#copy">copy</a></td></tr>
<tr><td colspan="4"> <hr></td></tr>
<tr><th><a name="Variable-Index_vr_letter-R">R</a></th><td></td><td></td></tr>
<tr><td></td><td valign="top"><a href="#index-r_003d"><code>r=</code></a>:</td><td> </td><td valign="top"><a href="#Syntax">Syntax</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-r_003d-1"><code>r=</code></a>:</td><td> </td><td valign="top"><a href="#tidy">tidy</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-Randomizing-strategy"><code>Randomizing strategy</code></a>:</td><td> </td><td valign="top"><a href="#strategies">strategies</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-recurse"><code>recurse</code></a>:</td><td> </td><td valign="top"><a href="#Syntax">Syntax</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-recurse-1"><code>recurse</code></a>:</td><td> </td><td valign="top"><a href="#tidy">tidy</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-repchar"><code>repchar</code></a>:</td><td> </td><td valign="top"><a href="#Special-variables">Special variables</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-RepChar"><code>RepChar</code></a>:</td><td> </td><td valign="top"><a href="#repchar">repchar</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-required"><code>required</code></a>:</td><td> </td><td valign="top"><a href="#actionsequence">actionsequence</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-resolve"><code>resolve</code></a>:</td><td> </td><td valign="top"><a href="#actionsequence">actionsequence</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-resolve-1"><code>resolve</code></a>:</td><td> </td><td valign="top"><a href="#resolve">resolve</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-Restricting-access"><code>Restricting access</code></a>:</td><td> </td><td valign="top"><a href="#access">access</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-ReturnsZero_0028_0029"><code>ReturnsZero()</code></a>:</td><td> </td><td valign="top"><a href="#Examples-setting-classes">Examples setting classes</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-rotate_003d"><code>rotate=</code></a>:</td><td> </td><td valign="top"><a href="#disable">disable</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-rxdirs"><code>rxdirs</code></a>:</td><td> </td><td valign="top"><a href="#Syntax">Syntax</a></td></tr>
<tr><td colspan="4"> <hr></td></tr>
<tr><th><a name="Variable-Index_vr_letter-S">S</a></th><td></td><td></td></tr>
<tr><td></td><td valign="top"><a href="#index-scanarrivals_003d-1"><code>scanarrivals=</code></a>:</td><td> </td><td valign="top"><a href="#disks">disks</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-scheduling-1"><code>scheduling</code></a>:</td><td> </td><td valign="top"><a href="#schedule">schedule</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-scli-command-interpreter"><code>scli command interpreter</code></a>:</td><td> </td><td valign="top"><a href="#scli">scli</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-SecureInput"><code>SecureInput</code></a>:</td><td> </td><td valign="top"><a href="#secureinput">secureinput</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-sensiblecount"><code>sensiblecount</code></a>:</td><td> </td><td valign="top"><a href="#control">control</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-SensibleCount"><code>SensibleCount</code></a>:</td><td> </td><td valign="top"><a href="#sensiblecount">sensiblecount</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-sensiblesize"><code>sensiblesize</code></a>:</td><td> </td><td valign="top"><a href="#control">control</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-SensibleSize"><code>SensibleSize</code></a>:</td><td> </td><td valign="top"><a href="#sensiblesize">sensiblesize</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-shellcommands"><code>shellcommands</code></a>:</td><td> </td><td valign="top"><a href="#actionsequence">actionsequence</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-ShowActions"><code>ShowActions</code></a>:</td><td> </td><td valign="top"><a href="#showactions">showactions</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-signal"><code>signal</code></a>:</td><td> </td><td valign="top"><a href="#processes">processes</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-singlelinks"><code>singlelinks</code></a>:</td><td> </td><td valign="top"><a href="#actionsequence">actionsequence</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-site-1"><code>site</code></a>:</td><td> </td><td valign="top"><a href="#control">control</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-site-2"><code>site</code></a>:</td><td> </td><td valign="top"><a href="#site">site</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-SkipVerify"><code>SkipVerify</code></a>:</td><td> </td><td valign="top"><a href="#root_003d">root=</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-smtpserver-1"><code>smtpserver</code></a>:</td><td> </td><td valign="top"><a href="#Cfexecd-reference">Cfexecd reference</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-smtpserver-2"><code>smtpserver</code></a>:</td><td> </td><td valign="top"><a href="#Cfexecd-reference">Cfexecd reference</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-SNMP"><code>SNMP</code></a>:</td><td> </td><td valign="top"><a href="#scli">scli</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-split-2"><code>split</code></a>:</td><td> </td><td valign="top"><a href="#Special-variables">Special variables</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-split-3"><code>split</code></a>:</td><td> </td><td valign="top"><a href="#Iteration-over-lists">Iteration over lists</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-split-4"><code>split</code></a>:</td><td> </td><td valign="top"><a href="#split">split</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-Split"><code>Split</code></a>:</td><td> </td><td valign="top"><a href="#EditSplit">EditSplit</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-SpoolDirectories-1"><code>SpoolDirectories</code></a>:</td><td> </td><td valign="top"><a href="#spooldirectories">spooldirectories</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-SuspiciousNames"><code>SuspiciousNames</code></a>:</td><td> </td><td valign="top"><a href="#suspiciousnames">suspiciousnames</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-sysadm-1"><code>sysadm</code></a>:</td><td> </td><td valign="top"><a href="#control">control</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-sysadm-2"><code>sysadm</code></a>:</td><td> </td><td valign="top"><a href="#sysadm">sysadm</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-sysadm-3"><code>sysadm</code></a>:</td><td> </td><td valign="top"><a href="#Cfexecd-reference">Cfexecd reference</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-sysadm-4"><code>sysadm</code></a>:</td><td> </td><td valign="top"><a href="#Cfexecd-reference">Cfexecd reference</a></td></tr>
<tr><td colspan="4"> <hr></td></tr>
<tr><th><a name="Variable-Index_vr_letter-T">T</a></th><td></td><td></td></tr>
<tr><td></td><td valign="top"><a href="#index-tidy"><code>tidy</code></a>:</td><td> </td><td valign="top"><a href="#actionsequence">actionsequence</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-tidy-1"><code>tidy</code></a>:</td><td> </td><td valign="top"><a href="#tidy">tidy</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-timezone"><code>timezone</code></a>:</td><td> </td><td valign="top"><a href="#control">control</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-touch"><code>touch</code></a>:</td><td> </td><td valign="top"><a href="#touch">touch</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-truncate"><code>truncate</code></a>:</td><td> </td><td valign="top"><a href="#disable">disable</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-type_003d"><code>type=</code></a>:</td><td> </td><td valign="top"><a href="#disable">disable</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-type_003d-1"><code>type=</code></a>:</td><td> </td><td valign="top"><a href="#Hard-links">Hard links</a></td></tr>
<tr><td colspan="4"> <hr></td></tr>
<tr><th><a name="Variable-Index_vr_letter-U">U</a></th><td></td><td></td></tr>
<tr><td></td><td valign="top"><a href="#index-underscoreclasses-1"><code>underscoreclasses</code></a>:</td><td> </td><td valign="top"><a href="#Special-variables">Special variables</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-underscoreclasses-2"><code>underscoreclasses</code></a>:</td><td> </td><td valign="top"><a href="#Special-variables">Special variables</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-unmount"><code>unmount</code></a>:</td><td> </td><td valign="top"><a href="#actionsequence">actionsequence</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-unmount-1"><code>unmount</code></a>:</td><td> </td><td valign="top"><a href="#unmount">unmount</a></td></tr>
<tr><td colspan="4"> <hr></td></tr>
<tr><th><a name="Variable-Index_vr_letter-V">V</a></th><td></td><td></td></tr>
<tr><td></td><td valign="top"><a href="#index-version_003d"><code>version=</code></a>:</td><td> </td><td valign="top"><a href="#packages">packages</a></td></tr>
<tr><td colspan="4"> <hr></td></tr>
<tr><th><a name="Variable-Index_vr_letter-W">W</a></th><td></td><td></td></tr>
<tr><td></td><td valign="top"><a href="#index-Wildcards"><code>Wildcards</code></a>:</td><td> </td><td valign="top"><a href="#tidy">tidy</a></td></tr>
<tr><td colspan="4"> <hr></td></tr>
<tr><th><a name="Variable-Index_vr_letter-Z">Z</a></th><td></td><td></td></tr>
<tr><td></td><td valign="top"><a href="#index-zeroes"><code>zeroes</code></a>:</td><td> </td><td valign="top"><a href="#broadcast">broadcast</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-zeros-1"><code>zeros</code></a>:</td><td> </td><td valign="top"><a href="#broadcast">broadcast</a></td></tr>
<tr><td colspan="4"> <hr></td></tr>
</table>
<table><tr><th valign="top">Jump to: </th><td><a class="summary-letter" href="#Variable-Index_vr_symbol-1"><b>!</b></a>
<a class="summary-letter" href="#Variable-Index_vr_symbol-2"><b>$</b></a>
<a class="summary-letter" href="#Variable-Index_vr_symbol-3"><b>+</b></a>
<a class="summary-letter" href="#Variable-Index_vr_symbol-4"><b>-</b></a>
<a class="summary-letter" href="#Variable-Index_vr_symbol-5"><b>.</b></a>
<a class="summary-letter" href="#Variable-Index_vr_symbol-6"><b>/</b></a>
<br>
<a class="summary-letter" href="#Variable-Index_vr_letter-A"><b>A</b></a>
<a class="summary-letter" href="#Variable-Index_vr_letter-B"><b>B</b></a>
<a class="summary-letter" href="#Variable-Index_vr_letter-C"><b>C</b></a>
<a class="summary-letter" href="#Variable-Index_vr_letter-D"><b>D</b></a>
<a class="summary-letter" href="#Variable-Index_vr_letter-E"><b>E</b></a>
<a class="summary-letter" href="#Variable-Index_vr_letter-F"><b>F</b></a>
<a class="summary-letter" href="#Variable-Index_vr_letter-G"><b>G</b></a>
<a class="summary-letter" href="#Variable-Index_vr_letter-H"><b>H</b></a>
<a class="summary-letter" href="#Variable-Index_vr_letter-I"><b>I</b></a>
<a class="summary-letter" href="#Variable-Index_vr_letter-L"><b>L</b></a>
<a class="summary-letter" href="#Variable-Index_vr_letter-M"><b>M</b></a>
<a class="summary-letter" href="#Variable-Index_vr_letter-N"><b>N</b></a>
<a class="summary-letter" href="#Variable-Index_vr_letter-O"><b>O</b></a>
<a class="summary-letter" href="#Variable-Index_vr_letter-P"><b>P</b></a>
<a class="summary-letter" href="#Variable-Index_vr_letter-R"><b>R</b></a>
<a class="summary-letter" href="#Variable-Index_vr_letter-S"><b>S</b></a>
<a class="summary-letter" href="#Variable-Index_vr_letter-T"><b>T</b></a>
<a class="summary-letter" href="#Variable-Index_vr_letter-U"><b>U</b></a>
<a class="summary-letter" href="#Variable-Index_vr_letter-V"><b>V</b></a>
<a class="summary-letter" href="#Variable-Index_vr_letter-W"><b>W</b></a>
<a class="summary-letter" href="#Variable-Index_vr_letter-Z"><b>Z</b></a>
</td></tr></table>
<hr>
<a name="Concept-Index"></a>
<div class="header">
<p>
Next: <a href="#FAQ-Index" accesskey="n" rel="next">FAQ Index</a>, Previous: <a href="#Variable-Index" accesskey="p" rel="previous">Variable Index</a>, Up: <a href="#Top" accesskey="u" rel="up">Top</a> [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Variable-Index" title="Index" rel="index">Index</a>]</p>
</div>
<a name="Concept-Index-1"></a>
<h2 class="unnumbered">Concept Index</h2>
<table><tr><th valign="top">Jump to: </th><td><a class="summary-letter" href="#Concept-Index_cp_symbol-1"><b>!</b></a>
<a class="summary-letter" href="#Concept-Index_cp_symbol-2"><b>-</b></a>
<a class="summary-letter" href="#Concept-Index_cp_symbol-3"><b>.</b></a>
<a class="summary-letter" href="#Concept-Index_cp_symbol-4"><b>/</b></a>
<a class="summary-letter" href="#Concept-Index_cp_symbol-5"><b><</b></a>
<a class="summary-letter" href="#Concept-Index_cp_symbol-6"><b>></b></a>
<br>
<a class="summary-letter" href="#Concept-Index_cp_letter-A"><b>A</b></a>
<a class="summary-letter" href="#Concept-Index_cp_letter-B"><b>B</b></a>
<a class="summary-letter" href="#Concept-Index_cp_letter-C"><b>C</b></a>
<a class="summary-letter" href="#Concept-Index_cp_letter-D"><b>D</b></a>
<a class="summary-letter" href="#Concept-Index_cp_letter-E"><b>E</b></a>
<a class="summary-letter" href="#Concept-Index_cp_letter-F"><b>F</b></a>
<a class="summary-letter" href="#Concept-Index_cp_letter-G"><b>G</b></a>
<a class="summary-letter" href="#Concept-Index_cp_letter-H"><b>H</b></a>
<a class="summary-letter" href="#Concept-Index_cp_letter-I"><b>I</b></a>
<a class="summary-letter" href="#Concept-Index_cp_letter-K"><b>K</b></a>
<a class="summary-letter" href="#Concept-Index_cp_letter-L"><b>L</b></a>
<a class="summary-letter" href="#Concept-Index_cp_letter-M"><b>M</b></a>
<a class="summary-letter" href="#Concept-Index_cp_letter-N"><b>N</b></a>
<a class="summary-letter" href="#Concept-Index_cp_letter-O"><b>O</b></a>
<a class="summary-letter" href="#Concept-Index_cp_letter-P"><b>P</b></a>
<a class="summary-letter" href="#Concept-Index_cp_letter-Q"><b>Q</b></a>
<a class="summary-letter" href="#Concept-Index_cp_letter-R"><b>R</b></a>
<a class="summary-letter" href="#Concept-Index_cp_letter-S"><b>S</b></a>
<a class="summary-letter" href="#Concept-Index_cp_letter-T"><b>T</b></a>
<a class="summary-letter" href="#Concept-Index_cp_letter-U"><b>U</b></a>
<a class="summary-letter" href="#Concept-Index_cp_letter-V"><b>V</b></a>
<a class="summary-letter" href="#Concept-Index_cp_letter-W"><b>W</b></a>
<a class="summary-letter" href="#Concept-Index_cp_letter-X"><b>X</b></a>
<a class="summary-letter" href="#Concept-Index_cp_letter-Z"><b>Z</b></a>
</td></tr></table>
<table class="index-cp" border="0">
<tr><td></td><th align="left">Index Entry</th><td> </td><th align="left"> Section</th></tr>
<tr><td colspan="4"> <hr></td></tr>
<tr><th><a name="Concept-Index_cp_symbol-1">!</a></th><td></td><td></td></tr>
<tr><td></td><td valign="top"><a href="#index-_0021">!</a>:</td><td> </td><td valign="top"><a href="#Cfengine-classes">Cfengine classes</a></td></tr>
<tr><td colspan="4"> <hr></td></tr>
<tr><th><a name="Concept-Index_cp_symbol-2">-</a></th><td></td><td></td></tr>
<tr><td></td><td valign="top"><a href="#index-_002d_002ddry_002drun-option"><code>--dry-run</code> option</a>:</td><td> </td><td valign="top"><a href="#shellcommands">shellcommands</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-_002dD-option">-D option</a>:</td><td> </td><td valign="top"><a href="#addclasses">addclasses</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-_002dl-option">-l option</a>:</td><td> </td><td valign="top"><a href="#Syntax">Syntax</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-_002dL-option"><code>-L</code> option</a>:</td><td> </td><td valign="top"><a href="#Single-links">Single links</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-_002dl-option-1">-l option</a>:</td><td> </td><td valign="top"><a href="#tidy">tidy</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-_002dT-in-cfrun_002e">‘<samp>-T</samp>’ in cfrun.</a>:</td><td> </td><td valign="top"><a href="#cfrun">cfrun</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-_002dx-option">-x option</a>:</td><td> </td><td valign="top"><a href="#cf_002epreconf-bootstrap-file">cf.preconf bootstrap file</a></td></tr>
<tr><td colspan="4"> <hr></td></tr>
<tr><th><a name="Concept-Index_cp_symbol-3">.</a></th><td></td><td></td></tr>
<tr><td></td><td valign="top"><a href="#index-_002ecfdisabled"><code>.cfdisabled</code></a>:</td><td> </td><td valign="top"><a href="#disable">disable</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-_002ecfengine_002erm">.cfengine.rm</a>:</td><td> </td><td valign="top"><a href="#tidy">tidy</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-_002ecfnew-files"><samp>.cfnew</samp> files</a>:</td><td> </td><td valign="top"><a href="#copy">copy</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-_002ecfsaved-files"><samp>.cfsaved</samp> files</a>:</td><td> </td><td valign="top"><a href="#Multiple-Links">Multiple Links</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-_002eX11-directory">.X11 directory</a>:</td><td> </td><td valign="top"><a href="#ignore">ignore</a></td></tr>
<tr><td colspan="4"> <hr></td></tr>
<tr><th><a name="Concept-Index_cp_symbol-4">/</a></th><td></td><td></td></tr>
<tr><td></td><td valign="top"><a href="#index-_002fetc_002fhost_002econf">/etc/host.conf</a>:</td><td> </td><td valign="top"><a href="#cf_002epreconf-bootstrap-file">cf.preconf bootstrap file</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-_002fetc_002fhosts_002eequiv"><samp>/etc/hosts.equiv</samp></a>:</td><td> </td><td valign="top"><a href="#disable">disable</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-_002fvar_002fcfengine_002foutput">/var/cfengine/output</a>:</td><td> </td><td valign="top"><a href="#Cfexecd-reference">Cfexecd reference</a></td></tr>
<tr><td colspan="4"> <hr></td></tr>
<tr><th><a name="Concept-Index_cp_symbol-5"><</a></th><td></td><td></td></tr>
<tr><td></td><td valign="top"><a href="#index-_003c"><</a>:</td><td> </td><td valign="top"><a href="#UserExists">UserExists</a></td></tr>
<tr><td colspan="4"> <hr></td></tr>
<tr><th><a name="Concept-Index_cp_symbol-6">></a></th><td></td><td></td></tr>
<tr><td></td><td valign="top"><a href="#index-_003e">></a>:</td><td> </td><td valign="top"><a href="#UserExists">UserExists</a></td></tr>
<tr><td colspan="4"> <hr></td></tr>
<tr><th><a name="Concept-Index_cp_letter-A">A</a></th><td></td><td></td></tr>
<tr><td></td><td valign="top"><a href="#index-Abort-cfengine-after-cf_002epreconf">Abort cfengine after cf.preconf</a>:</td><td> </td><td valign="top"><a href="#cf_002epreconf-bootstrap-file">cf.preconf bootstrap file</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-AbortClasses">AbortClasses</a>:</td><td> </td><td valign="top"><a href="#AbortClasses">AbortClasses</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-Aborting-cfagent">Aborting cfagent</a>:</td><td> </td><td valign="top"><a href="#AbortClasses">AbortClasses</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-Absolute-links">Absolute links</a>:</td><td> </td><td valign="top"><a href="#Single-links">Single links</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-Access-control">Access control</a>:</td><td> </td><td valign="top"><a href="#access">access</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-Access-control-and-symlinks">Access control and symlinks</a>:</td><td> </td><td valign="top"><a href="#root_003d">root=</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-Access-control-by-directory">Access control by directory</a>:</td><td> </td><td valign="top"><a href="#root_003d">root=</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-Access-control-lists">Access control lists</a>:</td><td> </td><td valign="top"><a href="#acl">acl</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-ACL-key">ACL key</a>:</td><td> </td><td valign="top"><a href="#ACEs">ACEs</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-ACLs">ACLs</a>:</td><td> </td><td valign="top"><a href="#acl">acl</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-action-sequence">action sequence</a>:</td><td> </td><td valign="top"><a href="#actionsequence">actionsequence</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-Adding-defined-classes">Adding defined classes</a>:</td><td> </td><td valign="top"><a href="#addclasses">addclasses</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-Adding-new-classes">Adding new classes</a>:</td><td> </td><td valign="top"><a href="#cfrc-resource-file">cfrc resource file</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-AFS">AFS</a>:</td><td> </td><td valign="top"><a href="#nfstype">nfstype</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-Alerts">Alerts</a>:</td><td> </td><td valign="top"><a href="#alerts">alerts</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-allclasses-file"><samp>allclasses</samp> file</a>:</td><td> </td><td valign="top"><a href="#Cfagent-Runtime-Options">Cfagent Runtime Options</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-allclasses-variable">allclasses variable</a>:</td><td> </td><td valign="top"><a href="#shellcommands">shellcommands</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-AllowConnectionsFrom-variable"><code>AllowConnectionsFrom</code> variable</a>:</td><td> </td><td valign="top"><a href="#AllowConnectionsFrom">AllowConnectionsFrom</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-AllowUsers-in-cfservd">AllowUsers in cfservd</a>:</td><td> </td><td valign="top"><a href="#AllowUsers">AllowUsers</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-Andrew-filesystem">Andrew filesystem</a>:</td><td> </td><td valign="top"><a href="#nfstype">nfstype</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-AppendIfNoSuchLinesFromFile"><code>AppendIfNoSuchLinesFromFile</code></a>:</td><td> </td><td valign="top"><a href="#AppendIfNoSuchLinesFromFile">AppendIfNoSuchLinesFromFile</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-Array-example">Array example</a>:</td><td> </td><td valign="top"><a href="#Setting-variables-with-functions">Setting variables with functions</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-Array-from-file">Array from file</a>:</td><td> </td><td valign="top"><a href="#Setting-variables-with-functions">Setting variables with functions</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-Associative-arrays_002e">Associative arrays.</a>:</td><td> </td><td valign="top"><a href="#Setting-variables-with-functions">Setting variables with functions</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-Associative-arrays_002e-1">Associative arrays.</a>:</td><td> </td><td valign="top"><a href="#Setting-variables-with-functions">Setting variables with functions</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-Associative-arrays_002e-2">Associative arrays.</a>:</td><td> </td><td valign="top"><a href="#Setting-variables-with-functions">Setting variables with functions</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-atime-tidies">atime tidies</a>:</td><td> </td><td valign="top"><a href="#tidy">tidy</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-Audit-log">Audit log</a>:</td><td> </td><td valign="top"><a href="#Auditing">Auditing</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-Auditing">Auditing</a>:</td><td> </td><td valign="top"><a href="#Special-variables">Special variables</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-AutoCreate"><code>AutoCreate</code></a>:</td><td> </td><td valign="top"><a href="#AutoCreate">AutoCreate</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-AutoExecInterval-variable"><code>AutoExecInterval</code> variable</a>:</td><td> </td><td valign="top"><a href="#AutoExecInterval">AutoExecInterval</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-automounter">automounter</a>:</td><td> </td><td valign="top"><a href="#AutomountDirectResources">AutomountDirectResources</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-awk_002c-editing">awk, editing</a>:</td><td> </td><td valign="top"><a href="#editfiles">editfiles</a></td></tr>
<tr><td colspan="4"> <hr></td></tr>
<tr><th><a name="Concept-Index_cp_letter-B">B</a></th><td></td><td></td></tr>
<tr><td></td><td valign="top"><a href="#index-Backup">Backup</a>:</td><td> </td><td valign="top"><a href="#Backup-in-editfiles">Backup in editfiles</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-Backup-of-files-in-copy">Backup of files in copy</a>:</td><td> </td><td valign="top"><a href="#copy">copy</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-BeginGroupIfDefined"><code>BeginGroupIfDefined</code></a>:</td><td> </td><td valign="top"><a href="#BeginGroupIfDefined">BeginGroupIfDefined</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-BeginGroupIfFileExists"><code>BeginGroupIfFileExists</code></a>:</td><td> </td><td valign="top"><a href="#BeginGroupIfFileExists">BeginGroupIfFileExists</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-BeginGroupIfFileIsNewer"><code>BeginGroupIfFileIsNewer</code></a>:</td><td> </td><td valign="top"><a href="#BeginGroupIfFileIsNewer">BeginGroupIfFileIsNewer</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-BeginGroupIfNotDefined"><code>BeginGroupIfNotDefined</code></a>:</td><td> </td><td valign="top"><a href="#BeginGroupIfNotDefined">BeginGroupIfNotDefined</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-Binary-servers-and-links">Binary servers and links</a>:</td><td> </td><td valign="top"><a href="#Single-links">Single links</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-Binary-servers-and-links-1">Binary servers and links</a>:</td><td> </td><td valign="top"><a href="#Link-Children">Link Children</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-Binary-servers_002c-defining">Binary servers, defining</a>:</td><td> </td><td valign="top"><a href="#binservers">binservers</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-Binary-servers_002c-priority">Binary servers, priority</a>:</td><td> </td><td valign="top"><a href="#binservers">binservers</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-Binary-servers_002c-priority-1">Binary servers, priority</a>:</td><td> </td><td valign="top"><a href="#Single-links">Single links</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-Binding-to-one-interface-only">Binding to one interface only</a>:</td><td> </td><td valign="top"><a href="#BindToInterface-in-cfagent">BindToInterface in cfagent</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-Binding-to-one-interface-only-1">Binding to one interface only</a>:</td><td> </td><td valign="top"><a href="#BindToInterface-in-cfservd">BindToInterface in cfservd</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-Bootstrap-file">Bootstrap file</a>:</td><td> </td><td valign="top"><a href="#cf_002epreconf-bootstrap-file">cf.preconf bootstrap file</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-Broadcast-address">Broadcast address</a>:</td><td> </td><td valign="top"><a href="#broadcast">broadcast</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-Broadcasts-to-the-cfengine-service_002e">Broadcasts to the cfengine service.</a>:</td><td> </td><td valign="top"><a href="#cfrun">cfrun</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-Broken-resolver">Broken resolver</a>:</td><td> </td><td valign="top"><a href="#lastseen">lastseen</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-Built_002din-functions">Built-in functions</a>:</td><td> </td><td valign="top"><a href="#Setting-variables-with-functions">Setting variables with functions</a></td></tr>
<tr><td colspan="4"> <hr></td></tr>
<tr><th><a name="Concept-Index_cp_letter-C">C</a></th><td></td><td></td></tr>
<tr><td></td><td valign="top"><a href="#index-Caching-of-reverse-lookups">Caching of reverse lookups</a>:</td><td> </td><td valign="top"><a href="#root_003d">root=</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-CatchAbort">CatchAbort</a>:</td><td> </td><td valign="top"><a href="#CatchAbort">CatchAbort</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-cf_002egroups"><samp>cf.groups</samp></a>:</td><td> </td><td valign="top"><a href="#cf_002egroups">cf.groups</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-cf_002emain"><samp>cf.main</samp></a>:</td><td> </td><td valign="top"><a href="#cf_002emain">cf.main</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-cf_002emotd"><samp>cf.motd</samp></a>:</td><td> </td><td valign="top"><a href="#cf_002emotd">cf.motd</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-cf_002epreconf-bootstrap-file">cf.preconf bootstrap file</a>:</td><td> </td><td valign="top"><a href="#cf_002epreconf-bootstrap-file">cf.preconf bootstrap file</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-cf_002esite"><samp>cf.site</samp></a>:</td><td> </td><td valign="top"><a href="#cf_002esite">cf.site</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-cf_002esite-1"><samp>cf.site</samp></a>:</td><td> </td><td valign="top"><a href="#cfservd_002econf">cfservd.conf</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-cfagent_002econf"><samp>cfagent.conf</samp></a>:</td><td> </td><td valign="top"><a href="#cfagent_002econf">cfagent.conf</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-CFALLCLASSES">CFALLCLASSES</a>:</td><td> </td><td valign="top"><a href="#Special-variables">Special variables</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-CFALLCLASSES-1">CFALLCLASSES</a>:</td><td> </td><td valign="top"><a href="#shellcommands">shellcommands</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-CFALLCLASSES-in-a-file">CFALLCLASSES in a file</a>:</td><td> </td><td valign="top"><a href="#Cfagent-Runtime-Options">Cfagent Runtime Options</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-cfenvd-and-key-entropy">cfenvd and key entropy</a>:</td><td> </td><td valign="top"><a href="#Cfkey">Cfkey</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-cfexecd">cfexecd</a>:</td><td> </td><td valign="top"><a href="#Cfexecd-reference">Cfexecd reference</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-cfexecd-1">cfexecd</a>:</td><td> </td><td valign="top"><a href="#Cfexecd-reference">Cfexecd reference</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-cfrc-resource-file">cfrc resource file</a>:</td><td> </td><td valign="top"><a href="#cfrc-resource-file">cfrc resource file</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-cfrun_002c-limiting-users-on-server">cfrun, limiting users on server</a>:</td><td> </td><td valign="top"><a href="#AllowUsers">AllowUsers</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-cfrunCommand-variable"><code>cfrunCommand</code> variable</a>:</td><td> </td><td valign="top"><a href="#cfrunCommand">cfrunCommand</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-cfservd_002econf-file"><samp>cfservd.conf</samp> file</a>:</td><td> </td><td valign="top"><a href="#Cfservd_002econf-and-cfrun-reference">Cfservd.conf and cfrun reference</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-cfservd_002econf-iteration">cfservd.conf iteration</a>:</td><td> </td><td valign="top"><a href="#Cfservd_002econf-and-cfrun-reference">Cfservd.conf and cfrun reference</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-Changing-cfengine-port">Changing cfengine port</a>:</td><td> </td><td valign="top"><a href="#Firewalls-and-NATs">Firewalls and NATs</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-Checking-for-installed-packages">Checking for installed packages</a>:</td><td> </td><td valign="top"><a href="#packages">packages</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-Checksum-warning_002c-turning-off-exclamation">Checksum warning, turning off exclamation</a>:</td><td> </td><td valign="top"><a href="#exclamation">exclamation</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-ChecksumDatabase">ChecksumDatabase</a>:</td><td> </td><td valign="top"><a href="#ChecksumDatabase-in-cfagent">ChecksumDatabase in cfagent</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-ChecksumDatabase-variable"><code>ChecksumDatabase</code> variable</a>:</td><td> </td><td valign="top"><a href="#ChecksumDatabase-in-cfservd">ChecksumDatabase in cfservd</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-ChecksumPurge">ChecksumPurge</a>:</td><td> </td><td valign="top"><a href="#ChecksumPurge">ChecksumPurge</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-Checksums">Checksums</a>:</td><td> </td><td valign="top"><a href="#Checksums-and-change-management">Checksums and change management</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-ChecksumUpdates">ChecksumUpdates</a>:</td><td> </td><td valign="top"><a href="#ChecksumUpdates">ChecksumUpdates</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-CIDR">CIDR</a>:</td><td> </td><td valign="top"><a href="#groups">groups</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-Class-data-and-scripts">Class data and scripts</a>:</td><td> </td><td valign="top"><a href="#Special-variables">Special variables</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-Class-decided-by-shell-command">Class decided by shell command</a>:</td><td> </td><td valign="top"><a href="#groups">groups</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-Class-dependencies">Class dependencies</a>:</td><td> </td><td valign="top"><a href="#groups">groups</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-Class-information_002c-passing-to-scripts">Class information, passing to scripts</a>:</td><td> </td><td valign="top"><a href="#shellcommands">shellcommands</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-classes">classes</a>:</td><td> </td><td valign="top"><a href="#Cfengine-classes">Cfengine classes</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-classes-1"><code>classes</code></a>:</td><td> </td><td valign="top"><a href="#classes">classes</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-classes-2"><code>classes</code></a>:</td><td> </td><td valign="top"><a href="#groups">groups</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-Classes_002c-adding-and-defining">Classes, adding and defining</a>:</td><td> </td><td valign="top"><a href="#addclasses">addclasses</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-Classes_002c-built_002din-functions">Classes, built-in functions</a>:</td><td> </td><td valign="top"><a href="#Examples-setting-classes">Examples setting classes</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-Classes_002c-compound">Classes, compound</a>:</td><td> </td><td valign="top"><a href="#Cfengine-classes">Cfengine classes</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-Classes_002c-defining-and-undefining">Classes, defining and undefining</a>:</td><td> </td><td valign="top"><a href="#Cfengine-classes">Cfengine classes</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-Classless-IP-addresses">Classless IP addresses</a>:</td><td> </td><td valign="top"><a href="#groups">groups</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-Comparing-file-objects">Comparing file objects</a>:</td><td> </td><td valign="top"><a href="#Examples-setting-classes">Examples setting classes</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-Compound-classes">Compound classes</a>:</td><td> </td><td valign="top"><a href="#Cfengine-classes">Cfengine classes</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-compress">compress</a>:</td><td> </td><td valign="top"><a href="#tidy">tidy</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-CompressCommand">CompressCommand</a>:</td><td> </td><td valign="top"><a href="#CompressCommand">CompressCommand</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-Compression-during-tidy">Compression during tidy</a>:</td><td> </td><td valign="top"><a href="#tidy">tidy</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-Contacting-specific-hosts-with-cfrun">Contacting specific hosts with cfrun</a>:</td><td> </td><td valign="top"><a href="#cfrun">cfrun</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-control-section">control section</a>:</td><td> </td><td valign="top"><a href="#control">control</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-Controlling-the-size-of-log-files">Controlling the size of log files</a>:</td><td> </td><td valign="top"><a href="#disable">disable</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-copy">copy</a>:</td><td> </td><td valign="top"><a href="#copy">copy</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-Copy_002c-exact-filetree-images">Copy, exact filetree images</a>:</td><td> </td><td valign="top"><a href="#copy">copy</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-Copying-files">Copying files</a>:</td><td> </td><td valign="top"><a href="#copy">copy</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-Creating-files">Creating files</a>:</td><td> </td><td valign="top"><a href="#create">create</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-ctime-tidies">ctime tidies</a>:</td><td> </td><td valign="top"><a href="#tidy">tidy</a></td></tr>
<tr><td colspan="4"> <hr></td></tr>
<tr><th><a name="Concept-Index_cp_letter-D">D</a></th><td></td><td></td></tr>
<tr><td></td><td valign="top"><a href="#index-DCE-key">DCE key</a>:</td><td> </td><td valign="top"><a href="#DFS-ACLs">DFS ACLs</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-Deadlock">Deadlock</a>:</td><td> </td><td valign="top"><a href="#cf_002epreconf-bootstrap-file">cf.preconf bootstrap file</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-Deadlock-zombie-bug-in-restart">Deadlock zombie bug in restart</a>:</td><td> </td><td valign="top"><a href="#processes">processes</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-Debian-Package-Database-Queries">Debian Package Database Queries</a>:</td><td> </td><td valign="top"><a href="#packages">packages</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-Declaring-classes">Declaring classes</a>:</td><td> </td><td valign="top"><a href="#addinstallable">addinstallable</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-Decrementing-line-pointer-in-editfiles">Decrementing line pointer in editfiles</a>:</td><td> </td><td valign="top"><a href="#IncrementPointer">IncrementPointer</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-Defining-a-binary-server">Defining a binary server</a>:</td><td> </td><td valign="top"><a href="#binservers">binservers</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-Defining-a-home-server">Defining a home server</a>:</td><td> </td><td valign="top"><a href="#homeservers">homeservers</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-Defining-a-mail-server">Defining a mail server</a>:</td><td> </td><td valign="top"><a href="#mailserver">mailserver</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-Defining-a-mountable">Defining a mountable</a>:</td><td> </td><td valign="top"><a href="#mountables">mountables</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-Defining-before-use">Defining before use</a>:</td><td> </td><td valign="top"><a href="#addinstallable">addinstallable</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-Defining-classes">Defining classes</a>:</td><td> </td><td valign="top"><a href="#addclasses">addclasses</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-Defining-classes-1">Defining classes</a>:</td><td> </td><td valign="top"><a href="#addclasses">addclasses</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-Defining-classes-2">Defining classes</a>:</td><td> </td><td valign="top"><a href="#classes">classes</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-Defining-groups">Defining groups</a>:</td><td> </td><td valign="top"><a href="#groups">groups</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-DeleteNonOwnerMail">DeleteNonOwnerMail</a>:</td><td> </td><td valign="top"><a href="#deletenonownerfiles">deletenonownerfiles</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-DeleteNonUserFiles">DeleteNonUserFiles</a>:</td><td> </td><td valign="top"><a href="#deletenonownerfiles">deletenonownerfiles</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-DeleteNonUserMail-DeleteNonUserFiles">DeleteNonUserMail DeleteNonUserFiles</a>:</td><td> </td><td valign="top"><a href="#deletenonuserfiles">deletenonuserfiles</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-Deleting-directories">Deleting directories</a>:</td><td> </td><td valign="top"><a href="#tidy">tidy</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-Deleting-files">Deleting files</a>:</td><td> </td><td valign="top"><a href="#tidy">tidy</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-Deleting-stale-links">Deleting stale links</a>:</td><td> </td><td valign="top"><a href="#Syntax">Syntax</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-Deleting-stale-links-1">Deleting stale links</a>:</td><td> </td><td valign="top"><a href="#tidy">tidy</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-DenyBadClocks-variable"><code>DenyBadClocks</code> variable</a>:</td><td> </td><td valign="top"><a href="#DenyBadClocks">DenyBadClocks</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-DenyConnectionsFrom-variable"><code>DenyConnectionsFrom</code> variable</a>:</td><td> </td><td valign="top"><a href="#DenyConnectionsFrom">DenyConnectionsFrom</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-Dependencies">Dependencies</a>:</td><td> </td><td valign="top"><a href="#groups">groups</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-Device-boundaries">Device boundaries</a>:</td><td> </td><td valign="top"><a href="#copy">copy</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-Device-boundaries-and-files">Device boundaries and files</a>:</td><td> </td><td valign="top"><a href="#Recursion">Recursion</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-DFS">DFS</a>:</td><td> </td><td valign="top"><a href="#nfstype">nfstype</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-DHCP">DHCP</a>:</td><td> </td><td valign="top"><a href="#actionsequence">actionsequence</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-DHCP-1">DHCP</a>:</td><td> </td><td valign="top"><a href="#DynamicAddresses">DynamicAddresses</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-DHCP-addresses">DHCP addresses</a>:</td><td> </td><td valign="top"><a href="#DynamicAddresses">DynamicAddresses</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-Directories_002c-deleting">Directories, deleting</a>:</td><td> </td><td valign="top"><a href="#tidy">tidy</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-Directories_002c-hidden">Directories, hidden</a>:</td><td> </td><td valign="top"><a href="#fileextension">fileextension</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-Directories_002c-making">Directories, making</a>:</td><td> </td><td valign="top"><a href="#directories">directories</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-Directory-for-cfengine-modules">Directory for cfengine modules</a>:</td><td> </td><td valign="top"><a href="#moduledirectory">moduledirectory</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-Directory-permissions">Directory permissions</a>:</td><td> </td><td valign="top"><a href="#Directory-permissions">Directory permissions</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-Disabling-file-types">Disabling file types</a>:</td><td> </td><td valign="top"><a href="#disable">disable</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-Disabling-files">Disabling files</a>:</td><td> </td><td valign="top"><a href="#disable">disable</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-disks-actions">disks actions</a>:</td><td> </td><td valign="top"><a href="#disks">disks</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-DNS">DNS</a>:</td><td> </td><td valign="top"><a href="#resolve">resolve</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-domain">domain</a>:</td><td> </td><td valign="top"><a href="#domain">domain</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-Domain-name">Domain name</a>:</td><td> </td><td valign="top"><a href="#netmask">netmask</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-Dots-in-hostnames">Dots in hostnames</a>:</td><td> </td><td valign="top"><a href="#Cfengine-classes">Cfengine classes</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-Double-quotes">Double quotes</a>:</td><td> </td><td valign="top"><a href="#editfiles">editfiles</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-DryRun">DryRun</a>:</td><td> </td><td valign="top"><a href="#dryrun">dryrun</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-Dual-homed-hosts">Dual homed hosts</a>:</td><td> </td><td valign="top"><a href="#interfaces">interfaces</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-Dynamic-addresses">Dynamic addresses</a>:</td><td> </td><td valign="top"><a href="#DynamicAddresses">DynamicAddresses</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-DynamicAddresses-variable"><code>DynamicAddresses</code> variable</a>:</td><td> </td><td valign="top"><a href="#DynamicAddresses">DynamicAddresses</a></td></tr>
<tr><td colspan="4"> <hr></td></tr>
<tr><th><a name="Concept-Index_cp_letter-E">E</a></th><td></td><td></td></tr>
<tr><td></td><td valign="top"><a href="#index-Emergency-abort">Emergency abort</a>:</td><td> </td><td valign="top"><a href="#cf_002epreconf-bootstrap-file">cf.preconf bootstrap file</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-Empty-files">Empty files</a>:</td><td> </td><td valign="top"><a href="#tidy">tidy</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-Emptying-old-nameservers-from-_002fetc_002fresolv_002econf">Emptying old nameservers from <samp>/etc/resolv.conf</samp></a>:</td><td> </td><td valign="top"><a href="#emptyresolvconf">emptyresolvconf</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-Environment-variable-CFALLCLASSES">Environment variable CFALLCLASSES</a>:</td><td> </td><td valign="top"><a href="#Cfagent-Runtime-Options">Cfagent Runtime Options</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-Example-configuration-files">Example configuration files</a>:</td><td> </td><td valign="top"><a href="#Example-configuration-file">Example configuration file</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-Exclamation-marks_002c-turning-off">Exclamation marks, turning off</a>:</td><td> </td><td valign="top"><a href="#exclamation">exclamation</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-Excluding-classes">Excluding classes</a>:</td><td> </td><td valign="top"><a href="#addclasses">addclasses</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-Excluding-files-from-a-file-sweep">Excluding files from a file sweep</a>:</td><td> </td><td valign="top"><a href="#Syntax">Syntax</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-ExpandVariables">ExpandVariables</a>:</td><td> </td><td valign="top"><a href="#ExpandVariables">ExpandVariables</a></td></tr>
<tr><td colspan="4"> <hr></td></tr>
<tr><th><a name="Concept-Index_cp_letter-F">F</a></th><td></td><td></td></tr>
<tr><td></td><td valign="top"><a href="#index-failover">failover</a>:</td><td> </td><td valign="top"><a href="#copy">copy</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-Field-separator-in-editfiles">Field separator in editfiles</a>:</td><td> </td><td valign="top"><a href="#SplitOn">SplitOn</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-File-images-_0028copy_0029">File images (copy)</a>:</td><td> </td><td valign="top"><a href="#copy">copy</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-File-management">File management</a>:</td><td> </td><td valign="top"><a href="#files">files</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-File-sizes_002c-specifying">File sizes, specifying</a>:</td><td> </td><td valign="top"><a href="#tidy">tidy</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-File-tree-images">File tree images</a>:</td><td> </td><td valign="top"><a href="#copy">copy</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-File-types">File types</a>:</td><td> </td><td valign="top"><a href="#Examples-setting-classes">Examples setting classes</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-Files_002c-breaking-up-into-several">Files, breaking up into several</a>:</td><td> </td><td valign="top"><a href="#import">import</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-Files_002c-checking-permissions">Files, checking permissions</a>:</td><td> </td><td valign="top"><a href="#files">files</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-Files_002c-home-wildcard">Files, home wildcard</a>:</td><td> </td><td valign="top"><a href="#home-directive">home directive</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-Files_002c-importing">Files, importing</a>:</td><td> </td><td valign="top"><a href="#import">import</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-Files_002c-ownership">Files, ownership</a>:</td><td> </td><td valign="top"><a href="#Owner-and-group-wildcards">Owner and group wildcards</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-Files_002c-recursion">Files, recursion</a>:</td><td> </td><td valign="top"><a href="#Recursion">Recursion</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-Files_002c-setting-owner">Files, setting owner</a>:</td><td> </td><td valign="top"><a href="#files">files</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-Files_002c-syntax">Files, syntax</a>:</td><td> </td><td valign="top"><a href="#Syntax">Syntax</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-Force-copying">Force copying</a>:</td><td> </td><td valign="top"><a href="#copy-example">copy example</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-FreeBSD-Package-Database-Queries">FreeBSD Package Database Queries</a>:</td><td> </td><td valign="top"><a href="#packages">packages</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-freespace_003d">freespace=</a>:</td><td> </td><td valign="top"><a href="#disks">disks</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-FriendStatus">FriendStatus</a>:</td><td> </td><td valign="top"><a href="#alerts">alerts</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-Full-disk-warnings">Full disk warnings</a>:</td><td> </td><td valign="top"><a href="#disks">disks</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-Fully-qualified-names">Fully qualified names</a>:</td><td> </td><td valign="top"><a href="#Cfengine-classes">Cfengine classes</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-Functions_002c-built_002din">Functions, built-in</a>:</td><td> </td><td valign="top"><a href="#Setting-variables-with-functions">Setting variables with functions</a></td></tr>
<tr><td colspan="4"> <hr></td></tr>
<tr><th><a name="Concept-Index_cp_letter-G">G</a></th><td></td><td></td></tr>
<tr><td></td><td valign="top"><a href="#index-Gaming-stratgies">Gaming stratgies</a>:</td><td> </td><td valign="top"><a href="#strategies">strategies</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-Gentoo-Package-Database-Queries">Gentoo Package Database Queries</a>:</td><td> </td><td valign="top"><a href="#packages">packages</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-Group-dependencies">Group dependencies</a>:</td><td> </td><td valign="top"><a href="#groups">groups</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-Group-field_002c-editing">Group field, editing</a>:</td><td> </td><td valign="top"><a href="#SplitOn">SplitOn</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-groups">groups</a>:</td><td> </td><td valign="top"><a href="#classes">classes</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-groups-1"><code>groups</code></a>:</td><td> </td><td valign="top"><a href="#groups">groups</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-Groups_002c-defining">Groups, defining</a>:</td><td> </td><td valign="top"><a href="#groups">groups</a></td></tr>
<tr><td colspan="4"> <hr></td></tr>
<tr><th><a name="Concept-Index_cp_letter-H">H</a></th><td></td><td></td></tr>
<tr><td></td><td valign="top"><a href="#index-Hanging-processes">Hanging processes</a>:</td><td> </td><td valign="top"><a href="#lastseen">lastseen</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-Hard-class-name-collision">Hard class name collision</a>:</td><td> </td><td valign="top"><a href="#Special-variables">Special variables</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-Hardlinks">Hardlinks</a>:</td><td> </td><td valign="top"><a href="#Hard-links">Hard links</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-Hashes">Hashes</a>:</td><td> </td><td valign="top"><a href="#Checksums-and-change-management">Checksums and change management</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-Hashes-of-files">Hashes of files</a>:</td><td> </td><td valign="top"><a href="#ChecksumDatabase-in-cfagent">ChecksumDatabase in cfagent</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-Hashes-of-files-1">Hashes of files</a>:</td><td> </td><td valign="top"><a href="#Syntax">Syntax</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-home-directive">home directive</a>:</td><td> </td><td valign="top"><a href="#home-directive">home directive</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-Home-directories_002c-creating">Home directories, creating</a>:</td><td> </td><td valign="top"><a href="#directories">directories</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-Home-path">Home path</a>:</td><td> </td><td valign="top"><a href="#homepattern">homepattern</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-Home-servers_002c-defining">Home servers, defining</a>:</td><td> </td><td valign="top"><a href="#homeservers">homeservers</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-home-wildcard">home wildcard</a>:</td><td> </td><td valign="top"><a href="#Syntax">Syntax</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-Homepattern-variable_002e">Homepattern variable.</a>:</td><td> </td><td valign="top"><a href="#mountables">mountables</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-Host-name-gets-truncated">Host name gets truncated</a>:</td><td> </td><td valign="top"><a href="#Cfengine-classes">Cfengine classes</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-Hostname-collision">Hostname collision</a>:</td><td> </td><td valign="top"><a href="#Special-variables">Special variables</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-hostnamekeys">hostnamekeys</a>:</td><td> </td><td valign="top"><a href="#cfrun">cfrun</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-HostnameKeys">HostnameKeys</a>:</td><td> </td><td valign="top"><a href="#Firewalls-and-NATs">Firewalls and NATs</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-Hung-machine">Hung machine</a>:</td><td> </td><td valign="top"><a href="#cf_002epreconf-bootstrap-file">cf.preconf bootstrap file</a></td></tr>
<tr><td colspan="4"> <hr></td></tr>
<tr><th><a name="Concept-Index_cp_letter-I">I</a></th><td></td><td></td></tr>
<tr><td></td><td valign="top"><a href="#index-ignore-command">ignore command</a>:</td><td> </td><td valign="top"><a href="#ignore">ignore</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-Import-files_002c-variables-in">Import files, variables in</a>:</td><td> </td><td valign="top"><a href="#import">import</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-Importing-files">Importing files</a>:</td><td> </td><td valign="top"><a href="#import">import</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-include-in-cfrun">include in cfrun</a>:</td><td> </td><td valign="top"><a href="#cfrun">cfrun</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-Incrementing-line-pointer-in-editfiles">Incrementing line pointer in editfiles</a>:</td><td> </td><td valign="top"><a href="#IncrementPointer">IncrementPointer</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-Interface-classes">Interface classes</a>:</td><td> </td><td valign="top"><a href="#IgnoreInterfaceRegex">IgnoreInterfaceRegex</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-Interface-name_002c-redefining-by-class">Interface name, redefining by class</a>:</td><td> </td><td valign="top"><a href="#interfacename">interfacename</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-InterfaceName">InterfaceName</a>:</td><td> </td><td valign="top"><a href="#interfacename">interfacename</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-Internal-classes_002c-switching-off">Internal classes, switching off</a>:</td><td> </td><td valign="top"><a href="#Cfagent-Runtime-Options">Cfagent Runtime Options</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-Internet-address">Internet address</a>:</td><td> </td><td valign="top"><a href="#netmask">netmask</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-IP-address">IP address</a>:</td><td> </td><td valign="top"><a href="#netmask">netmask</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-IPV6-and-DHCP">IPV6 and DHCP</a>:</td><td> </td><td valign="top"><a href="#DynamicAddresses">DynamicAddresses</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-IsGreatThan">IsGreatThan</a>:</td><td> </td><td valign="top"><a href="#UserExists">UserExists</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-IsLessThan">IsLessThan</a>:</td><td> </td><td valign="top"><a href="#UserExists">UserExists</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-Iterating-over-lists-in-shellcommands">Iterating over lists in shellcommands</a>:</td><td> </td><td valign="top"><a href="#shellcommands">shellcommands</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-Iteration-in-server-rules">Iteration in server rules</a>:</td><td> </td><td valign="top"><a href="#Cfservd_002econf-and-cfrun-reference">Cfservd.conf and cfrun reference</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-Iteration-over-lists">Iteration over lists</a>:</td><td> </td><td valign="top"><a href="#Iteration-over-lists">Iteration over lists</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-Iteration-over-lists-1">Iteration over lists</a>:</td><td> </td><td valign="top"><a href="#split">split</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-Iteration-over-lists-_0028editfiles_0029">Iteration over lists (editfiles)</a>:</td><td> </td><td valign="top"><a href="#EditSplit">EditSplit</a></td></tr>
<tr><td colspan="4"> <hr></td></tr>
<tr><th><a name="Concept-Index_cp_letter-K">K</a></th><td></td><td></td></tr>
<tr><td></td><td valign="top"><a href="#index-Key-entropy-and-cfenvd">Key entropy and cfenvd</a>:</td><td> </td><td valign="top"><a href="#Cfkey">Cfkey</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-Key-security-of-users">Key security of users</a>:</td><td> </td><td valign="top"><a href="#AllowUsers">AllowUsers</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-Key_002c-ACL">Key, ACL</a>:</td><td> </td><td valign="top"><a href="#DFS-ACLs">DFS ACLs</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-Kilobyte_002c-filesize-unit">Kilobyte, filesize unit</a>:</td><td> </td><td valign="top"><a href="#tidy">tidy</a></td></tr>
<tr><td colspan="4"> <hr></td></tr>
<tr><th><a name="Concept-Index_cp_letter-L">L</a></th><td></td><td></td></tr>
<tr><td></td><td valign="top"><a href="#index-Last-Seen-database">Last Seen database</a>:</td><td> </td><td valign="top"><a href="#alerts">alerts</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-Last-Seen-database-1">Last Seen database</a>:</td><td> </td><td valign="top"><a href="#lastseenexpireafter">lastseenexpireafter</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-LastNode-literal"><code>LastNode</code> literal</a>:</td><td> </td><td valign="top"><a href="#directories">directories</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-LastSeen">LastSeen</a>:</td><td> </td><td valign="top"><a href="#lastseen">lastseen</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-Linkchildren">Linkchildren</a>:</td><td> </td><td valign="top"><a href="#Files-linkchildren">Files linkchildren</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-Linkchildren-1">Linkchildren</a>:</td><td> </td><td valign="top"><a href="#Link-Children">Link Children</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-Links-and-binary-servers">Links and binary servers</a>:</td><td> </td><td valign="top"><a href="#Single-links">Single links</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-Links-and-binary-servers-1">Links and binary servers</a>:</td><td> </td><td valign="top"><a href="#Link-Children">Link Children</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-Links-in-access-control">Links in access control</a>:</td><td> </td><td valign="top"><a href="#root_003d">root=</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-Links_002c-absolute">Links, absolute</a>:</td><td> </td><td valign="top"><a href="#Single-links">Single links</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-Links_002c-absolute-1">Links, absolute</a>:</td><td> </td><td valign="top"><a href="#Single-links">Single links</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-Links_002c-deleting-stale">Links, deleting stale</a>:</td><td> </td><td valign="top"><a href="#Syntax">Syntax</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-Links_002c-deleting-stale-1">Links, deleting stale</a>:</td><td> </td><td valign="top"><a href="#tidy">tidy</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-Links_002c-forcing-for-non_002dexistent-files">Links, forcing for non-existent files</a>:</td><td> </td><td valign="top"><a href="#Single-links">Single links</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-Links_002c-making">Links, making</a>:</td><td> </td><td valign="top"><a href="#links">links</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-Links_002c-multiple">Links, multiple</a>:</td><td> </td><td valign="top"><a href="#Multiple-Links">Multiple Links</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-Links_002c-removing-dead">Links, removing dead</a>:</td><td> </td><td valign="top"><a href="#Single-links">Single links</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-Links_002c-single">Links, single</a>:</td><td> </td><td valign="top"><a href="#Single-links">Single links</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-Links_002c-traversing-in-searches">Links, traversing in searches</a>:</td><td> </td><td valign="top"><a href="#Syntax">Syntax</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-Links_002c-traversing-in-searches-1">Links, traversing in searches</a>:</td><td> </td><td valign="top"><a href="#tidy">tidy</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-Local-disk-space_002c-make-use-of">Local disk space, make use of</a>:</td><td> </td><td valign="top"><a href="#Link-Children">Link Children</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-Log-files_002c-controlling-the-size-of">Log files, controlling the size of</a>:</td><td> </td><td valign="top"><a href="#disable">disable</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-Logical-NOT">Logical NOT</a>:</td><td> </td><td valign="top"><a href="#Cfengine-classes">Cfengine classes</a></td></tr>
<tr><td colspan="4"> <hr></td></tr>
<tr><th><a name="Concept-Index_cp_letter-M">M</a></th><td></td><td></td></tr>
<tr><td></td><td valign="top"><a href="#index-m4-functionality">m4 functionality</a>:</td><td> </td><td valign="top"><a href="#ExpandVariables">ExpandVariables</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-Mail-from-cfexecd">Mail from cfexecd</a>:</td><td> </td><td valign="top"><a href="#Cfexecd-reference">Cfexecd reference</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-Mail-server_002c-defining">Mail server, defining</a>:</td><td> </td><td valign="top"><a href="#mailserver">mailserver</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-Mailhost">Mailhost</a>:</td><td> </td><td valign="top"><a href="#Smtpserver">Smtpserver</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-Mailing-output">Mailing output</a>:</td><td> </td><td valign="top"><a href="#Cfexecd-reference">Cfexecd reference</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-Mailing-output-1">Mailing output</a>:</td><td> </td><td valign="top"><a href="#Cfexecd-reference">Cfexecd reference</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-Making-directories">Making directories</a>:</td><td> </td><td valign="top"><a href="#directories">directories</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-Making-links">Making links</a>:</td><td> </td><td valign="top"><a href="#links">links</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-Making-paths">Making paths</a>:</td><td> </td><td valign="top"><a href="#directories">directories</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-Making-use-of-local-disk-space">Making use of local disk space</a>:</td><td> </td><td valign="top"><a href="#Link-Children">Link Children</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-MaxConnections-variable"><code>MaxConnections</code> variable</a>:</td><td> </td><td valign="top"><a href="#MaxConnections">MaxConnections</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-Megabytes_002c-filesize-unit">Megabytes, filesize unit</a>:</td><td> </td><td valign="top"><a href="#tidy">tidy</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-Merging-files_002e">Merging files.</a>:</td><td> </td><td valign="top"><a href="#AppendIfNoLineMatching">AppendIfNoLineMatching</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-Message-digests">Message digests</a>:</td><td> </td><td valign="top"><a href="#ChecksumDatabase-in-cfagent">ChecksumDatabase in cfagent</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-Message-digests-1">Message digests</a>:</td><td> </td><td valign="top"><a href="#Syntax">Syntax</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-Methods">Methods</a>:</td><td> </td><td valign="top"><a href="#methods">methods</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-Methods_002c-remote-caution">Methods, remote caution</a>:</td><td> </td><td valign="top"><a href="#methods">methods</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-Miscellaneous-mount-operations">Miscellaneous mount operations</a>:</td><td> </td><td valign="top"><a href="#miscmounts">miscmounts</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-Module-directory">Module directory</a>:</td><td> </td><td valign="top"><a href="#PrepModule">PrepModule</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-Module-directory-1">Module directory</a>:</td><td> </td><td valign="top"><a href="#moduledirectory">moduledirectory</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-Modules-executed-immediately">Modules executed immediately</a>:</td><td> </td><td valign="top"><a href="#PrepModule">PrepModule</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-Modules_002c-user-defined">Modules, user defined</a>:</td><td> </td><td valign="top"><a href="#actionsequence">actionsequence</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-Monitoring-other-hosts">Monitoring other hosts</a>:</td><td> </td><td valign="top"><a href="#alerts">alerts</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-Mount-paths">Mount paths</a>:</td><td> </td><td valign="top"><a href="#mountpattern">mountpattern</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-Mountable-resources_002c-defining">Mountable resources, defining</a>:</td><td> </td><td valign="top"><a href="#homeservers">homeservers</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-Mountable-resources_002c-defining-1">Mountable resources, defining</a>:</td><td> </td><td valign="top"><a href="#mountables">mountables</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-Mounted-filesystems">Mounted filesystems</a>:</td><td> </td><td valign="top"><a href="#copy">copy</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-Mounting-filesystems_002e">Mounting filesystems.</a>:</td><td> </td><td valign="top"><a href="#miscmounts">miscmounts</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-mtime-tidies">mtime tidies</a>:</td><td> </td><td valign="top"><a href="#tidy">tidy</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-Multihomed-hosts">Multihomed hosts</a>:</td><td> </td><td valign="top"><a href="#BindToInterface-in-cfagent">BindToInterface in cfagent</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-Multihomed-hosts-1">Multihomed hosts</a>:</td><td> </td><td valign="top"><a href="#BindToInterface-in-cfservd">BindToInterface in cfservd</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-Multiple-links">Multiple links</a>:</td><td> </td><td valign="top"><a href="#Multiple-Links">Multiple Links</a></td></tr>
<tr><td colspan="4"> <hr></td></tr>
<tr><th><a name="Concept-Index_cp_letter-N">N</a></th><td></td><td></td></tr>
<tr><td></td><td valign="top"><a href="#index-Name-collision">Name collision</a>:</td><td> </td><td valign="top"><a href="#Special-variables">Special variables</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-NAT">NAT</a>:</td><td> </td><td valign="top"><a href="#Firewalls-and-NATs">Firewalls and NATs</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-Negating-classes">Negating classes</a>:</td><td> </td><td valign="top"><a href="#actionsequence">actionsequence</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-Negating-entries-from-netgroups">Negating entries from netgroups</a>:</td><td> </td><td valign="top"><a href="#groups">groups</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-Netgroups">Netgroups</a>:</td><td> </td><td valign="top"><a href="#groups">groups</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-Netgroups_002c-negating-entries">Netgroups, negating entries</a>:</td><td> </td><td valign="top"><a href="#groups">groups</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-netmask">netmask</a>:</td><td> </td><td valign="top"><a href="#netmask">netmask</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-Netmask">Netmask</a>:</td><td> </td><td valign="top"><a href="#netmask">netmask</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-Network-Address-Translation">Network Address Translation</a>:</td><td> </td><td valign="top"><a href="#SkipIdentify">SkipIdentify</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-Network-address-translator">Network address translator</a>:</td><td> </td><td valign="top"><a href="#Firewalls-and-NATs">Firewalls and NATs</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-Network-Address-Translators">Network Address Translators</a>:</td><td> </td><td valign="top"><a href="#SkipVerify">SkipVerify</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-Network-interfaces_002c-several">Network interfaces, several</a>:</td><td> </td><td valign="top"><a href="#interfaces">interfaces</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-New-systems_002c-support-for">New systems, support for</a>:</td><td> </td><td valign="top"><a href="#cfrc-resource-file">cfrc resource file</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-nfs">nfs</a>:</td><td> </td><td valign="top"><a href="#nfstype">nfstype</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-NFS-filesystems-and-disk-checking">NFS filesystems and disk checking</a>:</td><td> </td><td valign="top"><a href="#disks">disks</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-NFS-mount-model-and-automounter">NFS mount model and automounter</a>:</td><td> </td><td valign="top"><a href="#AutomountDirectResources">AutomountDirectResources</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-nfstype">nfstype</a>:</td><td> </td><td valign="top"><a href="#nfstype">nfstype</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-NIS_002c-netgroup-support">NIS, netgroup support</a>:</td><td> </td><td valign="top"><a href="#groups">groups</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-noabspath">noabspath</a>:</td><td> </td><td valign="top"><a href="#shellcommands">shellcommands</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-none-in-server">none in server</a>:</td><td> </td><td valign="top"><a href="#methods">methods</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-NOT-operator">NOT operator</a>:</td><td> </td><td valign="top"><a href="#Cfengine-classes">Cfengine classes</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-no_005fdefault_005froute-class">no_default_route class</a>:</td><td> </td><td valign="top"><a href="#defaultroute">defaultroute</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-NT_002c-ACL">NT, ACL</a>:</td><td> </td><td valign="top"><a href="#NT-ACLs">NT ACLs</a></td></tr>
<tr><td colspan="4"> <hr></td></tr>
<tr><th><a name="Concept-Index_cp_letter-O">O</a></th><td></td><td></td></tr>
<tr><td></td><td valign="top"><a href="#index-ones">ones</a>:</td><td> </td><td valign="top"><a href="#broadcast">broadcast</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-Operator-ordering">Operator ordering</a>:</td><td> </td><td valign="top"><a href="#Cfengine-classes">Cfengine classes</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-Output-logs">Output logs</a>:</td><td> </td><td valign="top"><a href="#Cfexecd-reference">Cfexecd reference</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-Ownership-of-files">Ownership of files</a>:</td><td> </td><td valign="top"><a href="#Owner-and-group-wildcards">Owner and group wildcards</a></td></tr>
<tr><td colspan="4"> <hr></td></tr>
<tr><th><a name="Concept-Index_cp_letter-P">P</a></th><td></td><td></td></tr>
<tr><td></td><td valign="top"><a href="#index-packages">packages</a>:</td><td> </td><td valign="top"><a href="#packages">packages</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-Password-file_002c-editing">Password file, editing</a>:</td><td> </td><td valign="top"><a href="#SplitOn">SplitOn</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-Path-to-home-directories">Path to home directories</a>:</td><td> </td><td valign="top"><a href="#homepattern">homepattern</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-Path-to-mounted-filesystems">Path to mounted filesystems</a>:</td><td> </td><td valign="top"><a href="#mountpattern">mountpattern</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-Paths_002c-making">Paths, making</a>:</td><td> </td><td valign="top"><a href="#directories">directories</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-Pattern-matching-in-file-sweeps">Pattern matching in file sweeps</a>:</td><td> </td><td valign="top"><a href="#Syntax">Syntax</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-pattern_003d-and-filtering">pattern= and filtering</a>:</td><td> </td><td valign="top"><a href="#tidy">tidy</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-Peer-to-peer-methods">Peer to peer methods</a>:</td><td> </td><td valign="top"><a href="#Setting-variables-with-functions">Setting variables with functions</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-Peer-to-peer-methods-1">Peer to peer methods</a>:</td><td> </td><td valign="top"><a href="#Setting-variables-with-functions">Setting variables with functions</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-Peer-watching-_0028FriendStatus_0029">Peer watching (FriendStatus)</a>:</td><td> </td><td valign="top"><a href="#alerts">alerts</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-Percentage-disk-space">Percentage disk space</a>:</td><td> </td><td valign="top"><a href="#disks">disks</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-Permissions_002c-directories">Permissions, directories</a>:</td><td> </td><td valign="top"><a href="#Directory-permissions">Directory permissions</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-Port_002c-connecting-to-different">Port, connecting to different</a>:</td><td> </td><td valign="top"><a href="#Firewalls-and-NATs">Firewalls and NATs</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-PrepModule">PrepModule</a>:</td><td> </td><td valign="top"><a href="#PrepModule">PrepModule</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-Preserving-file-times-in-copy">Preserving file times in copy</a>:</td><td> </td><td valign="top"><a href="#copy">copy</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-Previewing-shellcommands">Previewing shellcommands</a>:</td><td> </td><td valign="top"><a href="#shellcommands">shellcommands</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-PrintFile">PrintFile</a>:</td><td> </td><td valign="top"><a href="#alerts">alerts</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-Private-modules">Private modules</a>:</td><td> </td><td valign="top"><a href="#methods">methods</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-PRNG-not-seeded">PRNG not seeded</a>:</td><td> </td><td valign="top"><a href="#Cfkey">Cfkey</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-Processes_002c-0-to-3">Processes, 0 to 3</a>:</td><td> </td><td valign="top"><a href="#processes">processes</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-Processes_002c-checking-existence-of">Processes, checking existence of</a>:</td><td> </td><td valign="top"><a href="#processes">processes</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-Processes_002c-counting">Processes, counting</a>:</td><td> </td><td valign="top"><a href="#processes">processes</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-Processes_002c-signalling">Processes, signalling</a>:</td><td> </td><td valign="top"><a href="#processes">processes</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-Public-keys">Public keys</a>:</td><td> </td><td valign="top"><a href="#copy">copy</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-Purge_002c-excluding-files">Purge, excluding files</a>:</td><td> </td><td valign="top"><a href="#copy">copy</a></td></tr>
<tr><td colspan="4"> <hr></td></tr>
<tr><th><a name="Concept-Index_cp_letter-Q">Q</a></th><td></td><td></td></tr>
<tr><td></td><td valign="top"><a href="#index-Quoted-strings">Quoted strings</a>:</td><td> </td><td valign="top"><a href="#editfiles">editfiles</a></td></tr>
<tr><td colspan="4"> <hr></td></tr>
<tr><th><a name="Concept-Index_cp_letter-R">R</a></th><td></td><td></td></tr>
<tr><td></td><td valign="top"><a href="#index-Random-numbers">Random numbers</a>:</td><td> </td><td valign="top"><a href="#Setting-variables-with-functions">Setting variables with functions</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-RandomInt_0028_0029-function">RandomInt() function</a>:</td><td> </td><td valign="top"><a href="#control">control</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-Read-array-from-file">Read array from file</a>:</td><td> </td><td valign="top"><a href="#Setting-variables-with-functions">Setting variables with functions</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-Read-array-from-table">Read array from table</a>:</td><td> </td><td valign="top"><a href="#Setting-variables-with-functions">Setting variables with functions</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-ReadArray">ReadArray</a>:</td><td> </td><td valign="top"><a href="#Setting-variables-with-functions">Setting variables with functions</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-ReadFile">ReadFile</a>:</td><td> </td><td valign="top"><a href="#Setting-variables-with-functions">Setting variables with functions</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-ReadFile_0028_0029-function">ReadFile() function</a>:</td><td> </td><td valign="top"><a href="#control">control</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-ReadTable">ReadTable</a>:</td><td> </td><td valign="top"><a href="#Setting-variables-with-functions">Setting variables with functions</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-Recursion-in-files">Recursion in files</a>:</td><td> </td><td valign="top"><a href="#Recursion">Recursion</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-Redefinition-of-macros">Redefinition of macros</a>:</td><td> </td><td valign="top"><a href="#AllowRedefinitionOf">AllowRedefinitionOf</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-Relative-links">Relative links</a>:</td><td> </td><td valign="top"><a href="#Single-links">Single links</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-Removing-directories">Removing directories</a>:</td><td> </td><td valign="top"><a href="#tidy">tidy</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-Removing-entries-from-netgroups">Removing entries from netgroups</a>:</td><td> </td><td valign="top"><a href="#groups">groups</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-Renaming-files">Renaming files</a>:</td><td> </td><td valign="top"><a href="#disable">disable</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-Replacing-file-by-link">Replacing file by link</a>:</td><td> </td><td valign="top"><a href="#disable">disable</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-Repository-filenames_002c-changing">Repository filenames, changing</a>:</td><td> </td><td valign="top"><a href="#repchar">repchar</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-resolv_002econf">resolv.conf</a>:</td><td> </td><td valign="top"><a href="#resolve">resolve</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-Resolver-configuration">Resolver configuration</a>:</td><td> </td><td valign="top"><a href="#resolve">resolve</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-Resource-file">Resource file</a>:</td><td> </td><td valign="top"><a href="#cfrc-resource-file">cfrc resource file</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-Restart-zombie-deadlock-bug">Restart zombie deadlock bug</a>:</td><td> </td><td valign="top"><a href="#processes">processes</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-Restricting-the-size-of-binary-files-to-be-edited">Restricting the size of binary files to be edited</a>:</td><td> </td><td valign="top"><a href="#editbinaryfilesize">editbinaryfilesize</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-Restricting-the-size-of-files-to-be-edited">Restricting the size of files to be edited</a>:</td><td> </td><td valign="top"><a href="#editfilesize">editfilesize</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-Reverse-lookup-and-SkipVerify">Reverse lookup and SkipVerify</a>:</td><td> </td><td valign="top"><a href="#root_003d">root=</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-rmdirs">rmdirs</a>:</td><td> </td><td valign="top"><a href="#tidy">tidy</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-Rotating-log-files">Rotating log files</a>:</td><td> </td><td valign="top"><a href="#disable">disable</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-RPM-Database-Queries">RPM Database Queries</a>:</td><td> </td><td valign="top"><a href="#packages">packages</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-Running-cfengine-from-a-single-master-host">Running cfengine from a single master host</a>:</td><td> </td><td valign="top"><a href="#cfrun">cfrun</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-Running-cfengine-from-a-single-master-host-1">Running cfengine from a single master host</a>:</td><td> </td><td valign="top"><a href="#cfrun">cfrun</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-Running-cfrun">Running <code>cfrun</code></a>:</td><td> </td><td valign="top"><a href="#cfrun">cfrun</a></td></tr>
<tr><td colspan="4"> <hr></td></tr>
<tr><th><a name="Concept-Index_cp_letter-S">S</a></th><td></td><td></td></tr>
<tr><td></td><td valign="top"><a href="#index-scanarrivals_003d">scanarrivals=</a>:</td><td> </td><td valign="top"><a href="#disks">disks</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-scheduling">scheduling</a>:</td><td> </td><td valign="top"><a href="#schedule">schedule</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-Scripts-and-class-information">Scripts and class information</a>:</td><td> </td><td valign="top"><a href="#shellcommands">shellcommands</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-Scripts_002c-passing-classes-to">Scripts, passing classes to</a>:</td><td> </td><td valign="top"><a href="#Special-variables">Special variables</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-Search-patterns-in-files">Search patterns in <code>files</code></a>:</td><td> </td><td valign="top"><a href="#Syntax">Syntax</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-Searching-for-home-directories">Searching for home directories</a>:</td><td> </td><td valign="top"><a href="#homepattern">homepattern</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-Searching_002c-advanced">Searching, advanced</a>:</td><td> </td><td valign="top"><a href="#filters">filters</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-Secure-input">Secure input</a>:</td><td> </td><td valign="top"><a href="#secureinput">secureinput</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-Security-risk">Security risk</a>:</td><td> </td><td valign="top"><a href="#SkipVerify">SkipVerify</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-Security_002c-link-races-and-travlinks">Security, link races and travlinks</a>:</td><td> </td><td valign="top"><a href="#tidy">tidy</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-sed_002c-editing">sed, editing</a>:</td><td> </td><td valign="top"><a href="#editfiles">editfiles</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-Selecting-files-in-searches">Selecting files in searches</a>:</td><td> </td><td valign="top"><a href="#filters">filters</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-SelectPartitionGroup">SelectPartitionGroup</a>:</td><td> </td><td valign="top"><a href="#Setting-variables-with-functions">Setting variables with functions</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-SelectPartitionLeader">SelectPartitionLeader</a>:</td><td> </td><td valign="top"><a href="#Setting-variables-with-functions">Setting variables with functions</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-Sensible-file-sizes">Sensible file sizes</a>:</td><td> </td><td valign="top"><a href="#sensiblesize">sensiblesize</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-Sensible-limits-on-files-in-a-directory">Sensible limits on files in a directory</a>:</td><td> </td><td valign="top"><a href="#sensiblecount">sensiblecount</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-SetState_0028_0029">SetState()</a>:</td><td> </td><td valign="top"><a href="#alerts">alerts</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-Setting-classes-based-on-non_002dlocal-disks">Setting classes based on non-local disks</a>:</td><td> </td><td valign="top"><a href="#disks">disks</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-Setting-uid-on-restarted-processes">Setting uid on restarted processes</a>:</td><td> </td><td valign="top"><a href="#processes">processes</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-Several-files">Several files</a>:</td><td> </td><td valign="top"><a href="#import">import</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-Shell-command-to-decide-class">Shell command to decide class</a>:</td><td> </td><td valign="top"><a href="#groups">groups</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-ShowState_0028_0029">ShowState()</a>:</td><td> </td><td valign="top"><a href="#alerts">alerts</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-Single-links">Single links</a>:</td><td> </td><td valign="top"><a href="#Single-links">Single links</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-Single-quotes">Single quotes</a>:</td><td> </td><td valign="top"><a href="#editfiles">editfiles</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-site">site</a>:</td><td> </td><td valign="top"><a href="#site">site</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-size-field-in-disable">size field in disable</a>:</td><td> </td><td valign="top"><a href="#disable">disable</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-SkipIdentify">SkipIdentify</a>:</td><td> </td><td valign="top"><a href="#SkipIdentify">SkipIdentify</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-SkipVerify-and-public_002dprivate-keys">SkipVerify and public-private keys</a>:</td><td> </td><td valign="top"><a href="#root_003d">root=</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-smtpserver">smtpserver</a>:</td><td> </td><td valign="top"><a href="#Smtpserver">Smtpserver</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-Spam-suppression">Spam suppression</a>:</td><td> </td><td valign="top"><a href="#Cfexecd-reference">Cfexecd reference</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-Specifying-file-sizes">Specifying file sizes</a>:</td><td> </td><td valign="top"><a href="#tidy">tidy</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-SplayTime-in-cfrun">SplayTime in cfrun</a>:</td><td> </td><td valign="top"><a href="#cfrun">cfrun</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-split">split</a>:</td><td> </td><td valign="top"><a href="#Iteration-over-lists">Iteration over lists</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-split-1">split</a>:</td><td> </td><td valign="top"><a href="#split">split</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-Split-in-editfiles">Split in editfiles</a>:</td><td> </td><td valign="top"><a href="#EditSplit">EditSplit</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-SplitOn">SplitOn</a>:</td><td> </td><td valign="top"><a href="#SplitOn">SplitOn</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-SpoolDirectories">SpoolDirectories</a>:</td><td> </td><td valign="top"><a href="#spooldirectories">spooldirectories</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-Strategy_002c-random">Strategy, random</a>:</td><td> </td><td valign="top"><a href="#strategies">strategies</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-Subnet-mask">Subnet mask</a>:</td><td> </td><td valign="top"><a href="#netmask">netmask</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-Sun-Package-Database-Queries">Sun Package Database Queries</a>:</td><td> </td><td valign="top"><a href="#packages">packages</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-Support-for-new-systems">Support for new systems</a>:</td><td> </td><td valign="top"><a href="#cfrc-resource-file">cfrc resource file</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-suspiciousnames">suspiciousnames</a>:</td><td> </td><td valign="top"><a href="#suspiciousnames">suspiciousnames</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-Switching-off-backup-in-copy">Switching off backup in copy</a>:</td><td> </td><td valign="top"><a href="#copy">copy</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-Switching-off-built_002din-classes">Switching off built-in classes</a>:</td><td> </td><td valign="top"><a href="#Cfagent-Runtime-Options">Cfagent Runtime Options</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-Symbolic-links-in-admit">Symbolic links in admit</a>:</td><td> </td><td valign="top"><a href="#root_003d">root=</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-Symbolic-links_002c-absolute">Symbolic links, absolute</a>:</td><td> </td><td valign="top"><a href="#Single-links">Single links</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-Symbolic-links_002c-relative">Symbolic links, relative</a>:</td><td> </td><td valign="top"><a href="#Single-links">Single links</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-sysadm">sysadm</a>:</td><td> </td><td valign="top"><a href="#sysadm">sysadm</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-SysLog_0028_0029">SysLog()</a>:</td><td> </td><td valign="top"><a href="#alerts">alerts</a></td></tr>
<tr><td colspan="4"> <hr></td></tr>
<tr><th><a name="Concept-Index_cp_letter-T">T</a></th><td></td><td></td></tr>
<tr><td></td><td valign="top"><a href="#index-Templates">Templates</a>:</td><td> </td><td valign="top"><a href="#ExpandVariables">ExpandVariables</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-Testing-files">Testing files</a>:</td><td> </td><td valign="top"><a href="#Examples-setting-classes">Examples setting classes</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-Tidy-by-ctime_002c-mtime_002c-atime">Tidy by ctime, mtime, atime</a>:</td><td> </td><td valign="top"><a href="#tidy">tidy</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-Tidy-log-files-for-users">Tidy log files for users</a>:</td><td> </td><td valign="top"><a href="#LogTidyHomeFiles">LogTidyHomeFiles</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-Tidying-empty-files">Tidying empty files</a>:</td><td> </td><td valign="top"><a href="#tidy">tidy</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-Tidying-files">Tidying files</a>:</td><td> </td><td valign="top"><a href="#tidy">tidy</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-timeout_003d-in-shellcommands"><code>timeout=</code> in shellcommands</a>:</td><td> </td><td valign="top"><a href="#shellcommands">shellcommands</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-Timeouts-during-iterations">Timeouts during iterations</a>:</td><td> </td><td valign="top"><a href="#shellcommands">shellcommands</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-Too-many-open-files-error">Too many open files error</a>:</td><td> </td><td valign="top"><a href="#Too-many-open-files">Too many open files</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-Touching-files">Touching files</a>:</td><td> </td><td valign="top"><a href="#touch">touch</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-travlinks">travlinks</a>:</td><td> </td><td valign="top"><a href="#tidy">tidy</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-Tree-copying_002c-exact">Tree copying, exact</a>:</td><td> </td><td valign="top"><a href="#copy">copy</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-Tripwire-functionality">Tripwire functionality</a>:</td><td> </td><td valign="top"><a href="#ChecksumDatabase-in-cfagent">ChecksumDatabase in cfagent</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-Tripwire-functionality-1">Tripwire functionality</a>:</td><td> </td><td valign="top"><a href="#Syntax">Syntax</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-Truncating-log-files">Truncating log files</a>:</td><td> </td><td valign="top"><a href="#disable">disable</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-Trust_002c-key-exchange-with-cfrun">Trust, key exchange with cfrun</a>:</td><td> </td><td valign="top"><a href="#cfrun">cfrun</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-Trusted-hosts">Trusted hosts</a>:</td><td> </td><td valign="top"><a href="#copy">copy</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-TrustKeysFrom-variable"><code>TrustKeysFrom</code> variable</a>:</td><td> </td><td valign="top"><a href="#TrustKeysFrom">TrustKeysFrom</a></td></tr>
<tr><td colspan="4"> <hr></td></tr>
<tr><th><a name="Concept-Index_cp_letter-U">U</a></th><td></td><td></td></tr>
<tr><td></td><td valign="top"><a href="#index-umask">umask</a>:</td><td> </td><td valign="top"><a href="#Umask">Umask</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-umask-1">umask</a>:</td><td> </td><td valign="top"><a href="#processes">processes</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-umask-2">umask</a>:</td><td> </td><td valign="top"><a href="#shellcommands">shellcommands</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-underscoreclasses">underscoreclasses</a>:</td><td> </td><td valign="top"><a href="#Special-variables">Special variables</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-Unmounting-filesystems">Unmounting filesystems</a>:</td><td> </td><td valign="top"><a href="#unmount">unmount</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-UnsetState_0028_0029">UnsetState()</a>:</td><td> </td><td valign="top"><a href="#alerts">alerts</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-update_002econf"><samp>update.conf</samp></a>:</td><td> </td><td valign="top"><a href="#Work-directory">Work directory</a></td></tr>
<tr><td colspan="4"> <hr></td></tr>
<tr><th><a name="Concept-Index_cp_letter-V">V</a></th><td></td><td></td></tr>
<tr><td></td><td valign="top"><a href="#index-Variables-in-import-files">Variables in import files</a>:</td><td> </td><td valign="top"><a href="#import">import</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-Variables_002c-setting-to-result-of-a-shell-command">Variables, setting to result of a shell command</a>:</td><td> </td><td valign="top"><a href="#Setting-variables-with-functions">Setting variables with functions</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-Version-control">Version control</a>:</td><td> </td><td valign="top"><a href="#Special-variables">Special variables</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-Virtual-interfaces">Virtual interfaces</a>:</td><td> </td><td valign="top"><a href="#IgnoreInterfaceRegex">IgnoreInterfaceRegex</a></td></tr>
<tr><td colspan="4"> <hr></td></tr>
<tr><th><a name="Concept-Index_cp_letter-W">W</a></th><td></td><td></td></tr>
<tr><td></td><td valign="top"><a href="#index-Warning-about-full-disks">Warning about full disks</a>:</td><td> </td><td valign="top"><a href="#disks">disks</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-Warning-remote-methods">Warning remote methods</a>:</td><td> </td><td valign="top"><a href="#methods">methods</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-Wildcard-home">Wildcard home</a>:</td><td> </td><td valign="top"><a href="#Syntax">Syntax</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-Wildcards-in-homepattern">Wildcards in homepattern</a>:</td><td> </td><td valign="top"><a href="#homepattern">homepattern</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-WWW-server-logs">WWW server logs</a>:</td><td> </td><td valign="top"><a href="#disable">disable</a></td></tr>
<tr><td colspan="4"> <hr></td></tr>
<tr><th><a name="Concept-Index_cp_letter-X">X</a></th><td></td><td></td></tr>
<tr><td></td><td valign="top"><a href="#index-xdev">xdev</a>:</td><td> </td><td valign="top"><a href="#copy">copy</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-xdev-1">xdev</a>:</td><td> </td><td valign="top"><a href="#Syntax">Syntax</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-xdev-2">xdev</a>:</td><td> </td><td valign="top"><a href="#tidy">tidy</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-xdev-_0028File-system-boundaries_0029">xdev (File system boundaries)</a>:</td><td> </td><td valign="top"><a href="#Recursion">Recursion</a></td></tr>
<tr><td colspan="4"> <hr></td></tr>
<tr><th><a name="Concept-Index_cp_letter-Z">Z</a></th><td></td><td></td></tr>
<tr><td></td><td valign="top"><a href="#index-zeros">zeros</a>:</td><td> </td><td valign="top"><a href="#broadcast">broadcast</a></td></tr>
<tr><td colspan="4"> <hr></td></tr>
</table>
<table><tr><th valign="top">Jump to: </th><td><a class="summary-letter" href="#Concept-Index_cp_symbol-1"><b>!</b></a>
<a class="summary-letter" href="#Concept-Index_cp_symbol-2"><b>-</b></a>
<a class="summary-letter" href="#Concept-Index_cp_symbol-3"><b>.</b></a>
<a class="summary-letter" href="#Concept-Index_cp_symbol-4"><b>/</b></a>
<a class="summary-letter" href="#Concept-Index_cp_symbol-5"><b><</b></a>
<a class="summary-letter" href="#Concept-Index_cp_symbol-6"><b>></b></a>
<br>
<a class="summary-letter" href="#Concept-Index_cp_letter-A"><b>A</b></a>
<a class="summary-letter" href="#Concept-Index_cp_letter-B"><b>B</b></a>
<a class="summary-letter" href="#Concept-Index_cp_letter-C"><b>C</b></a>
<a class="summary-letter" href="#Concept-Index_cp_letter-D"><b>D</b></a>
<a class="summary-letter" href="#Concept-Index_cp_letter-E"><b>E</b></a>
<a class="summary-letter" href="#Concept-Index_cp_letter-F"><b>F</b></a>
<a class="summary-letter" href="#Concept-Index_cp_letter-G"><b>G</b></a>
<a class="summary-letter" href="#Concept-Index_cp_letter-H"><b>H</b></a>
<a class="summary-letter" href="#Concept-Index_cp_letter-I"><b>I</b></a>
<a class="summary-letter" href="#Concept-Index_cp_letter-K"><b>K</b></a>
<a class="summary-letter" href="#Concept-Index_cp_letter-L"><b>L</b></a>
<a class="summary-letter" href="#Concept-Index_cp_letter-M"><b>M</b></a>
<a class="summary-letter" href="#Concept-Index_cp_letter-N"><b>N</b></a>
<a class="summary-letter" href="#Concept-Index_cp_letter-O"><b>O</b></a>
<a class="summary-letter" href="#Concept-Index_cp_letter-P"><b>P</b></a>
<a class="summary-letter" href="#Concept-Index_cp_letter-Q"><b>Q</b></a>
<a class="summary-letter" href="#Concept-Index_cp_letter-R"><b>R</b></a>
<a class="summary-letter" href="#Concept-Index_cp_letter-S"><b>S</b></a>
<a class="summary-letter" href="#Concept-Index_cp_letter-T"><b>T</b></a>
<a class="summary-letter" href="#Concept-Index_cp_letter-U"><b>U</b></a>
<a class="summary-letter" href="#Concept-Index_cp_letter-V"><b>V</b></a>
<a class="summary-letter" href="#Concept-Index_cp_letter-W"><b>W</b></a>
<a class="summary-letter" href="#Concept-Index_cp_letter-X"><b>X</b></a>
<a class="summary-letter" href="#Concept-Index_cp_letter-Z"><b>Z</b></a>
</td></tr></table>
<hr>
<a name="FAQ-Index"></a>
<div class="header">
<p>
Previous: <a href="#Concept-Index" accesskey="p" rel="previous">Concept Index</a>, Up: <a href="#Top" accesskey="u" rel="up">Top</a> [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Variable-Index" title="Index" rel="index">Index</a>]</p>
</div>
<a name="FAQ-Index-1"></a>
<h2 class="unnumbered">FAQ Index</h2>
<table><tr><th valign="top">Jump to: </th><td><a class="summary-letter" href="#FAQ-Index_mb_letter-A"><b>A</b></a>
<a class="summary-letter" href="#FAQ-Index_mb_letter-B"><b>B</b></a>
<a class="summary-letter" href="#FAQ-Index_mb_letter-C"><b>C</b></a>
<a class="summary-letter" href="#FAQ-Index_mb_letter-D"><b>D</b></a>
<a class="summary-letter" href="#FAQ-Index_mb_letter-H"><b>H</b></a>
<a class="summary-letter" href="#FAQ-Index_mb_letter-I"><b>I</b></a>
<a class="summary-letter" href="#FAQ-Index_mb_letter-L"><b>L</b></a>
<a class="summary-letter" href="#FAQ-Index_mb_letter-M"><b>M</b></a>
<a class="summary-letter" href="#FAQ-Index_mb_letter-P"><b>P</b></a>
<a class="summary-letter" href="#FAQ-Index_mb_letter-R"><b>R</b></a>
<a class="summary-letter" href="#FAQ-Index_mb_letter-S"><b>S</b></a>
<a class="summary-letter" href="#FAQ-Index_mb_letter-T"><b>T</b></a>
</td></tr></table>
<table class="index-mb" border="0">
<tr><td></td><th align="left">Index Entry</th><td> </td><th align="left"> Section</th></tr>
<tr><td colspan="4"> <hr></td></tr>
<tr><th><a name="FAQ-Index_mb_letter-A">A</a></th><td></td><td></td></tr>
<tr><td></td><td valign="top"><a href="#index-Absolute-path-and-shellcommands">Absolute path and shellcommands</a>:</td><td> </td><td valign="top"><a href="#shellcommands">shellcommands</a></td></tr>
<tr><td colspan="4"> <hr></td></tr>
<tr><th><a name="FAQ-Index_mb_letter-B">B</a></th><td></td><td></td></tr>
<tr><td></td><td valign="top"><a href="#index-Brackets-_0028parentheses_0029-in-classes_002e">Brackets (parentheses) in classes.</a>:</td><td> </td><td valign="top"><a href="#Cfengine-classes">Cfengine classes</a></td></tr>
<tr><td colspan="4"> <hr></td></tr>
<tr><th><a name="FAQ-Index_mb_letter-C">C</a></th><td></td><td></td></tr>
<tr><td></td><td valign="top"><a href="#index-Can_0027t-stat-error-when-remote-copying">Can’t stat error when remote copying</a>:</td><td> </td><td valign="top"><a href="#DenyBadClocks">DenyBadClocks</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-Changing-repository-name-conventions">Changing repository name conventions</a>:</td><td> </td><td valign="top"><a href="#repchar">repchar</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-Checksums-take-too-long-to-compute_002e">Checksums take too long to compute.</a>:</td><td> </td><td valign="top"><a href="#ChecksumDatabase-in-cfservd">ChecksumDatabase in cfservd</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-copy-doesn_0027t-always-copy-files">copy doesn’t always copy files</a>:</td><td> </td><td valign="top"><a href="#copy">copy</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-ctime-copy-doesn_0027t-always-copy-files">ctime copy doesn’t always copy files</a>:</td><td> </td><td valign="top"><a href="#copy">copy</a></td></tr>
<tr><td colspan="4"> <hr></td></tr>
<tr><th><a name="FAQ-Index_mb_letter-D">D</a></th><td></td><td></td></tr>
<tr><td></td><td valign="top"><a href="#index-Denial-of-service-attacks">Denial of service attacks</a>:</td><td> </td><td valign="top"><a href="#AllowConnectionsFrom">AllowConnectionsFrom</a></td></tr>
<tr><td colspan="4"> <hr></td></tr>
<tr><th><a name="FAQ-Index_mb_letter-H">H</a></th><td></td><td></td></tr>
<tr><td></td><td valign="top"><a href="#index-Hanging-commands_002c-timeouts">Hanging commands, timeouts</a>:</td><td> </td><td valign="top"><a href="#shellcommands">shellcommands</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-Hanging-connections-attacks">Hanging connections attacks</a>:</td><td> </td><td valign="top"><a href="#AllowConnectionsFrom">AllowConnectionsFrom</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-Hey_0021-Cannot-stat-file-error">Hey! Cannot stat file error</a>:</td><td> </td><td valign="top"><a href="#copy">copy</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-How-can-I-avoid-hanging-shellcommands_003f">How can I avoid hanging shellcommands?</a>:</td><td> </td><td valign="top"><a href="#shellcommands">shellcommands</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-How-can-I-set-a-timeout-for-a-shell-command_003f">How can I set a timeout for a shell command?</a>:</td><td> </td><td valign="top"><a href="#shellcommands">shellcommands</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-How-to-create-files-while-editing">How to create files while editing</a>:</td><td> </td><td valign="top"><a href="#AutoCreate">AutoCreate</a></td></tr>
<tr><td colspan="4"> <hr></td></tr>
<tr><th><a name="FAQ-Index_mb_letter-I">I</a></th><td></td><td></td></tr>
<tr><td></td><td valign="top"><a href="#index-Iterating-over-lists">Iterating over lists</a>:</td><td> </td><td valign="top"><a href="#Iteration-over-lists">Iteration over lists</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-Iterating-over-lists-1">Iterating over lists</a>:</td><td> </td><td valign="top"><a href="#split">split</a></td></tr>
<tr><td colspan="4"> <hr></td></tr>
<tr><th><a name="FAQ-Index_mb_letter-L">L</a></th><td></td><td></td></tr>
<tr><td></td><td valign="top"><a href="#index-locahost-in-copy">locahost in copy</a>:</td><td> </td><td valign="top"><a href="#copy">copy</a></td></tr>
<tr><td colspan="4"> <hr></td></tr>
<tr><th><a name="FAQ-Index_mb_letter-M">M</a></th><td></td><td></td></tr>
<tr><td></td><td valign="top"><a href="#index-MD5-checksums-take-a-long-time-to-compute_002e">MD5 checksums take a long time to compute.</a>:</td><td> </td><td valign="top"><a href="#ChecksumDatabase-in-cfservd">ChecksumDatabase in cfservd</a></td></tr>
<tr><td colspan="4"> <hr></td></tr>
<tr><th><a name="FAQ-Index_mb_letter-P">P</a></th><td></td><td></td></tr>
<tr><td></td><td valign="top"><a href="#index-Parentheses-in-classes_002e">Parentheses in classes.</a>:</td><td> </td><td valign="top"><a href="#Cfengine-classes">Cfengine classes</a></td></tr>
<tr><td colspan="4"> <hr></td></tr>
<tr><th><a name="FAQ-Index_mb_letter-R">R</a></th><td></td><td></td></tr>
<tr><td></td><td valign="top"><a href="#index-Remote-copy-problems_002c-can_0027t-stat">Remote copy problems, can’t stat</a>:</td><td> </td><td valign="top"><a href="#copy">copy</a></td></tr>
<tr><td colspan="4"> <hr></td></tr>
<tr><th><a name="FAQ-Index_mb_letter-S">S</a></th><td></td><td></td></tr>
<tr><td></td><td valign="top"><a href="#index-Shellcommands-must-start-with-absolute-path">Shellcommands must start with absolute path</a>:</td><td> </td><td valign="top"><a href="#shellcommands">shellcommands</a></td></tr>
<tr><td colspan="4"> <hr></td></tr>
<tr><th><a name="FAQ-Index_mb_letter-T">T</a></th><td></td><td></td></tr>
<tr><td></td><td valign="top"><a href="#index-Too-many-open-files-error-1">Too many open files error</a>:</td><td> </td><td valign="top"><a href="#Too-many-open-files">Too many open files</a></td></tr>
<tr><td colspan="4"> <hr></td></tr>
</table>
<table><tr><th valign="top">Jump to: </th><td><a class="summary-letter" href="#FAQ-Index_mb_letter-A"><b>A</b></a>
<a class="summary-letter" href="#FAQ-Index_mb_letter-B"><b>B</b></a>
<a class="summary-letter" href="#FAQ-Index_mb_letter-C"><b>C</b></a>
<a class="summary-letter" href="#FAQ-Index_mb_letter-D"><b>D</b></a>
<a class="summary-letter" href="#FAQ-Index_mb_letter-H"><b>H</b></a>
<a class="summary-letter" href="#FAQ-Index_mb_letter-I"><b>I</b></a>
<a class="summary-letter" href="#FAQ-Index_mb_letter-L"><b>L</b></a>
<a class="summary-letter" href="#FAQ-Index_mb_letter-M"><b>M</b></a>
<a class="summary-letter" href="#FAQ-Index_mb_letter-P"><b>P</b></a>
<a class="summary-letter" href="#FAQ-Index_mb_letter-R"><b>R</b></a>
<a class="summary-letter" href="#FAQ-Index_mb_letter-S"><b>S</b></a>
<a class="summary-letter" href="#FAQ-Index_mb_letter-T"><b>T</b></a>
</td></tr></table>
<a name="Contents">
<a name="SEC_Contents"></a>
<h2 class="contents-heading">Table of Contents</h2>
<div class="contents">
<ul class="no-bullet">
<li><a name="toc-Introduction-to-reference-manual" href="#Reference-introduction">1 Introduction to reference manual</a>
<ul class="no-bullet">
<li><a name="toc-Installation-1" href="#Installation">1.1 Installation</a></li>
<li><a name="toc-Work-directory-1" href="#Work-directory">1.2 Work directory</a></li>
<li><a name="toc-Cfengine-hard-classes" href="#Hard-classes">1.3 Cfengine hard classes</a></li>
<li><a name="toc-Filenames-and-paths-1" href="#Filenames-and-paths">1.4 Filenames and paths</a></li>
<li><a name="toc-Debugging-with-signals-1" href="#Debugging-with-signals">1.5 Debugging with signals</a></li>
</ul></li>
<li><a name="toc-Cfkey-reference" href="#Cfkey">2 Cfkey reference</a></li>
<li><a name="toc-Cfshow-reference" href="#Cfshow">3 Cfshow reference</a></li>
<li><a name="toc-Cfagent-reference-1" href="#Cfagent-reference">4 Cfagent reference</a>
<ul class="no-bullet">
<li><a name="toc-Cfagent-intro-1" href="#Cfagent-intro">4.1 Cfagent intro</a></li>
<li><a name="toc-The-file-cfagent_002econf-1" href="#The-file-cfagent_002econf">4.2 The file cfagent.conf</a></li>
<li><a name="toc-Cfagent-runtime-options" href="#Cfagent-Runtime-Options">4.3 Cfagent runtime options</a></li>
<li><a name="toc-Variable-expansion-and-contexts-1" href="#Variable-expansion-and-contexts">4.4 Variable expansion and contexts</a>
<ul class="no-bullet">
<li><a name="toc-Setting-variables-with-functions-1" href="#Setting-variables-with-functions">4.4.1 Setting variables with functions</a></li>
<li><a name="toc-Special-variables-1" href="#Special-variables">4.4.2 Special variables</a></li>
<li><a name="toc-Iteration-over-lists-1" href="#Iteration-over-lists">4.4.3 Iteration over lists</a></li>
</ul></li>
<li><a name="toc-Cfengine-classes-1" href="#Cfengine-classes">4.5 Cfengine classes</a>
<ul class="no-bullet">
<li><a name="toc-Setting-classes-with-special-functions-1" href="#Setting-classes-with-special-functions">4.5.1 Setting classes with special functions</a></li>
<li><a name="toc-AccessedBefore-1" href="#AccessedBefore">4.5.2 AccessedBefore</a></li>
<li><a name="toc-ChangedBefore-1" href="#ChangedBefore">4.5.3 ChangedBefore</a></li>
<li><a name="toc-ClassMatch-1" href="#ClassMatch">4.5.4 ClassMatch</a></li>
<li><a name="toc-FileExists-1" href="#FileExists">4.5.5 FileExists</a></li>
<li><a name="toc-GroupExists-1" href="#GroupExists">4.5.6 GroupExists</a></li>
<li><a name="toc-HostRange-1" href="#HostRange">4.5.7 HostRange</a></li>
<li><a name="toc-IsDefined-1" href="#IsDefined">4.5.8 IsDefined</a></li>
<li><a name="toc-IsDir-1" href="#IsDir">4.5.9 IsDir</a></li>
<li><a name="toc-IsLink-1" href="#IsLink">4.5.10 IsLink</a></li>
<li><a name="toc-IsPlain-1" href="#IsPlain">4.5.11 IsPlain</a></li>
<li><a name="toc-IsNewerThan-1" href="#IsNewerThan">4.5.12 IsNewerThan</a></li>
<li><a name="toc-IPRange-1" href="#IPRange">4.5.13 IPRange</a></li>
<li><a name="toc-PrepModule-1" href="#PrepModule">4.5.14 PrepModule</a></li>
<li><a name="toc-Regcmp-1" href="#Regcmp">4.5.15 Regcmp</a></li>
<li><a name="toc-ReturnsZero-1" href="#ReturnsZero">4.5.16 ReturnsZero</a></li>
<li><a name="toc-ReturnsZeroShell-1" href="#ReturnsZeroShell">4.5.17 ReturnsZeroShell</a></li>
<li><a name="toc-Strcmp-1" href="#Strcmp">4.5.18 Strcmp</a></li>
<li><a name="toc-UserExists-1" href="#UserExists">4.5.19 UserExists</a></li>
<li><a name="toc-IsGreaterThan-1" href="#IsGreaterThan">4.5.20 IsGreaterThan</a></li>
<li><a name="toc-IsLessThan-1" href="#IsLessThan">4.5.21 IsLessThan</a></li>
<li><a name="toc-Examples-setting-classes-1" href="#Examples-setting-classes">4.5.22 Examples setting classes</a></li>
</ul></li>
<li><a name="toc-acl-1" href="#acl">4.6 acl</a>
<ul class="no-bullet">
<li><a name="toc-Access-control-entries" href="#ACEs">4.6.1 Access control entries</a></li>
<li><a name="toc-Solaris-ACLs-1" href="#Solaris-ACLs">4.6.2 Solaris ACLs</a></li>
<li><a name="toc-DFS-ACLs-1" href="#DFS-ACLs">4.6.3 DFS ACLs</a></li>
<li><a name="toc-NT-ACLs-1" href="#NT-ACLs">4.6.4 NT ACLs</a></li>
<li><a name="toc-Windows-ACL-Example-1" href="#Windows-ACL-Example">4.6.5 Windows ACL Example</a></li>
<li><a name="toc-Posix-ACL-Example-1" href="#Posix-ACL-Example">4.6.6 Posix ACL Example</a></li>
</ul></li>
<li><a name="toc-alerts-1" href="#alerts">4.7 alerts</a></li>
<li><a name="toc-binservers-1" href="#binservers">4.8 binservers</a></li>
<li><a name="toc-broadcast-1" href="#broadcast">4.9 broadcast</a></li>
<li><a name="toc-control-1" href="#control">4.10 control</a>
<ul class="no-bullet">
<li><a name="toc-AbortClasses-1" href="#AbortClasses">4.10.1 AbortClasses</a></li>
<li><a name="toc-access-1" href="#access">4.10.2 access</a></li>
<li><a name="toc-actionsequence-1" href="#actionsequence">4.10.3 actionsequence</a></li>
<li><a name="toc-AddClasses" href="#addclasses">4.10.4 AddClasses</a></li>
<li><a name="toc-AddInstallable" href="#addinstallable">4.10.5 AddInstallable</a></li>
<li><a name="toc-AllowRedefinitionOf-1" href="#AllowRedefinitionOf">4.10.6 AllowRedefinitionOf</a></li>
<li><a name="toc-Auditing-1" href="#Auditing">4.10.7 Auditing</a></li>
<li><a name="toc-AutoDefine-1" href="#AutoDefine">4.10.8 AutoDefine</a></li>
<li><a name="toc-BinaryPaddingChar-1" href="#BinaryPaddingChar">4.10.9 BinaryPaddingChar</a></li>
<li><a name="toc-BindToInterface-in-cfagent-1" href="#BindToInterface-in-cfagent">4.10.10 BindToInterface in cfagent</a></li>
<li><a name="toc-ChecksumDatabase-in-cfagent-1" href="#ChecksumDatabase-in-cfagent">4.10.11 ChecksumDatabase in cfagent</a></li>
<li><a name="toc-ChecksumPurge-1" href="#ChecksumPurge">4.10.12 ChecksumPurge</a></li>
<li><a name="toc-ChecksumUpdates-1" href="#ChecksumUpdates">4.10.13 ChecksumUpdates</a></li>
<li><a name="toc-CompressCommand-1" href="#CompressCommand">4.10.14 CompressCommand</a></li>
<li><a name="toc-ChildLibPath" href="#childlibpath">4.10.15 ChildLibPath</a></li>
<li><a name="toc-CopyLinks" href="#copylinks">4.10.16 CopyLinks</a></li>
<li><a name="toc-DefaultCopyType" href="#defaultcopytype">4.10.17 DefaultCopyType</a></li>
<li><a name="toc-DefaultPkgMgr" href="#defaultpkgmgr">4.10.18 DefaultPkgMgr</a></li>
<li><a name="toc-DeleteNonUserFiles" href="#deletenonuserfiles">4.10.19 DeleteNonUserFiles</a></li>
<li><a name="toc-DeleteNonOwnerFiles" href="#deletenonownerfiles">4.10.20 DeleteNonOwnerFiles</a></li>
<li><a name="toc-DeleteNonUserMail" href="#deletenonusermail">4.10.21 DeleteNonUserMail</a></li>
<li><a name="toc-DeleteNonOwnerMail" href="#deletenonownermail">4.10.22 DeleteNonOwnerMail</a></li>
<li><a name="toc-domain-1" href="#domain">4.10.23 domain</a></li>
<li><a name="toc-DPKGInstallCommand" href="#dpkginstallcommand">4.10.24 DPKGInstallCommand</a></li>
<li><a name="toc-DryRun" href="#dryrun">4.10.25 DryRun</a></li>
<li><a name="toc-editbinaryfilesize-1" href="#editbinaryfilesize">4.10.26 editbinaryfilesize</a></li>
<li><a name="toc-editfilesize-1" href="#editfilesize">4.10.27 editfilesize</a></li>
<li><a name="toc-EmptyResolvConf" href="#emptyresolvconf">4.10.28 EmptyResolvConf</a></li>
<li><a name="toc-Exclamation" href="#exclamation">4.10.29 Exclamation</a></li>
<li><a name="toc-ExcludeCopy" href="#excludecopy">4.10.30 ExcludeCopy</a></li>
<li><a name="toc-ExcludeLink" href="#excludelinks">4.10.31 ExcludeLink</a></li>
<li><a name="toc-ExpireAfter-1" href="#ExpireAfter">4.10.32 ExpireAfter</a></li>
<li><a name="toc-FreeBSDInstallCommand-1" href="#FreeBSDInstallCommand">4.10.33 FreeBSDInstallCommand</a></li>
<li><a name="toc-FreeBSDRemoveCommand-1" href="#FreeBSDRemoveCommand">4.10.34 FreeBSDRemoveCommand</a></li>
<li><a name="toc-FullEncryption-1" href="#FullEncryption">4.10.35 FullEncryption</a></li>
<li><a name="toc-HomePattern" href="#homepattern">4.10.36 HomePattern</a></li>
<li><a name="toc-HostnameKeys-in-cfagent-1" href="#HostnameKeys-in-cfagent">4.10.37 HostnameKeys in cfagent</a></li>
<li><a name="toc-IfElapsed-in-cfagent-1" href="#IfElapsed-in-cfagent">4.10.38 IfElapsed in cfagent</a></li>
<li><a name="toc-FriendIgnoreRegex" href="#IgnoreFriendRegex">4.10.39 FriendIgnoreRegex</a></li>
<li><a name="toc-IgnoreInterfaceRegex-1" href="#IgnoreInterfaceRegex">4.10.40 IgnoreInterfaceRegex</a></li>
<li><a name="toc-Inform-1" href="#Inform">4.10.41 Inform</a></li>
<li><a name="toc-InterfaceName" href="#interfacename">4.10.42 InterfaceName</a></li>
<li><a name="toc-FileExtensions" href="#fileextension">4.10.43 FileExtensions</a></li>
<li><a name="toc-LastSeen" href="#lastseen">4.10.44 LastSeen</a></li>
<li><a name="toc-LastSeenExpireAfter" href="#lastseenexpireafter">4.10.45 LastSeenExpireAfter</a></li>
<li><a name="toc-LinkCopies" href="#linkcopies">4.10.46 LinkCopies</a></li>
<li><a name="toc-LogDirectory-1" href="#LogDirectory">4.10.47 LogDirectory</a></li>
<li><a name="toc-LogTidyHomeFiles-1" href="#LogTidyHomeFiles">4.10.48 LogTidyHomeFiles</a></li>
<li><a name="toc-moduledirectory-1" href="#moduledirectory">4.10.49 moduledirectory</a></li>
<li><a name="toc-mountpattern-1" href="#mountpattern">4.10.50 mountpattern</a></li>
<li><a name="toc-netmask-1" href="#netmask">4.10.51 netmask</a></li>
<li><a name="toc-NonAlphaNumFiles" href="#nonalphanumfiles">4.10.52 NonAlphaNumFiles</a></li>
<li><a name="toc-nfstype-1" href="#nfstype">4.10.53 nfstype</a></li>
<li><a name="toc-PortageInstallCommand-1" href="#PortageInstallCommand">4.10.54 PortageInstallCommand</a></li>
<li><a name="toc-RepChar" href="#repchar">4.10.55 RepChar</a></li>
<li><a name="toc-Repository-1" href="#repository">4.10.56 Repository</a></li>
<li><a name="toc-RPMcommand-1" href="#RPMcommand">4.10.57 RPMcommand</a></li>
<li><a name="toc-RPMInstallCommand" href="#rpminstallcommand">4.10.58 RPMInstallCommand</a></li>
<li><a name="toc-Schedule" href="#schedule">4.10.59 Schedule</a></li>
<li><a name="toc-SecureInput" href="#secureinput">4.10.60 SecureInput</a></li>
<li><a name="toc-SensibleCount" href="#sensiblecount">4.10.61 SensibleCount</a></li>
<li><a name="toc-SensibleSize" href="#sensiblesize">4.10.62 SensibleSize</a></li>
<li><a name="toc-ShowActions" href="#showactions">4.10.63 ShowActions</a></li>
<li><a name="toc-SingleCopy" href="#singlecopy">4.10.64 SingleCopy</a></li>
<li><a name="toc-site_002ffaculty" href="#site">4.10.65 site/faculty</a></li>
<li><a name="toc-SkipIdentify-1" href="#SkipIdentify">4.10.66 SkipIdentify</a></li>
<li><a name="toc-smtpserver" href="#Smtpserver">4.10.67 smtpserver</a></li>
<li><a name="toc-SplayTime-1" href="#SplayTime">4.10.68 SplayTime</a></li>
<li><a name="toc-Split" href="#split">4.10.69 Split</a></li>
<li><a name="toc-SpoolDirectories" href="#spooldirectories">4.10.70 SpoolDirectories</a></li>
<li><a name="toc-SUNInstallCommand" href="#suninstallcommand">4.10.71 SUNInstallCommand</a></li>
<li><a name="toc-suspiciousnames-1" href="#suspiciousnames">4.10.72 suspiciousnames</a></li>
<li><a name="toc-sysadm-1" href="#sysadm">4.10.73 sysadm</a></li>
<li><a name="toc-Syslog-1" href="#Syslog">4.10.74 Syslog</a></li>
<li><a name="toc-SyslogFacility-1" href="#SyslogFacility">4.10.75 SyslogFacility</a></li>
<li><a name="toc-timezone-1" href="#timezone">4.10.76 timezone</a></li>
<li><a name="toc-TimeOut-1" href="#TimeOut">4.10.77 TimeOut</a></li>
<li><a name="toc-Verbose-1" href="#Verbose">4.10.78 Verbose</a></li>
<li><a name="toc-Warnings-1" href="#Warnings">4.10.79 Warnings</a></li>
<li><a name="toc-WarnNonUserFiles" href="#warnnonuserfiles">4.10.80 WarnNonUserFiles</a></li>
<li><a name="toc-WarnNonOwnerFiles" href="#warnnonownerfiles">4.10.81 WarnNonOwnerFiles</a></li>
<li><a name="toc-WarnNonUserMail" href="#warnnonusermail">4.10.82 WarnNonUserMail</a></li>
<li><a name="toc-WarnNonOwnerMail" href="#warnnonownermail">4.10.83 WarnNonOwnerMail</a></li>
</ul></li>
<li><a name="toc-classes-1" href="#classes">4.11 classes</a></li>
<li><a name="toc-copy-1" href="#copy">4.12 copy</a>
<ul class="no-bullet">
<li><a name="toc-copy-example-1" href="#copy-example">4.12.1 copy example</a></li>
<li><a name="toc-Hard-links-in-copying" href="#hard-links-in-copy">4.12.2 Hard links in copying</a></li>
<li><a name="toc-Too-many-open-files-1" href="#Too-many-open-files">4.12.3 Too many open files</a></li>
</ul></li>
<li><a name="toc-defaultroute-1" href="#defaultroute">4.13 defaultroute</a></li>
<li><a name="toc-disks-1" href="#disks">4.14 disks</a></li>
<li><a name="toc-directories-1" href="#directories">4.15 directories</a></li>
<li><a name="toc-disable-1" href="#disable">4.16 disable</a></li>
<li><a name="toc-editfiles-1" href="#editfiles">4.17 editfiles</a>
<ul class="no-bullet">
<li><a name="toc-AbortAtLineMatching-1" href="#AbortAtLineMatching">4.17.1 AbortAtLineMatching</a></li>
<li><a name="toc-Append-1" href="#Append">4.17.2 Append</a></li>
<li><a name="toc-AppendIfNoLineMatching-1" href="#AppendIfNoLineMatching">4.17.3 AppendIfNoLineMatching</a></li>
<li><a name="toc-AppendIfNoSuchLine-1" href="#AppendIfNoSuchLine">4.17.4 AppendIfNoSuchLine</a></li>
<li><a name="toc-AppendIfNoSuchLinesFromFile-1" href="#AppendIfNoSuchLinesFromFile">4.17.5 AppendIfNoSuchLinesFromFile</a></li>
<li><a name="toc-AppendToLineIfNotContains-1" href="#AppendToLineIfNotContains">4.17.6 AppendToLineIfNotContains</a></li>
<li><a name="toc-Audit-in-editfiles" href="#Audit">4.17.7 Audit in editfiles</a></li>
<li><a name="toc-AutoCreate-1" href="#AutoCreate">4.17.8 AutoCreate</a></li>
<li><a name="toc-AutomountDirectResources-1" href="#AutomountDirectResources">4.17.9 AutomountDirectResources</a></li>
<li><a name="toc-Backup-in-editfiles-1" href="#Backup-in-editfiles">4.17.10 Backup in editfiles</a></li>
<li><a name="toc-BeginGroupIfDefined-1" href="#BeginGroupIfDefined">4.17.11 BeginGroupIfDefined</a></li>
<li><a name="toc-BeginGroupIfNotDefined-1" href="#BeginGroupIfNotDefined">4.17.12 BeginGroupIfNotDefined</a></li>
<li><a name="toc-BeginGroupIfFileExists-1" href="#BeginGroupIfFileExists">4.17.13 BeginGroupIfFileExists</a></li>
<li><a name="toc-BeginGroupIfFileIsNewer-1" href="#BeginGroupIfFileIsNewer">4.17.14 BeginGroupIfFileIsNewer</a></li>
<li><a name="toc-BeginGroupIfLineContaining-1" href="#BeginGroupIfLineContaining">4.17.15 BeginGroupIfLineContaining</a></li>
<li><a name="toc-BeginGroupIfLineMatching-1" href="#BeginGroupIfLineMatching">4.17.16 BeginGroupIfLineMatching</a></li>
<li><a name="toc-BeginGroupIfMatch-1" href="#BeginGroupIfMatch">4.17.17 BeginGroupIfMatch</a></li>
<li><a name="toc-BeginGroupIfNoLineContaining-1" href="#BeginGroupIfNoLineContaining">4.17.18 BeginGroupIfNoLineContaining</a></li>
<li><a name="toc-BeginGroupIfNoLineMatching-1" href="#BeginGroupIfNoLineMatching">4.17.19 BeginGroupIfNoLineMatching</a></li>
<li><a name="toc-BeginGroupIfNoMatch-1" href="#BeginGroupIfNoMatch">4.17.20 BeginGroupIfNoMatch</a></li>
<li><a name="toc-BeginGroupIfNoSuchLine-1" href="#BeginGroupIfNoSuchLine">4.17.21 BeginGroupIfNoSuchLine</a></li>
<li><a name="toc-BreakIfLineMatches-1" href="#BreakIfLineMatches">4.17.22 BreakIfLineMatches</a></li>
<li><a name="toc-CatchAbort-1" href="#CatchAbort">4.17.23 CatchAbort</a></li>
<li><a name="toc-CommentLinesMatching-1" href="#CommentLinesMatching">4.17.24 CommentLinesMatching</a></li>
<li><a name="toc-CommentLinesStarting-1" href="#CommentLinesStarting">4.17.25 CommentLinesStarting</a></li>
<li><a name="toc-CommentNLines-1" href="#CommentNLines">4.17.26 CommentNLines</a></li>
<li><a name="toc-CommentToLineMatching-1" href="#CommentToLineMatching">4.17.27 CommentToLineMatching</a></li>
<li><a name="toc-DefineClasses-1" href="#DefineClasses">4.17.28 DefineClasses</a></li>
<li><a name="toc-DefineInGroup-1" href="#DefineInGroup">4.17.29 DefineInGroup</a></li>
<li><a name="toc-DeleteLinesAfterThisMatching-1" href="#DeleteLinesAfterThisMatching">4.17.30 DeleteLinesAfterThisMatching</a></li>
<li><a name="toc-DeleteLinesContaining_002fDeleteLinesNotContaining" href="#DeleteLinesContaining">4.17.31 DeleteLinesContaining/DeleteLinesNotContaining</a></li>
<li><a name="toc-DeleteLinesMatching_002fDeleteLinesNotMatching" href="#DeleteLinesMatching">4.17.32 DeleteLinesMatching/DeleteLinesNotMatching</a></li>
<li><a name="toc-DeleteLinesStarting_002fDeleteLinesNotStarting" href="#DeleteLinesStarting">4.17.33 DeleteLinesStarting/DeleteLinesNotStarting</a></li>
<li><a name="toc-DeleteLinesNotContainingFileItems" href="#DeleteLinesNotContaining">4.17.34 DeleteLinesNotContainingFileItems</a></li>
<li><a name="toc-DeleteLinesNotMatchingFileItems-1" href="#DeleteLinesNotMatchingFileItems">4.17.35 DeleteLinesNotMatchingFileItems</a></li>
<li><a name="toc-DeleteLinesNotStartingFileItems-1" href="#DeleteLinesNotStartingFileItems">4.17.36 DeleteLinesNotStartingFileItems</a></li>
<li><a name="toc-DeleteNLines-1" href="#DeleteNLines">4.17.37 DeleteNLines</a></li>
<li><a name="toc-DeleteToLineMatching-1" href="#DeleteToLineMatching">4.17.38 DeleteToLineMatching</a></li>
<li><a name="toc-EditMode-and-binary-editing" href="#EditMode-_0028binary_0029">4.17.39 EditMode and binary editing</a></li>
<li><a name="toc-EditSplit-1" href="#EditSplit">4.17.40 EditSplit</a></li>
<li><a name="toc-EmptyEntireFilePlease-1" href="#EmptyEntireFilePlease">4.17.41 EmptyEntireFilePlease</a></li>
<li><a name="toc-ElseDefineClasses-1" href="#ElseDefineClasses">4.17.42 ElseDefineClasses</a></li>
<li><a name="toc-EndGroup-1" href="#EndGroup">4.17.43 EndGroup</a></li>
<li><a name="toc-EndLoop-1" href="#EndLoop">4.17.44 EndLoop</a></li>
<li><a name="toc-ExpandVariables-1" href="#ExpandVariables">4.17.45 ExpandVariables</a></li>
<li><a name="toc-ExpireAfter-editfiles-1" href="#ExpireAfter-editfiles">4.17.46 ExpireAfter editfiles</a></li>
<li><a name="toc-Filter-1" href="#Filter">4.17.47 Filter</a></li>
<li><a name="toc-FixEndOfLine-1" href="#FixEndOfLine">4.17.48 FixEndOfLine</a></li>
<li><a name="toc-ForEachLineIn-quoted_002dfilename" href="#ForEachLineIn">4.17.49 ForEachLineIn <var>quoted-filename</var></a></li>
<li><a name="toc-GotoLastLine-1" href="#GotoLastLine">4.17.50 GotoLastLine</a></li>
<li><a name="toc-HashCommentLinesContaining-1" href="#HashCommentLinesContaining">4.17.51 HashCommentLinesContaining</a></li>
<li><a name="toc-HashCommentLinesMatching-1" href="#HashCommentLinesMatching">4.17.52 HashCommentLinesMatching</a></li>
<li><a name="toc-HashCommentLinesStarting-1" href="#HashCommentLinesStarting">4.17.53 HashCommentLinesStarting</a></li>
<li><a name="toc-IfElapsed" href="#IfElapsed-_0028editing_0029">4.17.54 IfElapsed</a></li>
<li><a name="toc-IncrementPointer-quoted_002dnumber" href="#IncrementPointer">4.17.55 IncrementPointer <var>quoted-number</var></a></li>
<li><a name="toc-Inform-editfiles" href="#Inform-_0028editing_0029">4.17.56 Inform editfiles</a></li>
<li><a name="toc-InsertFile-1" href="#InsertFile">4.17.57 InsertFile</a></li>
<li><a name="toc-InsertLine-1" href="#InsertLine">4.17.58 InsertLine</a></li>
<li><a name="toc-LocateLineMatching-1" href="#LocateLineMatching">4.17.59 LocateLineMatching</a></li>
<li><a name="toc-PercentCommentLinesContaining-1" href="#PercentCommentLinesContaining">4.17.60 PercentCommentLinesContaining</a></li>
<li><a name="toc-PercentCommentLinesMatching-1" href="#PercentCommentLinesMatching">4.17.61 PercentCommentLinesMatching</a></li>
<li><a name="toc-PercentCommentLinesStarting-1" href="#PercentCommentLinesStarting">4.17.62 PercentCommentLinesStarting</a></li>
<li><a name="toc-Prepend" href="#Prepend-_0028editing_0029">4.17.63 Prepend</a></li>
<li><a name="toc-PrependIfNoLineMatching-1" href="#PrependIfNoLineMatching">4.17.64 PrependIfNoLineMatching</a></li>
<li><a name="toc-PrependIfNoSuchLine-1" href="#PrependIfNoSuchLine">4.17.65 PrependIfNoSuchLine</a></li>
<li><a name="toc-Recurse" href="#Recurse-_0028editing_0029">4.17.66 Recurse</a></li>
<li><a name="toc-ReplaceLineWith-1" href="#ReplaceLineWith">4.17.67 ReplaceLineWith</a></li>
<li><a name="toc-ReplaceAll_002fWith" href="#ReplaceAll-With">4.17.68 ReplaceAll/With</a></li>
<li><a name="toc-ReplaceFirst_002fWith" href="#ReplaceFirst">4.17.69 ReplaceFirst/With</a></li>
<li><a name="toc-ReplaceLinesMatchingField-1" href="#ReplaceLinesMatchingField">4.17.70 ReplaceLinesMatchingField</a></li>
<li><a name="toc-Repository-editfiles" href="#Repository">4.17.71 Repository editfiles</a></li>
<li><a name="toc-ResetSearch-1" href="#ResetSearch">4.17.72 ResetSearch</a></li>
<li><a name="toc-RunScript-1" href="#RunScript">4.17.73 RunScript</a></li>
<li><a name="toc-RunScriptIfLineMatching-1" href="#RunScriptIfLineMatching">4.17.74 RunScriptIfLineMatching</a></li>
<li><a name="toc-RunScriptIfNoLineMatching-1" href="#RunScriptIfNoLineMatching">4.17.75 RunScriptIfNoLineMatching</a></li>
<li><a name="toc-SetCommentStart-1" href="#SetCommentStart">4.17.76 SetCommentStart</a></li>
<li><a name="toc-SetCommentEnd-1" href="#SetCommentEnd">4.17.77 SetCommentEnd</a></li>
<li><a name="toc-SetLine-1" href="#SetLine">4.17.78 SetLine</a></li>
<li><a name="toc-SetScript-1" href="#SetScript">4.17.79 SetScript</a></li>
<li><a name="toc-SlashCommentLinesContaining-1" href="#SlashCommentLinesContaining">4.17.80 SlashCommentLinesContaining</a></li>
<li><a name="toc-SlashCommentLinesMatching-1" href="#SlashCommentLinesMatching">4.17.81 SlashCommentLinesMatching</a></li>
<li><a name="toc-SlashCommentLinesStarting-1" href="#SlashCommentLinesStarting">4.17.82 SlashCommentLinesStarting</a></li>
<li><a name="toc-SplitOn-1" href="#SplitOn">4.17.83 SplitOn</a></li>
<li><a name="toc-Syslog-editfiles" href="#SysLog">4.17.84 Syslog editfiles</a></li>
<li><a name="toc-Umask-1" href="#Umask">4.17.85 Umask</a></li>
<li><a name="toc-UnCommentLinesContaining-1" href="#UnCommentLinesContaining">4.17.86 UnCommentLinesContaining</a></li>
<li><a name="toc-UnCommentLinesMatching-1" href="#UnCommentLinesMatching">4.17.87 UnCommentLinesMatching</a></li>
<li><a name="toc-UnCommentNLines" href="#UnCommentsNLines">4.17.88 UnCommentNLines</a></li>
<li><a name="toc-UnCommentToLineMatching-1" href="#UnCommentToLineMatching">4.17.89 UnCommentToLineMatching</a></li>
<li><a name="toc-UnsetAbort-1" href="#UnsetAbort">4.17.90 UnsetAbort</a></li>
<li><a name="toc-UseShell-1" href="#UseShell">4.17.91 UseShell</a></li>
<li><a name="toc-WarnIfFileMissing-1" href="#WarnIfFileMissing">4.17.92 WarnIfFileMissing</a></li>
<li><a name="toc-WarnIfLineContaining-1" href="#WarnIfLineContaining">4.17.93 WarnIfLineContaining</a></li>
<li><a name="toc-WarnIfLineMatching-1" href="#WarnIfLineMatching">4.17.94 WarnIfLineMatching</a></li>
<li><a name="toc-WarnIfLineStarting-1" href="#WarnIfLineStarting">4.17.95 WarnIfLineStarting</a></li>
<li><a name="toc-WarnIfNoLineContaining-1" href="#WarnIfNoLineContaining">4.17.96 WarnIfNoLineContaining</a></li>
<li><a name="toc-WarnIfNoLineMatching-1" href="#WarnIfNoLineMatching">4.17.97 WarnIfNoLineMatching</a></li>
<li><a name="toc-WarnIfNoLineStarting-1" href="#WarnIfNoLineStarting">4.17.98 WarnIfNoLineStarting</a></li>
<li><a name="toc-WarnIfNoSuchLine-1" href="#WarnIfNoSuchLine">4.17.99 WarnIfNoSuchLine</a></li>
</ul></li>
<li><a name="toc-Editfiles-on-Binary-Files-1" href="#Editfiles-on-Binary-Files">4.18 Editfiles on Binary Files</a></li>
<li><a name="toc-files-1" href="#files">4.19 files</a>
<ul class="no-bullet">
<li><a name="toc-Syntax-1" href="#Syntax">4.19.1 Syntax</a></li>
<li><a name="toc-Recursion-1" href="#Recursion">4.19.2 Recursion</a></li>
<li><a name="toc-Directory-permissions-1" href="#Directory-permissions">4.19.3 Directory permissions</a></li>
<li><a name="toc-Checksums-and-change-management-1" href="#Checksums-and-change-management">4.19.4 Checksums and change management</a></li>
<li><a name="toc-home-directive-1" href="#home-directive">4.19.5 <code>home</code> directive</a></li>
<li><a name="toc-Owner-and-group-wildcards-1" href="#Owner-and-group-wildcards">4.19.6 Owner and group wildcards</a></li>
<li><a name="toc-Files-linkchildren-1" href="#Files-linkchildren">4.19.7 Files linkchildren</a></li>
<li><a name="toc-touch-1" href="#touch">4.19.8 touch</a></li>
<li><a name="toc-create-1" href="#create">4.19.9 create</a></li>
</ul></li>
<li><a name="toc-filters-1" href="#filters">4.20 filters</a>
<ul class="no-bullet">
<li><a name="toc-Complete-filter-examples-1" href="#Complete-filter-examples">4.20.1 Complete filter examples</a></li>
</ul></li>
<li><a name="toc-groups_002fclasses" href="#groups">4.21 groups/classes</a></li>
<li><a name="toc-homeservers-1" href="#homeservers">4.22 homeservers</a></li>
<li><a name="toc-ignore-1" href="#ignore">4.23 ignore</a></li>
<li><a name="toc-import-1" href="#import">4.24 import</a></li>
<li><a name="toc-interfaces-1" href="#interfaces">4.25 interfaces</a></li>
<li><a name="toc-links-1" href="#links">4.26 links</a>
<ul class="no-bullet">
<li><a name="toc-Single-links-1" href="#Single-links">4.26.1 Single links</a></li>
<li><a name="toc-Multiple-Links-1" href="#Multiple-Links">4.26.2 Multiple Links</a></li>
<li><a name="toc-Link-Children-1" href="#Link-Children">4.26.3 Link Children</a></li>
<li><a name="toc-Relative-and-absolute-links-1" href="#Relative-and-absolute-links">4.26.4 Relative and absolute links</a></li>
<li><a name="toc-Hard-Links" href="#Hard-links">4.26.5 Hard Links</a></li>
</ul></li>
<li><a name="toc-mailserver-1" href="#mailserver">4.27 mailserver</a></li>
<li><a name="toc-methods-1" href="#methods">4.28 methods</a>
<ul class="no-bullet">
<li><a name="toc-Localhost-examples" href="#localhost-examples">4.28.1 Localhost examples</a></li>
<li><a name="toc-Remote-host-examples" href="#remotehost-examples">4.28.2 Remote host examples</a></li>
</ul></li>
<li><a name="toc-miscmounts-1" href="#miscmounts">4.29 miscmounts</a></li>
<li><a name="toc-mountables-1" href="#mountables">4.30 mountables</a></li>
<li><a name="toc-processes-1" href="#processes">4.31 processes</a></li>
<li><a name="toc-Packages" href="#packages">4.32 Packages</a></li>
<li><a name="toc-rename-1" href="#rename">4.33 rename</a></li>
<li><a name="toc-required-1" href="#required">4.34 required</a></li>
<li><a name="toc-resolve-1" href="#resolve">4.35 resolve</a></li>
<li><a name="toc-scli-1" href="#scli">4.36 scli</a></li>
<li><a name="toc-shellcommands-1" href="#shellcommands">4.37 shellcommands</a></li>
<li><a name="toc-strategies-1" href="#strategies">4.38 strategies</a></li>
<li><a name="toc-tidy-1" href="#tidy">4.39 tidy</a></li>
<li><a name="toc-unmount-1" href="#unmount">4.40 unmount</a></li>
</ul></li>
<li><a name="toc-Cfservd-and-cfrun-reference" href="#Cfservd_002econf-and-cfrun-reference">5 Cfservd and cfrun reference</a>
<ul class="no-bullet">
<li><a name="toc-control-cfservd" href="#cfservd-control">5.1 control cfservd</a>
<ul class="no-bullet">
<li><a name="toc-IP-address-ranges-1" href="#IP-address-ranges">5.1.1 IP address ranges</a></li>
<li><a name="toc-AllowConnectionsFrom-1" href="#AllowConnectionsFrom">5.1.2 AllowConnectionsFrom</a></li>
<li><a name="toc-AllowMultipleConnectionsFrom-1" href="#AllowMultipleConnectionsFrom">5.1.3 AllowMultipleConnectionsFrom</a></li>
<li><a name="toc-AllowUsers-1" href="#AllowUsers">5.1.4 AllowUsers</a></li>
<li><a name="toc-AutoExecCommand-1" href="#AutoExecCommand">5.1.5 AutoExecCommand</a></li>
<li><a name="toc-AutoExecInterval-1" href="#AutoExecInterval">5.1.6 AutoExecInterval</a></li>
<li><a name="toc-BindToInterface-in-cfservd-1" href="#BindToInterface-in-cfservd">5.1.7 BindToInterface in cfservd</a></li>
<li><a name="toc-ChecksumDatabase-in-cfservd-1" href="#ChecksumDatabase-in-cfservd">5.1.8 ChecksumDatabase in cfservd</a></li>
<li><a name="toc-cfrunCommand-1" href="#cfrunCommand">5.1.9 cfrunCommand</a></li>
<li><a name="toc-DenyBadClocks-1" href="#DenyBadClocks">5.1.10 DenyBadClocks</a></li>
<li><a name="toc-DenyConnectionsFrom-1" href="#DenyConnectionsFrom">5.1.11 DenyConnectionsFrom</a></li>
<li><a name="toc-HostnameKeys-in-cfservd" href="#cfservd-HostnameKeys">5.1.12 HostnameKeys in cfservd</a></li>
<li><a name="toc-IfElapsed-in-cfservd" href="#cfservd-IfElapsed">5.1.13 IfElapsed in cfservd</a></li>
<li><a name="toc-LogAllConnections-1" href="#LogAllConnections">5.1.14 LogAllConnections</a></li>
<li><a name="toc-LogEncryptedTransfers-1" href="#LogEncryptedTransfers">5.1.15 LogEncryptedTransfers</a></li>
<li><a name="toc-MaxConnections-1" href="#MaxConnections">5.1.16 MaxConnections</a></li>
<li><a name="toc-TrustKeysFrom-1" href="#TrustKeysFrom">5.1.17 TrustKeysFrom</a></li>
<li><a name="toc-DynamicAddresses-1" href="#DynamicAddresses">5.1.18 DynamicAddresses</a></li>
</ul></li>
<li><a name="toc-admit_002c-grant-and-deny" href="#admit-grant-and-deny">5.2 admit, grant and deny</a>
<ul class="no-bullet">
<li><a name="toc-root_003d-1" href="#root_003d">5.2.1 <code>root=</code></a></li>
<li><a name="toc-encrypt_003dtrue" href="#encrypt_003d">5.2.2 <code>encrypt=true</code></a></li>
<li><a name="toc-SkipVerify-1" href="#SkipVerify">5.2.3 SkipVerify</a></li>
</ul></li>
<li><a name="toc-cfrun-1" href="#cfrun">5.3 <code>cfrun</code></a></li>
<li><a name="toc-Firewalls-and-NATs-1" href="#Firewalls-and-NATs">5.4 Firewalls and NATs</a></li>
</ul></li>
<li><a name="toc-Cfexecd-reference-1" href="#Cfexecd-reference">6 Cfexecd reference</a></li>
<li><a name="toc-Problem-solving-1" href="#Problem-solving">7 Problem solving</a>
<ul class="no-bullet">
<li><a name="toc-cf_002epreconf-bootstrap-file-1" href="#cf_002epreconf-bootstrap-file">7.1 cf.preconf bootstrap file</a></li>
<li><a name="toc-cfrc-resource-file-1" href="#cfrc-resource-file">7.2 cfrc resource file</a></li>
</ul></li>
<li><a name="toc-Example-configuration-files" href="#Example-configuration-file">8 Example configuration files</a>
<ul class="no-bullet">
<li><a name="toc-cfagent_002econf-1" href="#cfagent_002econf">8.1 cfagent.conf</a></li>
<li><a name="toc-cf_002egroups-1" href="#cf_002egroups">8.2 cf.groups</a></li>
<li><a name="toc-cf_002emain-1" href="#cf_002emain">8.3 cf.main</a></li>
<li><a name="toc-cf_002esite-1" href="#cf_002esite">8.4 cf.site</a></li>
<li><a name="toc-cf_002emotd-1" href="#cf_002emotd">8.5 cf.motd</a></li>
<li><a name="toc-cf_002eusers-1" href="#cf_002eusers">8.6 cf.users</a></li>
<li><a name="toc-cf_002esolaris-1" href="#cf_002esolaris">8.7 cf.solaris</a></li>
<li><a name="toc-cf_002elinux-1" href="#cf_002elinux">8.8 cf.linux</a></li>
<li><a name="toc-cf_002efreebsd-_002f-cf_002enetbsd" href="#cf_002efreebsd">8.9 cf.freebsd / cf.netbsd</a></li>
<li><a name="toc-cfservd_002econf-tutorial" href="#cfservd_002econf">8.10 cfservd.conf tutorial</a></li>
</ul></li>
<li><a name="toc-Variable-Index-1" href="#Variable-Index">Variable Index</a></li>
<li><a name="toc-Concept-Index-1" href="#Concept-Index">Concept Index</a></li>
<li><a name="toc-FAQ-Index-1" href="#FAQ-Index">FAQ Index</a></li>
</ul>
</div>
<script type="text/javascript">
var gaJsHost = (("https:" == document.location.protocol) ? "https://ssl." : "http://www.");
document.write(unescape("%3Cscript src='" + gaJsHost + "google-analytics.com/ga.js' type='text/javascript'%3E%3C/script%3E"));
</script>
<script type="text/javascript">
var pageTracker = _gat._getTracker("UA-2576171-2");
pageTracker._initData();
pageTracker._trackPageview();
</script>
<hr>
</body>
</html>
|