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
|
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<title>3.6. CGI Configuration File Options</title>
<link rel="stylesheet" href="../stylesheets/icinga-docs.css" type="text/css">
<meta name="generator" content="DocBook XSL Stylesheets V1.75.1">
<meta name="keywords" content="Supervision, Icinga, Nagios, Linux">
<link rel="home" href="index.html" title="Icinga Version 1.14 Documentation">
<link rel="up" href="ch03.html" title="Chapter 3. Configuring Icinga">
<link rel="prev" href="customobjectvars.html" title="3.5. Custom Object Variables">
<link rel="next" href="ch04.html" title="Chapter 4. Running Icinga">
<script src="../js/jquery-min.js" type="text/javascript"></script><script src="../js/icinga-docs.js" type="text/javascript"></script>
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<CENTER><IMG src="../images/logofullsize.png" border="0" alt="Icinga" title="Icinga"></CENTER>
<div class="navheader">
<table width="100%" summary="Navigation header">
<tr><th colspan="3" align="center">3.6. CGI Configuration File Options</th></tr>
<tr>
<td width="20%" align="left">
<a accesskey="p" href="customobjectvars.html">Prev</a> </td>
<th width="60%" align="center">Chapter 3. Configuring Icinga</th>
<td width="20%" align="right"> <a accesskey="n" href="ch04.html">Next</a>
</td>
</tr>
</table>
<hr>
</div>
<div class="section" title="3.6. CGI Configuration File Options">
<div class="titlepage"><div><div><h2 class="title" style="clear: both">
<a name="configcgi"></a>3.6. <a name="config_cgi"></a>CGI Configuration File Options</h2></div></div></div>
<p><span class="bold"><strong>Notes</strong></span></p>
<p>When creating and/or editing configuration files, keep the following in mind:</p>
<div class="orderedlist"><ol class="orderedlist" type="1">
<li class="listitem">
<p>Lines that start with a '#' character are taken to be comments and are not processed</p>
</li>
<li class="listitem">
<p>Variables names must begin at the start of the line - no white space is allowed before the name</p>
</li>
<li class="listitem">
<p>Variable names are case-sensitive</p>
</li>
</ol></div>
<p><span class="bold"><strong>Sample Configuration</strong></span></p>
<div class="tip" title="Tip" style="margin-left: 0.5in; margin-right: 0.5in;"><table border="0" summary="Tip">
<tr>
<td rowspan="2" align="center" valign="top" width="25"><img alt="[Tip]" src="../images/tip.png"></td>
<th align="left">Tip</th>
</tr>
<tr><td align="left" valign="top">
<p>A sample CGI configuration file (<span class="emphasis"><em>/usr/local/icinga/etc/cgi.cfg</em></span>) is installed for you when you follow the
<a class="link" href="quickstart.html" title="2.3. Quickstart Installation Guides">quickstart installation guide</a>.</p>
</td></tr>
</table></div>
<p><span class="bold"><strong>Config File Location</strong></span></p>
<p>By default, Icinga expects the CGI configuration file to be named <span class="bold"><strong>cgi.cfg</strong></span> and located in the
config file directory along with the <a class="link" href="configmain.html" title="3.2. Main Configuration File Options">main config file</a>. If you need to change the name of the file or its
location, you can configure Apache to pass an environment variable named ICINGA_CGI_CONFIG (which points to the correct location) to the
CGIs. See the Apache documentation for information on how to do this.</p>
<p><span class="bold"><strong>Configuration File Variables</strong></span></p>
<p>Below you will find descriptions of each main Icinga configuration file option...</p>
<p><a name="configcgi-main_cfg_file"></a> <span class="bold"><strong>Main Configuration File Location</strong></span></p>
<div class="informaltable">
<table border="0">
<colgroup>
<col>
<col>
</colgroup>
<tbody>
<tr>
<td align="left" valign="top"><p>Format:</p></td>
<td><p><span class="bold"><strong>main_config_file=<file_name></strong></span></p></td>
</tr>
<tr>
<td align="left" valign="top"><p>Example:</p></td>
<td><p><span class="color"><font color="red"><span class="bold"><strong>main_config_file=/usr/local/icinga/etc/icinga.cfg</strong></span>
</font></span></p></td>
</tr>
</tbody>
</table>
</div>
<p>This specifies the location of your <a class="link" href="configmain.html" title="3.2. Main Configuration File Options">main configuration file</a>. The CGIs need to know where to find
this file in order to get information about configuration information, current host and service status, etc.</p>
<p><a name="configcgi-physical_html_path"></a> <span class="bold"><strong>Physical HTML Path</strong></span></p>
<div class="informaltable">
<table border="0">
<colgroup>
<col>
<col>
</colgroup>
<tbody>
<tr>
<td align="left" valign="top"><p>Format:</p></td>
<td><p><span class="bold"><strong>physical_html_path=<path></strong></span></p></td>
</tr>
<tr>
<td align="left" valign="top"><p>Example:</p></td>
<td><p><span class="color"><font color="red"><span class="bold"><strong>physical_html_path=/usr/local/icinga/share</strong></span>
</font></span></p></td>
</tr>
</tbody>
</table>
</div>
<p>This is the <span class="emphasis"><em>physical</em></span> path where the HTML files for Icinga are kept on your workstation or server.
Icinga assumes that the documentation and images files (used by the CGIs) are stored in subdirectories called
<span class="emphasis"><em>docs/</em></span> and <span class="emphasis"><em>images/</em></span>, respectively.</p>
<p><a name="configcgi-url_html_path"></a> <span class="bold"><strong>URL HTML Path</strong></span></p>
<div class="informaltable">
<table border="0">
<colgroup>
<col>
<col>
</colgroup>
<tbody>
<tr>
<td align="left" valign="top"><p>Format:</p></td>
<td><p><span class="bold"><strong>url_html_path=<path></strong></span></p></td>
</tr>
<tr>
<td align="left" valign="top"><p>Example:</p></td>
<td><p><span class="color"><font color="red"><span class="bold"><strong>url_html_path=/icinga</strong></span></font></span>
</p></td>
</tr>
</tbody>
</table>
</div>
<p>If, when accessing Icinga via a web browser, you point to an URL like <span class="bold"><strong>http://www.myhost.com/icinga</strong></span>, this value should be <span class="emphasis"><em>/icinga</em></span>. Basically, its the path portion of
the URL that is used to access the Icinga HTML pages.</p>
<p><a name="configcgi-url_cgi_path"></a> <span class="bold"><strong>URL CGI Path</strong></span></p>
<div class="informaltable">
<table border="0">
<colgroup>
<col>
<col>
</colgroup>
<tbody>
<tr>
<td align="left" valign="top"><p>Format:</p></td>
<td><p><span class="bold"><strong>url_cgi_path=<path></strong></span></p></td>
</tr>
<tr>
<td align="left" valign="top"><p>Example:</p></td>
<td><p><span class="color"><font color="red"><span class="bold"><strong>url_cgi_path=/icinga/cgi-bin</strong></span></font></span>
</p></td>
</tr>
</tbody>
</table>
</div>
<p>This is the path portion of the URL that corresponds to the <span class="emphasis"><em>physical</em></span> location of the Icinga CGI files. It is
evaluated by the cmd.cgi CSRF protection. This value should be changed if the CGI files are accessible under a different path than the default
installation path. If not set, the default location will be used (url_cgi_path=url_html_path/cgi-bin).</p>
<p><a name="configcgi-url_stylesheet_path"></a> <span class="bold"><strong>URL Stylesheet Path</strong></span></p>
<div class="informaltable">
<table border="0">
<colgroup>
<col>
<col>
</colgroup>
<tbody>
<tr>
<td align="left" valign="top"><p>Format:</p></td>
<td><p><span class="bold"><strong>url_stylesheet_path=<path>/stylesheets</strong></span></p></td>
</tr>
<tr>
<td align="left" valign="top"><p>Example:</p></td>
<td><p><span class="color"><font color="red"><span class="bold"><strong>url_stylesheet_path=/icinga/stylesheets</strong></span>
</font></span></p></td>
</tr>
</tbody>
</table>
</div>
<p>This option allows to define an url stylesheet path other than the default. This will be useful when adding custom stylesheets in
another location. If not set, the default location will be used (url_stylesheets_path=url_html_path/stylesheets).</p>
<p><a name="configcgi-use_authentication"></a> <span class="bold"><strong>Authentication Usage</strong></span></p>
<div class="informaltable">
<table border="0">
<colgroup>
<col>
<col>
</colgroup>
<tbody>
<tr>
<td align="left" valign="top"><p>Format:</p></td>
<td><p><span class="bold"><strong>use_authentication=[0/1]</strong></span></p></td>
</tr>
<tr>
<td align="left" valign="top"><p>Example:</p></td>
<td><p><span class="color"><font color="red"><span class="bold"><strong>use_authentication=1</strong></span></font></span>
</p></td>
</tr>
</tbody>
</table>
</div>
<p>This option controls whether or not the CGIs will use the authentication and authorisation functionality when determining what
information and commands users have access to. We would strongly suggest that you use the authentication functionality for the CGIs. If
you decide not to use authentication, make sure to remove the <a class="link" href="cgis.html#cgis-cmd_cgi">command CGI</a> to prevent unauthorised
users from issuing commands to Icinga. The CGI will not issue commands to Icinga if authentication is disabled, but we would
suggest removing it altogether just to be on the safe side. More information on how to setup authentication and configure authorisation
for the CGIs can be found <a class="link" href="cgiauth.html" title="6.2. Authentication And Authorization In The Classic UI">here</a>.</p>
<div class="itemizedlist"><ul class="itemizedlist" type="disc">
<li class="listitem">
<p>0 = Don't use authentication functionality</p>
</li>
<li class="listitem">
<p>1 = Use authentication and authorisation functionality (default)</p>
</li>
</ul></div>
<p><a name="configcgi-use_ssl_authentication"></a> <span class="bold"><strong>Use Client Certificates</strong></span></p>
<div class="informaltable">
<table border="0">
<colgroup>
<col>
<col>
</colgroup>
<tbody>
<tr>
<td align="left" valign="top"><p>Format:</p></td>
<td><p><span class="bold"><strong>use_ssl_authentication=[0/1]</strong></span></p></td>
</tr>
<tr>
<td align="left" valign="top"><p>Example:</p></td>
<td><p><span class="color"><font color="red"><span class="bold"><strong>use_ssl_authentication=0</strong></span></font></span>
</p></td>
</tr>
</tbody>
</table>
</div>
<p>This option controls whether the value of the web server environment variable <code class="literal">REMOTE_USER</code> or
<code class="literal">SSL_CLIENT_S_DN_CN</code> will be used. The name of the directive is a bit misleading because unless you set up the use of
client certificates the value has to be set to zero (0). Setting the value to one (1) requires "<code class="literal">SSLUserName
SSL_CLIENT_S_DN_CN</code>" and several other options in your web server config. Please consult your web server configuration
documentation for details.</p>
<div class="itemizedlist"><ul class="itemizedlist" type="disc">
<li class="listitem">
<p>0 = Use web server environment variable <code class="literal">REMOTE_USER</code> to get the user logged in. Don't use client certificates
(default)</p>
</li>
<li class="listitem">
<p>1 = Use web server environment variable <code class="literal">SSL_CLIENT_S_DN_CN</code> to get the user logged in. Use client
certificates</p>
</li>
</ul></div>
<p><a name="configcgi-default_user_name"></a> <span class="bold"><strong>Default User Name</strong></span></p>
<div class="informaltable">
<table border="0">
<colgroup>
<col>
<col>
</colgroup>
<tbody>
<tr>
<td align="left" valign="top"><p>Format:</p></td>
<td><p><span class="bold"><strong>default_user_name=<username></strong></span></p></td>
</tr>
<tr>
<td align="left" valign="top"><p>Example:</p></td>
<td><p><span class="color"><font color="red"><span class="bold"><strong>default_user_name=guest</strong></span></font></span>
</p></td>
</tr>
</tbody>
</table>
</div>
<p>Setting this variable will define a default username that can access the CGIs. This allows people within a secure domain (i.e.,
behind a firewall) to access the CGIs without necessarily having to authenticate to the web server. You may want to use this to avoid
having to use basic authentication if you are not using a secure server, as basic authentication transmits passwords in clear text over
the Internet.</p>
<p><span class="bold"><strong>Important:</strong></span> Do <span class="emphasis"><em>not</em></span> define a default username unless you are running a secure
web server and are sure that everyone who has access to the CGIs has been authenticated in some manner! If you define this variable,
anyone who has not authenticated to the web server will inherit all rights you assign to this user!</p>
<p><a name="configcgi-authorized_for_system_information"></a> <span class="bold"><strong>System/Process Information
Access</strong></span></p>
<div class="informaltable">
<table border="0">
<colgroup>
<col>
<col>
</colgroup>
<tbody>
<tr>
<td align="left" valign="top"><p>Format:</p></td>
<td><p><span class="bold"><strong>authorized_for_system_information=<user1>,<user2>,<user3>,...<usern></strong></span>
</p></td>
</tr>
<tr>
<td align="left" valign="top"><p>Example:</p></td>
<td><p><span class="color"><font color="red"><span class="bold"><strong>authorized_for_system_information=icingaadmin,theboss</strong></span></font></span></p></td>
</tr>
</tbody>
</table>
</div>
<p>This is a comma-delimited list of names of <span class="emphasis"><em>authenticated users</em></span> who can view system/process information in the
<a class="link" href="cgis.html#cgis-extinfo_cgi">extended information CGI</a>. Users in this list are <span class="emphasis"><em>not</em></span> automatically authorised
to issue system/process commands. If you want users to be able to issue system/process commands as well, you must add them to the <a class="link" href="configcgi.html#configcgi-authorized_for_system_commands">authorized_for_system_commands</a> variable. More information on how to setup
authentication and configure authorisation for the CGIs can be found <a class="link" href="cgiauth.html" title="6.2. Authentication And Authorization In The Classic UI">here</a>. You can alternatively specify
<code class="literal">authorized_contactgroup_for_system_information</code> to authorise a contactgroup instead of a contact.</p>
<p><a name="configcgi-authorized_for_system_commands"></a> <span class="bold"><strong>System/Process Command Access</strong></span></p>
<div class="informaltable">
<table border="0">
<colgroup>
<col>
<col>
</colgroup>
<tbody>
<tr>
<td align="left" valign="top"><p>Format:</p></td>
<td><p><span class="bold"><strong>authorized_for_system_commands=<user1>,<user2>,<user3>,...<usern></strong></span></p></td>
</tr>
<tr>
<td align="left" valign="top"><p>Example:</p></td>
<td><p><span class="color"><font color="red"><span class="bold"><strong>authorized_for_system_commands=icingaadmin</strong></span>
</font></span></p></td>
</tr>
</tbody>
</table>
</div>
<p>This is a comma-delimited list of names of <span class="emphasis"><em>authenticated users</em></span> who can issue system/process commands via the
<a class="link" href="cgis.html#cgis-cmd_cgi">command CGI</a>. Users in this list are <span class="emphasis"><em>not</em></span> automatically authorised to view
system/process information. If you want users to be able to view system/process information as well, you must add them to the <a class="link" href="configcgi.html#configcgi-authorized_for_system_information">authorized_for_system_information</a> variable. More information on how to setup
authentication and configure authorisation for the CGIs can be found <a class="link" href="cgiauth.html" title="6.2. Authentication And Authorization In The Classic UI">here</a>. You can alternatively specify
<code class="literal">authorized_contactgroup_for_system_commands</code> to authorise a contactgroup instead of a contact.</p>
<p><a name="configcgi-authorized_for_configuration_information"></a> <span class="bold"><strong>Configuration Information
Access</strong></span></p>
<div class="informaltable">
<table border="0">
<colgroup>
<col>
<col>
</colgroup>
<tbody>
<tr>
<td align="left" valign="top"><p>Format:</p></td>
<td><p><span class="bold"><strong>authorized_for_configuration_information=<user1>,<user2>,<user3>,...<usern></strong></span>
</p></td>
</tr>
<tr>
<td align="left" valign="top"><p>Example:</p></td>
<td><p><span class="color"><font color="red"><span class="bold"><strong>authorized_for_configuration_information=icingaadmin</strong></span></font></span></p></td>
</tr>
</tbody>
</table>
</div>
<p>This is a comma-delimited list of names of <span class="emphasis"><em>authenticated users</em></span> who can view configuration information in the
<a class="link" href="cgis.html#cgis-config_cgi">configuration CGI</a>. Users in this list can view information on all configured hosts, host groups,
services, contacts, contact groups, time periods, and commands. More information on how to setup authentication and configure
authorisation for the CGIs can be found <a class="link" href="cgiauth.html" title="6.2. Authentication And Authorization In The Classic UI">here</a>. You can alternatively specify
<code class="literal">authorized_contactgroup_for_configuration_information</code> to authorise a contactgroup instead of a contact.</p>
<p><a name="configcgi-authorized_for_all_hosts"></a> <span class="bold"><strong>Global Host Information Access</strong></span></p>
<div class="informaltable">
<table border="0">
<colgroup>
<col>
<col>
</colgroup>
<tbody>
<tr>
<td align="left" valign="top"><p>Format:</p></td>
<td><p><span class="bold"><strong>authorized_for_all_hosts=<user1>,<user2>,<user3>,...<usern></strong></span>
</p></td>
</tr>
<tr>
<td align="left" valign="top"><p>Example:</p></td>
<td><p><span class="color"><font color="red"><span class="bold"><strong>authorized_for_all_hosts=icingaadmin,theboss</strong></span></font></span></p></td>
</tr>
</tbody>
</table>
</div>
<p>This is a comma-delimited list of names of <span class="emphasis"><em>authenticated users</em></span> who can view status and configuration
information for all hosts. Users in this list are also automatically authorised to view information for all services. Users in this list
are <span class="emphasis"><em>not</em></span> automatically authorised to issue commands for all hosts or services. If you want users able to issue
commands for all hosts and services as well, you must add them to the <a class="link" href="configcgi.html#configcgi-authorized_for_all_host_commands">authorized_for_all_host_commands</a> variable. More information on how to setup
authentication and configure authorisation for the CGIs can be found <a class="link" href="cgiauth.html" title="6.2. Authentication And Authorization In The Classic UI">here</a>. You can alternatively specify
<code class="literal">authorized_contactgroup_for_all_hosts</code> to authorise a contactgroup instead of a contact.</p>
<p><a name="configcgi-authorized_for_all_host_commands"></a> <span class="bold"><strong>Global Host Command Access</strong></span></p>
<div class="informaltable">
<table border="0">
<colgroup>
<col>
<col>
</colgroup>
<tbody>
<tr>
<td align="left" valign="top"><p>Format:</p></td>
<td><p><span class="bold"><strong>authorized_for_all_host_commands=<user1>,<user2>,<user3>,...<usern></strong></span></p></td>
</tr>
<tr>
<td align="left" valign="top"><p>Example:</p></td>
<td><p><span class="color"><font color="red"><span class="bold"><strong>authorized_for_all_host_commands=icingaadmin</strong></span></font></span></p></td>
</tr>
</tbody>
</table>
</div>
<p>This is a comma-delimited list of names of <span class="emphasis"><em>authenticated users</em></span> who can issue commands for all hosts via the
<a class="link" href="cgis.html#cgis-cmd_cgi">command CGI</a>. Users in this list are also automatically authorised to issue commands for all services.
Users in this list are <span class="emphasis"><em>not</em></span> automatically authorised to view status or configuration information for all hosts or
services. If you want users able to view status and configuration information for all hosts and services as well, you must add them to the
<a class="link" href="configcgi.html#configcgi-authorized_for_all_hosts">authorized_for_all_hosts</a> variable. More information on how to setup
authentication and configure authorisation for the CGIs can be found <a class="link" href="cgiauth.html" title="6.2. Authentication And Authorization In The Classic UI">here</a>. You can alternatively specify
<code class="literal">authorized_contactgroup_for_all_host_commands</code> to authorise a contactgroup instead of a contact.</p>
<p><a name="configcgi-authorized_for_all_services"></a> <span class="bold"><strong>Global Service Information Access</strong></span></p>
<div class="informaltable">
<table border="0">
<colgroup>
<col>
<col>
</colgroup>
<tbody>
<tr>
<td align="left" valign="top"><p>Format:</p></td>
<td><p><span class="bold"><strong>authorized_for_all_services=<user1>,<user2>,<user3>,...<usern></strong></span></p></td>
</tr>
<tr>
<td align="left" valign="top"><p>Example:</p></td>
<td><p><span class="color"><font color="red"><span class="bold"><strong>authorized_for_all_services=icingaadmin,theboss</strong></span></font></span></p></td>
</tr>
</tbody>
</table>
</div>
<p>This is a comma-delimited list of names of <span class="emphasis"><em>authenticated users</em></span> who can view status and configuration
information for all services. Users in this list are <span class="emphasis"><em>not</em></span> automatically authorised to view information for all hosts.
Users in this list are <span class="emphasis"><em>not</em></span> automatically authorised to issue commands for all services. If you want users able to
issue commands for all services as well, you must add them to the <a class="link" href="configcgi.html#configcgi-authorized_for_all_service_commands">authorized_for_all_service_commands</a> variable. More information on how to
setup authentication and configure authorisation for the CGIs can be found <a class="link" href="cgiauth.html" title="6.2. Authentication And Authorization In The Classic UI">here</a>. You can alternatively
specify <code class="literal">authorized_contactgroup_for_all_services</code> to authorise a contactgroup instead of a contact.</p>
<p><a name="configcgi-authorized_for_all_service_commands"></a> <span class="bold"><strong>Global Service Command Access
</strong></span></p>
<div class="informaltable">
<table border="0">
<colgroup>
<col>
<col>
</colgroup>
<tbody>
<tr>
<td align="left" valign="top"><p>Format:</p></td>
<td><p><span class="bold"><strong>authorized_for_all_service_commands=<user1>,<user2>,<user3>,...<usern></strong></span>
</p></td>
</tr>
<tr>
<td align="left" valign="top"><p>Example:</p></td>
<td><p><span class="color"><font color="red"><span class="bold"><strong>authorized_for_all_service_commands=icingaadmin</strong></span></font></span></p></td>
</tr>
</tbody>
</table>
</div>
<p>This is a comma-delimited list of names of <span class="emphasis"><em>authenticated users</em></span> who can issue commands for all services via the
<a class="link" href="cgis.html#cgis-cmd_cgi">command CGI</a>. Users in this list are <span class="emphasis"><em>not</em></span> automatically authorised to issue
commands for all hosts. Users in this list are <span class="emphasis"><em>not</em></span> automatically authorised to view status or configuration
information for all hosts. If you want users able to view status and configuration information for all services as well, you must add them
to the <a class="link" href="configcgi.html#configcgi-authorized_for_all_services">authorized_for_all_services</a> variable. More information on how to setup
authentication and configure authorisation for the CGIs can be found <a class="link" href="cgiauth.html" title="6.2. Authentication And Authorization In The Classic UI">here</a>. You can alternatively specify
<code class="literal">authorized_contactgroup_for_all_service_commands</code> to authorise a contactgroup instead of a contact.</p>
<p><a name="configcgi-show_all_services_host_is_authorized_for"></a> <span class="bold"><strong>Show All Services A Host Is Authorized
For</strong></span></p>
<div class="informaltable">
<table border="0">
<colgroup>
<col>
<col>
</colgroup>
<tbody>
<tr>
<td align="left" valign="top"><p>Format:</p></td>
<td><p><span class="bold"><strong>show_all_services_host_is_authorized_for=[0|1]</strong></span></p></td>
</tr>
<tr>
<td align="left" valign="top"><p>Example:</p></td>
<td><p><span class="color"><font color="red"><span class="bold"><strong>show_all_services_host_is_authorized_for=1</strong></span>
</font></span></p></td>
</tr>
</tbody>
</table>
</div>
<p>By default, a user can see all services on a host, if the user is authorised as contact for the host only. By disabling this option,
the user must be an authorised contact for the service too in order to view it. Keep in mind that setting the user in
authorized_for_all_services obsoletes this option.</p>
<p><a name="configcgi-authorized_for_read_only"></a> <span class="bold"><strong>Deny Access To Commands And Comments</strong></span></p>
<div class="informaltable">
<table border="0">
<colgroup>
<col>
<col>
</colgroup>
<tbody>
<tr>
<td align="left" valign="top"><p>Format:</p></td>
<td><p><span class="bold"><strong>authorized_for_read_only=<user1>,<user2>,<user3>,...<usern></strong></span>
</p></td>
</tr>
<tr>
<td align="left" valign="top"><p>Example:</p></td>
<td><p><span class="color"><font color="red"><span class="bold"><strong>authorized_for_read_only=icingalook</strong></span>
</font></span></p></td>
</tr>
</tbody>
</table>
</div>
<p>This is a comma-delimited list of names of <span class="emphasis"><em>authenticated users</em></span> who have read-only rights in the CGIs. This will
block any host or service commands. It will also block comments from being shown to read-only users. Users in this list are
<span class="emphasis"><em>not</em></span> automatically authorised to view status or configuration information for all hosts. If you want users able to
view status and configuration information for all services as well, you must add them to the <a class="link" href="configcgi.html#configcgi-authorized_for_all_services">authorized_for_all_services</a> variable. More information on how to setup
authentication and configure authorisation for the CGIs can be found <a class="link" href="cgiauth.html" title="6.2. Authentication And Authorization In The Classic UI">here</a>. You can alternatively specify
<code class="literal">authorized_contactgroup_for_read_only</code> to authorise a contactgroup instead of a contact.</p>
<p><a name="configcgi-authorized_for_comments_read_only"></a> <span class="bold"><strong>Read-Only For Comments</strong></span></p>
<div class="informaltable">
<table border="0">
<colgroup>
<col>
<col>
<col>
</colgroup>
<tbody>
<tr>
<td align="left" valign="top"><p>Format:</p></td>
<td><p><span class="bold"><strong>authorized_for_comments_read_only=<user1>,<user2>,<user3>,...<usern></strong></span></p></td>
<td><p><span class="bold"><strong>authorized_contactgroup_for_comments_read_only=<contactgroup1>,<contactgroup2>,...<contactgroupn></strong></span></p></td>
</tr>
<tr>
<td align="left" valign="top"><p>Example:</p></td>
<td><p><span class="color"><font color="red"><span class="bold"><strong>authorized_for_comments_read_only=icingalook</strong></span></font></span> </p></td>
<td><p><span class="color"><font color="red"><span class="bold"><strong>authorized_contactgroup_for_comments_read_only=readonlyusers</strong></span></font></span> </p></td>
</tr>
</tbody>
</table>
</div>
<p>This is comma-delimited list of usernames or contactgroups that have rights to view comments in the CGIs. If the user/contactgroup
is defined as read-only and you add the same user/contactgroup to this option, then the user/contactgroup can see the comments. If the
user is NOT read-only then the options to delete comments in extinfo.cgi are not displayed as well.</p>
<div class="note" title="Note" style="margin-left: 0.5in; margin-right: 0.5in;"><table border="0" summary="Note">
<tr>
<td rowspan="2" align="center" valign="top" width="25"><img alt="[Note]" src="../images/note.png"></td>
<th align="left">Note</th>
</tr>
<tr><td align="left" valign="top">
<p>This option is available starting with Icinga 1.8</p>
</td></tr>
</table></div>
<p><a name="configcgi-authorized_for_downtimes_read_only"></a> <span class="bold"><strong>Read-Only For Downtimes</strong></span></p>
<div class="informaltable">
<table border="0">
<colgroup>
<col>
<col>
<col>
</colgroup>
<tbody>
<tr>
<td align="left" valign="top"><p>Format:</p></td>
<td><p><span class="bold"><strong>authorized_for_downtimes_read_only=<user1>,<user2>,<user3>,...<usern>
</strong></span></p></td>
<td><p><span class="bold"><strong>authorized_contactgroup_for_downtimes_read_only=<contactgroup1>,<contactgroup2>,...<contactgroupn></strong></span></p></td>
</tr>
<tr>
<td align="left" valign="top"><p>Example:</p></td>
<td><p><span class="color"><font color="red"><span class="bold"><strong>authorized_for_downtimes_read_only=icingalook</strong></span></font></span> </p></td>
<td><p><span class="color"><font color="red"><span class="bold"><strong>authorized_contactgroup_for_downtimes_read_only=readonlyusers</strong></span></font></span> </p></td>
</tr>
</tbody>
</table>
</div>
<p>This is a comma-delimited list of usernames or contactgroups that have rights to view downtimes in the CGIs. If the user is defined
as read-only and you add the same user/contactgroup to this options, then the user/contactgroup can still see downtimes. If the user is
NOT read-only then the options to delete downtimes in extinfo.cgi are not displayed as well.</p>
<div class="note" title="Note" style="margin-left: 0.5in; margin-right: 0.5in;"><table border="0" summary="Note">
<tr>
<td rowspan="2" align="center" valign="top" width="25"><img alt="[Note]" src="../images/note.png"></td>
<th align="left">Note</th>
</tr>
<tr><td align="left" valign="top">
<p>This option is available starting with Icinga 1.8</p>
</td></tr>
</table></div>
<p><a name="configcgi-lock_author_names"></a> <span class="bold"><strong>Lock Author Names</strong></span></p>
<div class="informaltable">
<table border="0">
<colgroup>
<col>
<col>
</colgroup>
<tbody>
<tr>
<td align="left" valign="top"><p>Format:</p></td>
<td><p><span class="bold"><strong>lock_author_names=[0/1]</strong></span></p></td>
</tr>
<tr>
<td align="left" valign="top"><p>Example:</p></td>
<td><p><span class="color"><font color="red"><span class="bold"><strong>lock_author_names=1</strong></span></font></span>
</p></td>
</tr>
</tbody>
</table>
</div>
<p>This option allows you to restrict users from changing the author name when submitting comments, acknowledgements, and scheduled
downtime from the web interface. If this option is enabled, users will be unable to change the author name associated with the command
request.</p>
<div class="itemizedlist"><ul class="itemizedlist" type="disc">
<li class="listitem">
<p>0 = Allow users to change author names when submitting commands</p>
</li>
<li class="listitem">
<p>1 = Prevent users from changing author names (default)</p>
</li>
</ul></div>
<p><a name="configcgi-default_expiring_disabled_notifictions_duration"></a> <span class="bold"><strong>Default Expiring Disabled
Notifications Duration</strong></span></p>
<div class="informaltable">
<table border="0">
<colgroup>
<col>
<col>
</colgroup>
<tbody>
<tr>
<td align="left" valign="top"><p>Format:</p></td>
<td><p><span class="bold"><strong>default_expiring_disabled_notifications_duration=[seconds]</strong></span> </p></td>
</tr>
<tr>
<td align="left" valign="top"><p>Example:</p></td>
<td><p><span class="color"><font color="red"><span class="bold"><strong><span class="bold"><strong>default_expiring_disabled_notifications_duration=86400</strong></span> </strong></span></font></span></p></td>
</tr>
</tbody>
</table>
</div>
<p>This option defines the default duration (in seconds) of an expiring for global disabled notifications. Default is 86400 seconds (1
day).</p>
<div class="note" title="Note" style="margin-left: 0.5in; margin-right: 0.5in;"><table border="0" summary="Note">
<tr>
<td rowspan="2" align="center" valign="top" width="25"><img alt="[Note]" src="../images/note.png"></td>
<th align="left">Note</th>
</tr>
<tr><td align="left" valign="top">
<p>This option is available starting with Icinga 1.8</p>
</td></tr>
</table></div>
<p><a name="configcgi-status_show_long_plugin_output"></a> <span class="bold"><strong>Status Show Long Plugin Output</strong></span></p>
<div class="informaltable">
<table border="0">
<colgroup>
<col>
<col>
</colgroup>
<tbody>
<tr>
<td align="left" valign="top"><p>Format:</p></td>
<td><p><span class="bold"><strong>status_show_long_plugin_output=[0/1]</strong></span></p></td>
</tr>
<tr>
<td align="left" valign="top"><p>Example:</p></td>
<td><p><span class="color"><font color="red"><span class="bold"><strong>status_show_long_plugin_output=1</strong></span>
</font></span></p></td>
</tr>
</tbody>
</table>
</div>
<p>This option allows you to specify the length of status information in output of status.cgi. If you set the value to 1 it shows the
full plugin output instead of the first line only. Default value is 0.</p>
<div class="itemizedlist"><ul class="itemizedlist" type="disc">
<li class="listitem">
<p>0 = Display only the first line of plugin output (default)</p>
</li>
<li class="listitem">
<p>1 = Display the complete plugin output</p>
</li>
</ul></div>
<p><a name="configcgi-statusmap_background_image"></a> <span class="bold"><strong>Statusmap CGI Background Image</strong></span></p>
<div class="informaltable">
<table border="0">
<colgroup>
<col>
<col>
</colgroup>
<tbody>
<tr>
<td align="left" valign="top"><p>Format:</p></td>
<td><p><span class="bold"><strong>statusmap_background_image=<image_file></strong></span></p></td>
</tr>
<tr>
<td align="left" valign="top"><p>Example:</p></td>
<td><p><span class="color"><font color="red"><span class="bold"><strong>statusmap_background_image=smbackground.gd2</strong></span>
</font></span></p></td>
</tr>
</tbody>
</table>
</div>
<p>This option allows you to specify an image to be used as a background in the <a class="link" href="cgis.html#cgis-statusmap_cgi">statusmap CGI</a>
if you use the user-supplied coordinates layout method. The background image is not be available in any other layout methods. It is
assumed that the image resides in the HTML images path (i.e. /usr/local/icinga/share/images). This path is automatically determined by
appending "/images" to the path specified by the <a class="link" href="configcgi.html#configcgi-physical_html_path">physical_html_path</a> directive.</p>
<div class="note" title="Note" style="margin-left: 0.5in; margin-right: 0.5in;"><table border="0" summary="Note">
<tr>
<td rowspan="2" align="center" valign="top" width="25"><img alt="[Note]" src="../images/note.png"></td>
<th align="left">Note</th>
</tr>
<tr><td align="left" valign="top">
<p>The image file can be in GIF, JPEG, PNG, or GD2 format. However, GD2 format (preferably in uncompressed format) is recommended, as
it will reduce the CPU load when the CGI generates the map image.</p>
</td></tr>
</table></div>
<p><a name="configcgi-color_transparency_index"></a> <span class="bold"><strong>Statusmap Transparency Index Colour</strong></span></p>
<div class="informaltable">
<table border="0">
<colgroup>
<col>
<col>
</colgroup>
<tbody>
<tr>
<td align="left" valign="top"><p>Format:</p></td>
<td>
<p>
<span class="bold"><strong>color_transparency_index_r=<0...255></strong></span>
</p> <p>
<span class="bold"><strong>color_transparency_index_g=<0...255></strong></span>
</p> <p>
<span class="bold"><strong>color_transparency_index_b=<0...255></strong></span>
</p>
</td>
</tr>
<tr>
<td align="left" valign="top"><p>Example:</p></td>
<td><p><span class="color"><font color="red"><span class="bold"><strong>color_transparency_index_r=255</strong></span>
</font></span></p></td>
</tr>
</tbody>
</table>
</div>
<p>These options set the r,g,b values of the background colour used for the statusmap CGI, so normal browsers that can't show real png
transparency set the desired colour as a background colour instead (to make it look pretty). Defaults to white: (R,G,B) =
(255,255,255).</p>
<p><a name="configcgi-default_statusmap_layout"></a> <span class="bold"><strong>Default Statusmap Layout Method</strong></span></p>
<div class="informaltable">
<table border="0">
<colgroup>
<col>
<col>
</colgroup>
<tbody>
<tr>
<td align="left" valign="top"><p>Format:</p></td>
<td><p><span class="bold"><strong>default_statusmap_layout=<layout_number></strong></span></p></td>
</tr>
<tr>
<td align="left" valign="top"><p>Example:</p></td>
<td><p><span class="color"><font color="red"><span class="bold"><strong>default_statusmap_layout=4</strong></span></font></span>
</p></td>
</tr>
</tbody>
</table>
</div>
<p>This option allows you to specify the default layout method used by the <a class="link" href="cgis.html#cgis-statusmap_cgi">statusmap CGI</a>.
Valid options are:</p>
<div class="informaltable">
<table border="1">
<colgroup>
<col>
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="bold"><strong><layout_number> Value</strong></span></p></td>
<td><p><span class="bold"><strong>Layout Method</strong></span></p></td>
</tr>
<tr>
<td><p>0</p></td>
<td><p>User-defined coordinates</p></td>
</tr>
<tr>
<td><p>1</p></td>
<td><p>Depth layers</p></td>
</tr>
<tr>
<td><p>2</p></td>
<td><p>Collapsed tree</p></td>
</tr>
<tr>
<td><p>3</p></td>
<td><p>Balanced tree</p></td>
</tr>
<tr>
<td><p>4</p></td>
<td><p>Circular</p></td>
</tr>
<tr>
<td><p>5</p></td>
<td><p>Circular (Marked Up)</p></td>
</tr>
<tr>
<td><p>6</p></td>
<td><p>Circular (Balloon)</p></td>
</tr>
</tbody>
</table>
</div>
<p><a name="configcgi-refresh_rate"></a> <span class="bold"><strong>CGI Refresh Rate</strong></span></p>
<div class="informaltable">
<table border="0">
<colgroup>
<col>
<col>
</colgroup>
<tbody>
<tr>
<td align="left" valign="top"><p>Format:</p></td>
<td><p><span class="bold"><strong>refresh_rate=<rate_in_seconds></strong></span></p></td>
</tr>
<tr>
<td align="left" valign="top"><p>Example:</p></td>
<td><p><span class="color"><font color="red"><span class="bold"><strong>refresh_rate=90</strong></span></font></span></p></td>
</tr>
</tbody>
</table>
</div>
<p>This option allows you to specify the number of seconds between page refreshes for the <a class="link" href="cgis.html#cgis-status_cgi">status</a>, <a class="link" href="cgis.html#cgis-statusmap_cgi">statusmap</a>, and <a class="link" href="cgis.html#cgis-extinfo_cgi">extinfo</a> CGIs.</p>
<p><a name="configcgi-refresh_type"></a> <span class="bold"><strong>CGI Refresh Type</strong></span></p>
<div class="informaltable">
<table border="0">
<colgroup>
<col>
<col>
</colgroup>
<tbody>
<tr>
<td align="left" valign="top"><p>Format:</p></td>
<td><p><span class="bold"><strong>refresh_type=<0|1></strong></span></p></td>
</tr>
<tr>
<td align="left" valign="top"><p>Example:</p></td>
<td><p><span class="color"><font color="red"><span class="bold"><strong>refresh_type=1</strong></span></font></span></p></td>
</tr>
</tbody>
</table>
</div>
<p>This option determines what type of refresh should be used. You can choose between http header and javascript. By default javascript
(1) is activated. If you have trouble using javascript then try refresh via http header (0).</p>
<p><a name="configcgi-audio_alerts"></a> <span class="bold"><strong>Audio Alerts</strong></span></p>
<div class="informaltable">
<table border="0">
<colgroup>
<col>
<col>
</colgroup>
<tbody>
<tr>
<td align="left" valign="top"><p>Formats:</p></td>
<td>
<p><span class="bold"><strong>host_unreachable_sound=<sound_file></strong></span></p>
<p><span class="bold"><strong>host_down_sound=<sound_file></strong></span></p>
<p><span class="bold"><strong>service_critical_sound=<sound_file></strong></span></p>
<p><span class="bold"><strong>service_warning_sound=<sound_file></strong></span></p>
<p><span class="bold"><strong>service_unknown_sound=<sound_file></strong></span></p>
<p><span class="bold"><strong>normal_sound=<sound_file></strong></span></p>
</td>
</tr>
<tr>
<td align="left" valign="top"><p>Examples:</p></td>
<td>
<p><span class="color"><font color="red"><span class="bold"><strong>host_unreachable_sound=hostu.wav</strong></span></font></span></p>
<p><span class="color"><font color="red"><span class="bold"><strong>host_down_sound=hostd.wav</strong></span></font></span></p>
<p><span class="color"><font color="red"><span class="bold"><strong>service_critical_sound=critical.wav</strong></span></font></span></p>
<p><span class="color"><font color="red"><span class="bold"><strong>service_warning_sound=warning.wav</strong></span></font></span></p>
<p><span class="color"><font color="red"><span class="bold"><strong>service_unknown_sound=unknown.wav</strong></span></font></span></p>
<p><span class="color"><font color="red"><span class="bold"><strong>normal_sound=noproblem.wav</strong></span></font></span></p>
</td>
</tr>
</tbody>
</table>
</div>
<p>These options allow you to specify an audio file that should be played in your browser if there are problems when you are viewing
the <a class="link" href="cgis.html#cgis-status_cgi">status CGI</a>. If there are problems, the audio file for the most critical type of problem will be
played. The most critical type of problem is on or more unreachable hosts, while the least critical is one or more services in an unknown
state (see the order in the example above). Audio files are assumed to be in the <span class="bold"><strong>media/</strong></span> subdirectory in
your HTML directory (i.e. <span class="emphasis"><em>/usr/local/icinga/share/media</em></span>).</p>
<p><a name="configcgi-escape_html_tags"></a> <span class="bold"><strong>Escape HTML Tags Option</strong></span></p>
<div class="informaltable">
<table border="0">
<colgroup>
<col>
<col>
</colgroup>
<tbody>
<tr>
<td align="left" valign="top"><p>Format:</p></td>
<td><p><span class="bold"><strong>escape_html_tags=[0/1]</strong></span></p></td>
</tr>
<tr>
<td align="left" valign="top"><p>Example:</p></td>
<td><p><span class="color"><font color="red"><span class="bold"><strong>escape_html_tags=1</strong></span></font></span> </p></td>
</tr>
</tbody>
</table>
</div>
<p>This option determines whether or not HTML tags in host and service (plugin) output is escaped in the CGIs. If you enable this
option, your plugin output will not be able to contain clickable hyperlinks.</p>
<p><a name="configcgi-notes_url_target"></a> <span class="bold"><strong>Notes URL Target</strong></span></p>
<div class="informaltable">
<table border="0">
<colgroup>
<col>
<col>
</colgroup>
<tbody>
<tr>
<td align="left" valign="top"><p>Format:</p></td>
<td><p><span class="bold"><strong>notes_url_target=[target]</strong></span></p></td>
</tr>
<tr>
<td align="left" valign="top"><p>Example:</p></td>
<td><p><span class="color"><font color="red"><span class="bold"><strong>notes_url_target=_blank</strong></span></font></span>
</p></td>
</tr>
</tbody>
</table>
</div>
<p>This option determines the name of the frame target that notes URLs should be displayed in. Valid options include
<span class="emphasis"><em>_blank</em></span>, <span class="emphasis"><em>_self</em></span>, <span class="emphasis"><em>_top</em></span>, <span class="emphasis"><em>_parent</em></span>, or any other valid
target name.</p>
<p><a name="configcgi-action_url_target"></a> <span class="bold"><strong>Action URL Target</strong></span></p>
<div class="informaltable">
<table border="0">
<colgroup>
<col>
<col>
</colgroup>
<tbody>
<tr>
<td align="left" valign="top"><p>Format:</p></td>
<td><p><span class="bold"><strong>action_url_target=[target]</strong></span></p></td>
</tr>
<tr>
<td align="left" valign="top"><p>Example:</p></td>
<td><p><span class="color"><font color="red"><span class="bold"><strong>action_url_target=_blank</strong></span></font></span>
</p></td>
</tr>
</tbody>
</table>
</div>
<p>This option determines the name of the frame target that action URLs should be displayed in. Valid options include
<span class="emphasis"><em>_blank</em></span>, <span class="emphasis"><em>_self</em></span>, <span class="emphasis"><em>_top</em></span>, <span class="emphasis"><em>_parent</em></span>, or any other valid
target name.</p>
<p><a name="configcgi-show_only_hard_states"></a><span class="bold"><strong>Tac Show Only Hard State</strong></span></p>
<div class="informaltable">
<table border="0">
<colgroup>
<col>
<col>
</colgroup>
<tbody>
<tr>
<td align="left" valign="top"><p>Format:</p></td>
<td><p><span class="bold"><strong>tac_show_only_hard_state=[0/1]</strong></span></p></td>
</tr>
<tr>
<td align="left" valign="top"><p>Example:</p></td>
<td><p><span class="color"><font color="red"><span class="bold"><strong>tac_show_only_hard_state=1</strong></span></font></span>
</p></td>
</tr>
</tbody>
</table>
</div>
<p>This option allows you to specify if the tactical overview should only show hard states on hosts and services. If you set this
option to 1 the tactical overview shows only states on hosts and services. By default disabled, all states will be shown.</p>
<p><a name="configcgi-enable_splunk_integration"></a> <span class="bold"><strong>Splunk Integration Option</strong></span></p>
<div class="informaltable">
<table border="0">
<colgroup>
<col>
<col>
</colgroup>
<tbody>
<tr>
<td align="left" valign="top"><p>Format:</p></td>
<td><p><span class="bold"><strong>enable_splunk_integration=[0/1]</strong></span></p></td>
</tr>
<tr>
<td align="left" valign="top"><p>Example:</p></td>
<td><p><span class="color"><font color="red"><span class="bold"><strong>enable_splunk_integration=1</strong></span></font></span>
</p></td>
</tr>
</tbody>
</table>
</div>
<p>This option determines whether integration functionality with Splunk is enabled in the web interface. If enabled, you'll be
presented with "Splunk It" links in various places in the CGIs (log file, alert history, host/service detail, etc). Useful if you're
trying to research why a particular problem occurred. For more information on Splunk, visit <a class="link" href="http://www.splunk.com/" target="_top">http://www.splunk.com/</a>.</p>
<p><a name="configcgi-splunk_url"></a> <span class="bold"><strong>Splunk URL</strong></span></p>
<div class="informaltable">
<table border="0">
<colgroup>
<col>
<col>
</colgroup>
<tbody>
<tr>
<td align="left" valign="top"><p>Format:</p></td>
<td><p><span class="bold"><strong>splunk_url=<path></strong></span></p></td>
</tr>
<tr>
<td align="left" valign="top"><p>Example:</p></td>
<td><p><span class="color"><font color="red"><span class="bold"><strong>splunk_url=http://127.0.0.1:8000/</strong></span>
</font></span></p></td>
</tr>
</tbody>
</table>
</div>
<p>This option is used to define the base URL to your Splunk interface. This URL is used by the CGIs when creating links if the <a class="link" href="configcgi.html#configcgi-enable_splunk_integration">enable_splunk_integration</a> option is enabled.</p>
<p><a name="configcgi-persistent_ack_comments"></a> <span class="bold"><strong>Persistent Acknowledge Comments</strong></span></p>
<div class="informaltable">
<table border="0">
<colgroup>
<col>
<col>
</colgroup>
<tbody>
<tr>
<td align="left" valign="top"><p>Format:</p></td>
<td><p><span class="bold"><strong>persistent_ack_comments=<0|1></strong></span></p></td>
</tr>
<tr>
<td align="left" valign="top"><p>Example:</p></td>
<td><p><span class="color"><font color="red"><span class="bold"><strong>persistent_ack_comments=1</strong></span></font></span>
</p></td>
</tr>
</tbody>
</table>
</div>
<p>This option controls the initial state of the check box "persistent comment" to acknowledge problem hosts or services. It can be
used to reinstate the behaviour of Nagios 2. Default is "0" to be compatible with Nagios 3.</p>
<div class="itemizedlist"><ul class="itemizedlist" type="disc">
<li class="listitem">
<p>0 = Leave check box "persistent comment" unchecked (default)</p>
</li>
<li class="listitem">
<p>1 = Set check box "persistent comment"</p>
</li>
</ul></div>
<p><a name="configcgi-csv_delimiter"></a> <span class="bold"><strong>Set field separator for CSV export</strong></span></p>
<div class="informaltable">
<table border="0">
<colgroup>
<col>
<col>
</colgroup>
<tbody>
<tr>
<td align="left" valign="top"><p>Format:</p></td>
<td><p><span class="bold"><strong>csv_delimiter=<char></strong></span></p></td>
</tr>
<tr>
<td align="left" valign="top"><p>Example:</p></td>
<td><p><span class="color"><font color="red"><span class="bold"><strong>csv_delimiter=,</strong></span></font></span> </p></td>
</tr>
</tbody>
</table>
</div>
<p>This option determines the character which should act as field separator. Default is a semicolon (;).</p>
<p><a name="configcgi-csv_data_enclosure"></a> <span class="bold"><strong>Set field enclosure character for CSV export</strong></span></p>
<div class="informaltable">
<table border="0">
<colgroup>
<col>
<col>
</colgroup>
<tbody>
<tr>
<td align="left" valign="top"><p>Format:</p></td>
<td><p><span class="bold"><strong>csv_data_enclosure=<char></strong></span></p></td>
</tr>
<tr>
<td align="left" valign="top"><p>Example:</p></td>
<td><p><span class="color"><font color="red"><span class="bold"><strong>csv_data_enclosure='</strong></span></font></span>
</p></td>
</tr>
</tbody>
</table>
</div>
<p>This option determines the character which should be used to enclose fields. Default is a single quote (').</p>
<p><a name="configcgi-showlog_initial_states"></a> <span class="bold"><strong>Show initial states</strong></span></p>
<div class="informaltable">
<table border="0">
<colgroup>
<col>
<col>
</colgroup>
<tbody>
<tr>
<td align="left" valign="top"><p>Format:</p></td>
<td><p><span class="bold"><strong>showlog_initial_states=<0|1></strong></span></p></td>
</tr>
<tr>
<td align="left" valign="top"><p>Example:</p></td>
<td><p><span class="color"><font color="red"><span class="bold"><strong>showlog_initial_states=1</strong></span></font></span>
</p></td>
</tr>
</tbody>
</table>
</div>
<p>This option allows you to specify if initial states of hosts and services should be shown in showlog.cgi.</p>
<div class="note" title="Note" style="margin-left: 0.5in; margin-right: 0.5in;"><table border="0" summary="Note">
<tr>
<td rowspan="2" align="center" valign="top" width="25"><img alt="[Note]" src="../images/note.png"></td>
<th align="left">Note</th>
</tr>
<tr><td align="left" valign="top">
<p>This option only works if the option "log_initial_states" in icinga.cfg is set to 1.</p>
</td></tr>
</table></div>
<div class="itemizedlist"><ul class="itemizedlist" type="disc">
<li class="listitem">
<p>0 = Don't show initial states in showlog.cgi (default)</p>
</li>
<li class="listitem">
<p>1 = Show initial states in showlog.cgi</p>
</li>
</ul></div>
<p><a name="configcgi-showlog_current_states"></a> <span class="bold"><strong>Show current states</strong></span></p>
<div class="informaltable">
<table border="0">
<colgroup>
<col>
<col>
</colgroup>
<tbody>
<tr>
<td align="left" valign="top"><p>Format:</p></td>
<td><p><span class="bold"><strong>showlog_current_states=<0|1></strong></span></p></td>
</tr>
<tr>
<td align="left" valign="top"><p>Example:</p></td>
<td><p><span class="color"><font color="red"><span class="bold"><strong>showlog_current_states=1</strong></span></font></span>
</p></td>
</tr>
</tbody>
</table>
</div>
<p>This option allows you to specify if current states of hosts and services should be shown in showlog.cgi.</p>
<div class="note" title="Note" style="margin-left: 0.5in; margin-right: 0.5in;"><table border="0" summary="Note">
<tr>
<td rowspan="2" align="center" valign="top" width="25"><img alt="[Note]" src="../images/note.png"></td>
<th align="left">Note</th>
</tr>
<tr><td align="left" valign="top">
<p>This option only works if the option "log_current_states" in icinga.cfg is set to 1.</p>
</td></tr>
</table></div>
<div class="itemizedlist"><ul class="itemizedlist" type="disc">
<li class="listitem">
<p>0 = Don't show current states in showlog.cgi (default)</p>
</li>
<li class="listitem">
<p>1 = Show current states in showlog.cgi</p>
</li>
</ul></div>
<p><a name="configcgi-tab_friendly_titles"></a> <span class="bold"><strong>Show object type in tab title</strong></span></p>
<div class="informaltable">
<table border="0">
<colgroup>
<col>
<col>
</colgroup>
<tbody>
<tr>
<td align="left" valign="top"><p>Format:</p></td>
<td><p><span class="bold"><strong>tab_friendly_titles=<0|1></strong></span></p></td>
</tr>
<tr>
<td align="left" valign="top"><p>Example:</p></td>
<td><p><span class="color"><font color="red"><span class="bold"><strong>tab_friendly_titles=1</strong></span></font></span>
</p></td>
</tr>
</tbody>
</table>
</div>
<p>Activating this option changes the <title> of status.cgi and extinfo.cgi when they refer to a single host, service, or
group.</p>
<p>They will then read:</p>
<div class="itemizedlist"><ul class="itemizedlist" type="disc">
<li class="listitem">
<p>[Host]</p>
</li>
<li class="listitem">
<p>{HostGroup}</p>
</li>
<li class="listitem">
<p>ServiceDesc @ Host</p>
</li>
<li class="listitem">
<p>(ServiceGroup)</p>
</li>
</ul></div>
<p>These are easier to read and find if you use (many) tabs in your browser.</p>
<div class="itemizedlist"><ul class="itemizedlist" type="disc">
<li class="listitem">
<p>0 = Don't show object type in tab title</p>
</li>
<li class="listitem">
<p>1 = Show object type in tab title (default)</p>
</li>
</ul></div>
<p><a name="configcgi-add_notif_num"></a> <span class="bold"><strong>Show service state and notification number</strong></span></p>
<div class="informaltable">
<table border="0">
<colgroup>
<col>
<col>
</colgroup>
<tbody>
<tr>
<td align="left" valign="top"><p>Format:</p></td>
<td><p><span class="bold"><strong>add_notif_num_hard=n</strong></span></p></td>
</tr>
<tr>
<td align="left" valign="top"><p></p></td>
<td><p><span class="bold"><strong>add_notif_num_soft=n</strong></span></p></td>
</tr>
<tr>
<td align="left" valign="top"><p>Example:</p></td>
<td><p><span class="color"><font color="red"><span class="bold"><strong>add_notif_num_hard=28</strong></span></font></span>
</p></td>
</tr>
</tbody>
</table>
</div>
<p>Set this to an OR of the service state identifiers for which status.cgi should not only report "attempts" (e.g., "3/3" for a HARD
non-OK state with max_check_attempts=3) but also the current notification number ("(#0)" if no problem notification has been sent yet,
etc.). This is helpful to identify services which switched between different non-OK states a lot, or services which have a
first_notification_delay set and are "not yet officially" considered in trouble.</p>
<p>Relevant values from include/statusdata.h (look them up *there* if you want to be *really* sure): </p>
<pre class="programlisting"> #define SERVICE_PENDING 1
#define SERVICE_OK 2
#define SERVICE_WARNING 4
#define SERVICE_UNKNOWN 8
#define SERVICE_CRITICAL 16</pre>
<p>You'll likely want to use add_notif_num_hard=0 (default) or add_notif_num_hard=28 (warn+crit+unknown).</p>
<p>There's an add_notif_num_soft affecting services in a SOFT state for sake of completeness, too.</p>
<p><a name="configcgi-http_charset"></a> <span class="bold"><strong>Set HTTP character set</strong></span></p>
<div class="informaltable">
<table border="0">
<colgroup>
<col>
<col>
</colgroup>
<tbody>
<tr>
<td align="left" valign="top"><p>Format:</p></td>
<td><p><span class="bold"><strong>http_charset=<char-set></strong></span></p></td>
</tr>
<tr>
<td align="left" valign="top"><p>Example:</p></td>
<td><p><span class="color"><font color="red"><span class="bold"><strong>http_charset=utf-8</strong></span></font></span> </p></td>
</tr>
</tbody>
</table>
</div>
<p>This is the character set which is sent with HTTP headers. Default is utf-8.</p>
<p><a name="configcgi-first_day_of_week"></a> <span class="bold"><strong>Set first day of week</strong></span></p>
<div class="informaltable">
<table border="0">
<colgroup>
<col>
<col>
</colgroup>
<tbody>
<tr>
<td align="left" valign="top"><p>Format:</p></td>
<td><p><span class="bold"><strong>first_day_of_week=<0|1></strong></span></p></td>
</tr>
<tr>
<td align="left" valign="top"><p>Example:</p></td>
<td><p><span class="color"><font color="red"><span class="bold"><strong>first_day_of_week=1</strong></span></font></span>
</p></td>
</tr>
</tbody>
</table>
</div>
<p>This sets the first day of the week which is used in several CGI-reports. Default is 0 = sunday. 1 = monday will be suitable for
countries adhering to ISO 8601.</p>
<p><a name="configcgi-use_logging"></a> <span class="bold"><strong>Logging of CGI commands</strong></span></p>
<div class="informaltable">
<table border="0">
<colgroup>
<col>
<col>
</colgroup>
<tbody>
<tr>
<td align="left" valign="top"><p>Format:</p></td>
<td><p><span class="bold"><strong>use_logging=<0|1></strong></span></p></td>
</tr>
<tr>
<td align="left" valign="top"><p>Example:</p></td>
<td><p><span class="color"><font color="red"><span class="bold"><strong>use_logging=1</strong></span></font></span></p></td>
</tr>
</tbody>
</table>
</div>
<p>This option enables the logging of CGI commands in a separate log file. Default is 0 = logging disabled, 1 = logging enabled.</p>
<p><a name="configcgi-cgi_log_file"></a> <span class="bold"><strong>CGI log file</strong></span></p>
<div class="informaltable">
<table border="0">
<colgroup>
<col>
<col>
</colgroup>
<tbody>
<tr>
<td align="left" valign="top"><p>Format:</p></td>
<td><p><span class="bold"><strong>cgi_log_file=<file_name></strong></span></p></td>
</tr>
<tr>
<td align="left" valign="top"><p>Example:</p></td>
<td><p><span class="color"><font color="red"><span class="bold"><strong>cgi_log_file=/usr/local/icinga/share/log/icinga-cgi.log</strong></span></font></span></p></td>
</tr>
</tbody>
</table>
</div>
<p>This option sets the location of the CGI log file.</p>
<p><a name="configcgi-cgi_log_rotation_method"></a> <span class="bold"><strong>CGI log file rotation method</strong></span></p>
<div class="informaltable">
<table border="0">
<colgroup>
<col>
<col>
</colgroup>
<tbody>
<tr>
<td align="left" valign="top"><p>Format:</p></td>
<td><p><span class="bold"><strong>log file rotation method=<d|w|m></strong></span></p></td>
</tr>
<tr>
<td align="left" valign="top"><p>Example:</p></td>
<td><p><span class="color"><font color="red"><span class="bold"><strong>cgi_log_rotation_method=d</strong></span></font></span>
</p></td>
</tr>
</tbody>
</table>
</div>
<p>This is the rotation method that you would like Icinga to use for your CGI log file. Values are as follows:</p>
<div class="itemizedlist"><ul class="itemizedlist" type="disc">
<li class="listitem">
<p>n = None (do not rotate the log)</p>
</li>
<li class="listitem">
<p>h = Hourly (rotate the log at top of the hour)</p>
</li>
<li class="listitem">
<p>d = Daily (rotate the log at midnight each day - this is the default)</p>
</li>
<li class="listitem">
<p>w = Weekly (rotate the log at midnight on Saturday)</p>
</li>
<li class="listitem">
<p>m = Monthly (rotate the log at midnight on the last day of the month)</p>
</li>
</ul></div>
<p><a name="configcgi-cgi_log_archive_path"></a> <span class="bold"><strong>CGI Log Archive Path</strong></span></p>
<div class="informaltable">
<table border="0">
<colgroup>
<col>
<col>
</colgroup>
<tbody>
<tr>
<td align="left" valign="top"><p>Format:</p></td>
<td><p><span class="bold"><strong>cgi_log_archive_path=<archive directory></strong></span></p></td>
</tr>
<tr>
<td align="left" valign="top"><p>Example:</p></td>
<td><p><span class="color"><font color="red"><span class="bold"><strong>cgi_log_archive_path=/usr/local/icinga/share/log</strong></span></font></span></p></td>
</tr>
</tbody>
</table>
</div>
<p>This is the directory where Icinga should place CGI log files that have been rotated. This option is ignored if you choose to
not use the <a class="link" href="configcgi.html#configcgi-cgi_log_rotation_method">CGI log rotation</a> functionality.</p>
<p><a name="configcgi-enforce_comments_on_actions"></a> <span class="bold"><strong>Enforce comments on actions</strong></span></p>
<div class="informaltable">
<table border="0">
<colgroup>
<col>
<col>
</colgroup>
<tbody>
<tr>
<td align="left" valign="top"><p>Format:</p></td>
<td><p><span class="bold"><strong>enforce_comments_on_actions=<0|1></strong></span></p></td>
</tr>
<tr>
<td align="left" valign="top"><p>Example:</p></td>
<td><p><span class="color"><font color="red"><span class="bold"><strong>enforce_comments_on_actions=1</strong></span></font></span>
</p></td>
</tr>
</tbody>
</table>
</div>
<p>Enforces the need to enter a comment on actions entered via the CGIs. 0 = do not enforce comment (default), 1 = enforce
comment.</p>
<div class="note" title="Note" style="margin-left: 0.5in; margin-right: 0.5in;"><table border="0" summary="Note">
<tr>
<td rowspan="2" align="center" valign="top" width="25"><img alt="[Note]" src="../images/note.png"></td>
<th align="left">Note</th>
</tr>
<tr><td align="left" valign="top">
<p>The option use_logging has to be enabled, otherwise there will be no logging of comments.</p>
</td></tr>
</table></div>
<p><a name="configcgi-show_tac_header"></a> <span class="bold"><strong>Show header with tactical information</strong></span></p>
<div class="informaltable">
<table border="0">
<colgroup>
<col>
<col>
</colgroup>
<tbody>
<tr>
<td align="left" valign="top"><p>Format:</p></td>
<td><p><span class="bold"><strong>show_tac_header=<0|1></strong></span></p></td>
</tr>
<tr>
<td align="left" valign="top"><p>Example:</p></td>
<td><p><span class="color"><font color="red"><span class="bold"><strong>show_tac_header=0</strong></span></font></span> </p></td>
</tr>
</tbody>
</table>
</div>
<p>There's a new CGI driven top frame that is enabled by default. The new view has a similar feel to the header that is in Icinga Web
and includes important tactical and monitor performance information so you can always be informed of issues.</p>
<p>If you want to keep the old minimalistic look, the new CGI top view can be disabled with the directive:
<code class="literal">show_tac_header=0</code></p>
<p>The layout for the display of entries for each type is "X / Y / Z" where:</p>
<div class="informaltable">
<table border="0">
<colgroup><col></colgroup>
<tbody>
<tr><td align="left" valign="top"><p>X = Active unacknowledged</p></td></tr>
<tr><td align="left" valign="top"><p>Y = Passive unacknowledged</p></td></tr>
<tr><td align="left" valign="top"><p>Z = Acknowledged</p></td></tr>
</tbody>
</table>
</div>
<p>The X/Y/Z numbers themselves are click-able and will bring you to a list of all the services or hosts related to the respective
entry.</p>
<p>Colouring for these entries has the following logical flow:</p>
<pre class="programlisting"> 1+ / * / * = Full colour, full saturation
0 / 1+ / * = Full colour but desaturated, rim coloured
0 / 0 / 1+ = Rim coloured, text coloured and bold
0 / 0 / * = Grey
</pre>
<p>These colours are located in <code class="filename">html/stylesheets/tacheader.css</code> for easy customisation. For example, if your setup
is distributed and primarily depends upon passive checks then you may prefer to make passive check issues stand out with the same
colouring as active checks.</p>
<div class="figure">
<a name="idm140381632158208"></a><p class="title"><b>Figure 3.1. Example of new header</b></p>
<div class="figure-contents">
<div class="mediaobject"><img src="../images/tac_header2.png" alt="Example of new header"></div>
</div>
</div>
<br class="figure-break">
<p><a name="configcgi-show_tac_header_pending"></a> <span class="bold"><strong>Show header including pending counts</strong></span></p>
<div class="informaltable">
<table border="0">
<colgroup>
<col>
<col>
</colgroup>
<tbody>
<tr>
<td align="left" valign="top"><p>Format:</p></td>
<td><p><span class="bold"><strong>show_tac_header_pending=<0|1></strong></span></p></td>
</tr>
<tr>
<td align="left" valign="top"><p>Example:</p></td>
<td><p><span class="color"><font color="red"><span class="bold"><strong>show_tac_header_pending=0</strong></span></font></span>
</p></td>
</tr>
</tbody>
</table>
</div>
<p>This option enables the display of pending counts in the tac header. If your display is less than 1024x768 and this is enabled, the
tactical information may not fit well in the top frame. By default it is disabled.</p>
<p><a name="configcgi-default_downtime_duration"></a> <span class="bold"><strong>Set default downtime duration</strong></span></p>
<div class="informaltable">
<table border="0">
<colgroup>
<col>
<col>
</colgroup>
<tbody>
<tr>
<td align="left" valign="top"><p>Format:</p></td>
<td><p><span class="bold"><strong>default_downtime_duration=n</strong></span></p></td>
</tr>
<tr>
<td align="left" valign="top"><p>Example:</p></td>
<td><p><span class="color"><font color="red"><span class="bold"><strong>default_downtime_duration=7200</strong></span></font></span>
</p></td>
</tr>
</tbody>
</table>
</div>
<p>This option defines the default duration (in seconds) of fixed and flexible downtimes. Default is 7200 seconds (2 hours).</p>
<p><a name="configcgi-suppress_maintenance_downtime"></a> <span class="bold"><strong>Suppress objects in maintenance/downtime state
</strong></span></p>
<div class="informaltable">
<table border="0">
<colgroup>
<col>
<col>
</colgroup>
<tbody>
<tr>
<td align="left" valign="top"><p>Format:</p></td>
<td><p><span class="bold"><strong>suppress_maintenance_downtime=<0|1></strong></span></p></td>
</tr>
<tr>
<td align="left" valign="top"><p>Example:</p></td>
<td><p><span class="color"><font color="red"><span class="bold"><strong>suppress_maintenance_downtime=0</strong></span></font></span>
</p></td>
</tr>
</tbody>
</table>
</div>
<p>The current Classic UI view shows the state of hosts including attention grabbing colours even if the host/service is scheduled for
downtime. This tends to distract from discerning which problems really exist between those which were planned or expected. It is disabled
by default to maintain the old behaviour, however those wishing to enable it will note that rather than displaying issues in their regular
colour, they will be grey (similar to the pending state). The status, however will still display the actual state and this is intended
behaviour. This is so the user can use icinga to see what the state is in before the downtime ends. A useful example for this is so it can
be seen that a host/service that was being worked on actually came back online. In addition, hosts in scheduled downtime will be grey in
the statusmap.cgi.</p>
<p><a name="configcgi-show_partial_hostgroups"></a> <span class="bold"><strong>Show partial hostgroups</strong></span></p>
<div class="informaltable">
<table border="0">
<colgroup>
<col>
<col>
</colgroup>
<tbody>
<tr>
<td align="left" valign="top"><p>Format:</p></td>
<td><p><span class="bold"><strong>show_partial_hostgroups=<0|1></strong></span></p></td>
</tr>
<tr>
<td align="left" valign="top"><p>Example:</p></td>
<td><p><span class="color"><font color="red"><span class="bold"><strong>show_partial_hostgroups=1</strong></span></font></span>
</p></td>
</tr>
</tbody>
</table>
</div>
<p>By default (meaning the directive is not present or disabled), a user only sees a hostgroup and the hosts within it if they are an
authorised contact for <span class="emphasis"><em>all</em></span> of the hosts of the group. The behaviour can be changed using the directive
<code class="code">show_partial_hostgroups=1</code>.</p>
<p>When enabled, the hostgroups overview will show a partial listing of hosts that the user is an authorised contact for within each
hostgroup.</p>
<p>It will also add the string "(Partial Hostgroups Enabled)" to the top of the Hostgroup Overview to help prevent any confusion over
whether the option is in use or not. However for privacy reasons, hostgroups that are only showing a partial listing are not specifically
indicated.</p>
<p>COMPATIBILITY NOTICE: As with any tweak made to the output of the CGIs, enabling this option may adversely impact third party
programs that rely on 'screen scraping' to get their information. If you encounter such a problem, turn this option back to its default of
off and encourage the developer(s) of the program to use JSON for their data needs instead.</p>
<p><a name="configcgi-highlight_table_rows"></a> <span class="bold"><strong>Highlight rows in status.cgi</strong></span></p>
<div class="informaltable">
<table border="0">
<colgroup>
<col>
<col>
</colgroup>
<tbody>
<tr>
<td align="left" valign="top"><p>Format:</p></td>
<td><p><span class="bold"><strong>highlight_table_rows=<0|1></strong></span></p></td>
</tr>
<tr>
<td align="left" valign="top"><p>Example:</p></td>
<td><p><span class="color"><font color="red"><span class="bold"><strong>highlight_table_rows=0</strong></span></font></span>
</p></td>
</tr>
</tbody>
</table>
</div>
<p>This option allows you to define if table rows in status.cgi will be highlighted or not. Sometimes with a lot of rows or a large
screen resolution it is hard to see which rows you are working on: Values: 0 = disables row highlighting; 1 = enables row highlighting
(default).</p>
<p><a name="configcgi-use_pending_states"></a> <span class="bold"><strong>Select state to be shown while pending</strong></span></p>
<div class="informaltable">
<table border="0">
<colgroup>
<col>
<col>
</colgroup>
<tbody>
<tr>
<td align="left" valign="top"><p>Format:</p></td>
<td><p><span class="bold"><strong>use_pending_states=<0|1></strong></span></p></td>
</tr>
<tr>
<td align="left" valign="top"><p>Example:</p></td>
<td><p><span class="color"><font color="red"><span class="bold"><strong>use_pending_states=0</strong></span></font></span>
</p></td>
</tr>
</tbody>
</table>
</div>
<p>This option determines what states should be displayed in the web interface for hosts/services that have not yet been checked.
Values: 0 = leave hosts/services that have not been checked yet in their original state; 1 = mark hosts/services that have not been
checked yet as PENDING (default).</p>
<p><a name="configcgi-default_expiring_acknowledgement_duration"></a> <span class="bold"><strong>Set expiration period of
acknowledgements</strong></span></p>
<div class="informaltable">
<table border="0">
<colgroup>
<col>
<col>
</colgroup>
<tbody>
<tr>
<td align="left" valign="top"><p>Format:</p></td>
<td><p><span class="bold"><strong>default_expiring_acknowledgement_duration=<n></strong></span></p></td>
</tr>
<tr>
<td align="left" valign="top"><p>Example:</p></td>
<td><p><span class="color"><font color="red"><span class="bold"><strong>default_expiring_acknowledgement_duration=86400</strong></span></font></span> </p></td>
</tr>
</tbody>
</table>
</div>
<p>This option allows you to define the period (in seconds) after which acknowledgements will expire (meaning they will be deleted).
The default is 86,400 seconds (one day).</p>
<p><a name="configcgi-extinfo_show_child_hosts"></a> <span class="bold"><strong>Show child host(s)</strong></span></p>
<div class="informaltable">
<table border="0">
<colgroup>
<col>
<col>
</colgroup>
<tbody>
<tr>
<td align="left" valign="top"><p>Format:</p></td>
<td><p><span class="bold"><strong>extinfo_show_child_hosts=<0|1|2></strong></span></p></td>
</tr>
<tr>
<td align="left" valign="top"><p>Example:</p></td>
<td><p><span class="color"><font color="red"><span class="bold"><strong>extinfo_show_child_hosts=1</strong></span></font></span>
</p></td>
</tr>
</tbody>
</table>
</div>
<p>This option allows you to specify if the extended host information cgi will show child hosts for the selected host.</p>
<div class="itemizedlist"><ul class="itemizedlist" type="disc">
<li class="listitem">
<p>0 = disabled (default)</p>
</li>
<li class="listitem">
<p>1 = only show immediate child host(s)</p>
</li>
<li class="listitem">
<p>2 = show immediate and subsequent child host(s)</p>
</li>
</ul></div>
<div class="important" title="Important" style="margin-left: 0.5in; margin-right: 0.5in;"><table border="0" summary="Important">
<tr>
<td rowspan="2" align="center" valign="top" width="25"><img alt="[Important]" src="../images/important.png"></td>
<th align="left">Important</th>
</tr>
<tr><td align="left" valign="top">
<p>Option 2 could be a real performance killer in large installations, so use with care.</p>
</td></tr>
</table></div>
<div class="note" title="Note" style="margin-left: 0.5in; margin-right: 0.5in;"><table border="0" summary="Note">
<tr>
<td rowspan="2" align="center" valign="top" width="25"><img alt="[Note]" src="../images/note.png"></td>
<th align="left">Note</th>
</tr>
<tr><td align="left" valign="top">
<p>This option is disabled by default as it can degrade overall performance.</p>
</td></tr>
</table></div>
<p><a name="configcgi-authorized_for_full_command_resolution"></a> <span class="bold"><strong>Allow user(s) for FULL command line
view</strong></span></p>
<div class="informaltable">
<table border="0">
<colgroup>
<col>
<col>
</colgroup>
<tbody>
<tr>
<td align="left" valign="top"><p>Format:</p></td>
<td><p><span class="bold"><strong>authorized_for_full_command_resolution=<user1>,<user2>,<user3>,...<usern></strong></span>
</p></td>
</tr>
<tr>
<td align="left" valign="top"><p>Example:</p></td>
<td><p><span class="color"><font color="red"><span class="bold"><strong>authorized_for_full_command_resolution=icingaadmin</strong></span></font></span> </p></td>
</tr>
</tbody>
</table>
</div>
<p>This option is a comma-delimited list of all usernames that can view a command in config command expander as Icinga would
execute it. To resolve all MACROS it is necessary to allow read access to the web server for <code class="filename">resource.cfg</code> as
well.</p>
<p>Alternatively you can specify contactgroups, too.</p>
<div class="important" title="Important" style="margin-left: 0.5in; margin-right: 0.5in;"><table border="0" summary="Important">
<tr>
<td rowspan="2" align="center" valign="top" width="25"><img alt="[Important]" src="../images/important.png"></td>
<th align="left">Important</th>
</tr>
<tr><td align="left" valign="top">
<p>$USERXX$ vars and custom vars can contain sensitive data so access should be strictly limited.</p>
</td></tr>
</table></div>
<p><a name="configcgi-display_status_totals"></a> <span class="bold"><strong>Display Host/Status Status Totals</strong></span></p>
<div class="informaltable">
<table border="0">
<colgroup>
<col>
<col>
</colgroup>
<tbody>
<tr>
<td align="left" valign="top"><p>Format:</p></td>
<td><p><span class="bold"><strong>display_status_totals=0|1 </strong></span> </p></td>
</tr>
<tr>
<td align="left" valign="top"><p>Example:</p></td>
<td><p><span class="color"><font color="red"><span class="bold"><strong>display_status_totals=0</strong></span></font></span>
</p></td>
</tr>
</tbody>
</table>
</div>
<p>This option allows you to specify if the Host Status Totals and Service Status Totals should be displayed. Default value is
0.</p>
<p><a name="configcgi-result_limit"></a><span class="bold"><strong>Limit number of page entries to be displayed</strong></span></p>
<div class="informaltable">
<table border="0">
<colgroup>
<col>
<col>
</colgroup>
<tbody>
<tr>
<td align="left" valign="top"><p>Format:</p></td>
<td><p><span class="bold"><strong>result_limit=<n></strong></span></p></td>
</tr>
<tr>
<td align="left" valign="top"><p>Example:</p></td>
<td><p><span class="color"><font color="red"><span class="bold"><strong>result_limit=50</strong></span></font></span> </p></td>
</tr>
</tbody>
</table>
</div>
<p>This options specifies the number of page entries displayed by default in various cgi's. To display all entries by default set this
value to 0. Default is 50.</p>
<div class="note" title="Note" style="margin-left: 0.5in; margin-right: 0.5in;"><table border="0" summary="Note">
<tr>
<td rowspan="2" align="center" valign="top" width="25"><img alt="[Note]" src="../images/note.png"></td>
<th align="left">Note</th>
</tr>
<tr><td align="left" valign="top">
<p>This option is available starting with Icinga 1.8</p>
</td></tr>
</table></div>
<p><a name="configcgi-lowercase_user_name"></a><span class="bold"><strong>Convert user name to lowercase</strong></span></p>
<div class="informaltable">
<table border="0">
<colgroup>
<col>
<col>
</colgroup>
<tbody>
<tr>
<td align="left" valign="top"><p>Format:</p></td>
<td><p><span class="bold"><strong>lowercase_user_name=0|1</strong></span></p></td>
</tr>
<tr>
<td align="left" valign="top"><p>Example:</p></td>
<td><p><span class="color"><font color="red"><span class="bold"><strong>lowercase_user_name=1</strong></span></font></span></p></td>
</tr>
</tbody>
</table>
</div>
<p>This option controls whether or not the username is converted to all lowercase letters. Can be useful if the username is stored in
Active Directory (case-insensitive). Default is 1.</p>
<div class="note" title="Note" style="margin-left: 0.5in; margin-right: 0.5in;"><table border="0" summary="Note">
<tr>
<td rowspan="2" align="center" valign="top" width="25"><img alt="[Note]" src="../images/note.png"></td>
<th align="left">Note</th>
</tr>
<tr><td align="left" valign="top">
<p>This option is available starting with Icinga 1.8</p>
</td></tr>
</table></div>
<p><a name="configcgi-send_ack_notifications"></a><span class="bold"><strong>Set initial state of "Send notification"
checkbox</strong></span></p>
<div class="informaltable">
<table border="0">
<colgroup>
<col>
<col>
</colgroup>
<tbody>
<tr>
<td align="left" valign="top"><p>Format:</p></td>
<td><p><span class="bold"><strong>send_ack_notifications=0|1</strong></span></p></td>
</tr>
<tr>
<td align="left" valign="top"><p>Example:</p></td>
<td><p><span class="color"><font color="red"><span class="bold"><strong>send_ack_notifications=1</strong></span></font></span></p></td>
</tr>
</tbody>
</table>
</div>
<p>This option controls the initial state of the "Send Notification:" checkbox when acknowledging a problem. Set this to 1 to send
notifications by default and 0 to not. This default value may be overridden in the CGI dialogue. The default is 1 (send notifications on
problem acknowledgement).</p>
<div class="note" title="Note" style="margin-left: 0.5in; margin-right: 0.5in;"><table border="0" summary="Note">
<tr>
<td rowspan="2" align="center" valign="top" width="25"><img alt="[Note]" src="../images/note.png"></td>
<th align="left">Note</th>
</tr>
<tr><td align="left" valign="top">
<p>This option is available starting with Icinga 1.9</p>
</td></tr>
</table></div>
<p><a name="configcgi-set_expire_ack_by_default"></a><span class="bold"><strong>Set initial state of "Set Expire time"
checkbox</strong></span></p>
<div class="informaltable">
<table border="0">
<colgroup>
<col>
<col>
</colgroup>
<tbody>
<tr>
<td align="left" valign="top"><p>Format:</p></td>
<td><p><span class="bold"><strong>set_expire_ack_by_default=0|1</strong></span></p></td>
</tr>
<tr>
<td align="left" valign="top"><p>Example:</p></td>
<td><p><span class="color"><font color="red"><span class="bold"><strong>set_expire_ack_by_default=1</strong></span></font></span></p></td>
</tr>
</tbody>
</table>
</div>
<p>This option controls the initial state of the "Use Expire Time:" checkbox when acknowledging a problem. Set this to 1 to use expiry
by default and 0 to not. The default is 0 (do not use auto-expiry). This may be overridden in the CGI dialogue.</p>
<div class="note" title="Note" style="margin-left: 0.5in; margin-right: 0.5in;"><table border="0" summary="Note">
<tr>
<td rowspan="2" align="center" valign="top" width="25"><img alt="[Note]" src="../images/note.png"></td>
<th align="left">Note</th>
</tr>
<tr><td align="left" valign="top">
<p>This option is available starting with Icinga 1.9</p>
</td></tr>
</table></div>
<p><a name="configcgi-standalone_installation"></a><span class="bold"><strong>Enable Classic UI Standalone Installation
</strong></span></p>
<div class="informaltable">
<table border="0">
<colgroup>
<col>
<col>
</colgroup>
<tbody>
<tr>
<td align="left" valign="top"><p>Format:</p></td>
<td><p><span class="bold"><strong>standalone_installation=0|1</strong></span></p></td>
</tr>
<tr>
<td align="left" valign="top"><p>Example:</p></td>
<td><p><span class="color"><font color="red"><span class="bold"><strong>standalone_installation=1</strong></span></font></span></p></td>
</tr>
</tbody>
</table>
</div>
<p>This option controls if Classic UI is used as standalone setup. This option was mainly implemented for Icinga 2 and its compat
layer, but may be helpful in other setups as well, like for a standalone dashboard next to the default install. Enabling this option will
make Classic UI ignore the main_config_file setting and require all options to be set in cgi.cfg instead. The section "Standalone (Icinga
2)" within the sample config holds all needed settings.</p>
<div class="note" title="Note" style="margin-left: 0.5in; margin-right: 0.5in;"><table border="0" summary="Note">
<tr>
<td rowspan="2" align="center" valign="top" width="25"><img alt="[Note]" src="../images/note.png"></td>
<th align="left">Note</th>
</tr>
<tr><td align="left" valign="top">
<p>This option is available starting with Icinga 1.9</p>
</td></tr>
</table></div>
<p><a name="configcgi-show_partial_servicegroups"></a><span class="bold"><strong>Allow viewing partial service groups</strong></span></p>
<div class="informaltable">
<table border="0">
<colgroup>
<col>
<col>
</colgroup>
<tbody>
<tr>
<td align="left" valign="top"><p>Format:</p></td>
<td><p><span class="bold"><strong>show_partial_servicegroups=0|1</strong></span></p></td>
</tr>
<tr>
<td align="left" valign="top"><p>Example:</p></td>
<td><p><span class="color"><font color="red"><span class="bold"><strong>show_partial_servicegroups=1</strong></span></font></span></p></td>
</tr>
</tbody>
</table>
</div>
<p>By default (meaning the directive is not present or disabled), a user only sees a servicegroup and the hosts and services within it
if she is an authorised contact for all of the hosts and services of the group. The behaviour can be changed using the directive
<code class="literal">show_partial_servicegroups=1</code>. When enabled, the servicegroups overview will show a partial listing of hosts and
services that the user is an authorised contact for within each servicegroup. It will also add the string "(Partial Servicegroups
Enabled)" to the top of the Servicegroup Overview to help prevent any confusion over whether the option is in use or not. However for
privacy reasons, servicegroups that are only showing a partial listing are not specifically indicated.</p>
<p><a name="configcgi-disable_cmd_cgi_csrf_protection"></a><span class="bold"><strong>Disable CSRF protection for command
cgi</strong></span></p>
<div class="informaltable">
<table border="0">
<colgroup>
<col>
<col>
</colgroup>
<tbody>
<tr>
<td align="left" valign="top"><p>Format:</p></td>
<td><p><span class="bold"><strong>disable_cmd_cgi_csrf_protection=0|1</strong></span></p></td>
</tr>
<tr>
<td align="left" valign="top"><p>Example:</p></td>
<td><p><span class="color"><font color="red"><span class="bold"><strong>disable_cmd_cgi_csrf_protection=1</strong></span></font></span></p></td>
</tr>
</tbody>
</table>
</div>
<p>By default (meaning the directive is not present or disabled), a command submitted by an external program (like Nagstamon) accessing
cmd.cgi directly will be rejected to protect against CSRF attacks (Cross-Site Request Forgery). Enable (=1) this option only if you need
this functionality.</p>
<div class="itemizedlist"><ul class="itemizedlist" type="disc">
<li class="listitem">
<p>0 - disabled, protect against CSRF attacks (default)</p>
</li>
<li class="listitem">
<p>1 - enabled, allow external programs to submit commands</p>
</li>
</ul></div>
<div class="note" title="Note" style="margin-left: 0.5in; margin-right: 0.5in;"><table border="0" summary="Note">
<tr>
<td rowspan="2" align="center" valign="top" width="25"><img alt="[Note]" src="../images/note.png"></td>
<th align="left">Note</th>
</tr>
<tr><td align="left" valign="top">
<p>This option is available starting with Icinga 1.11</p>
</td></tr>
</table></div>
<p><a name="configcgi-exclude_customvar_name"></a><span class="bold"><strong>Exclude display of custom variable names</strong></span></p>
<div class="informaltable">
<table border="0">
<colgroup>
<col>
<col>
</colgroup>
<tbody>
<tr>
<td align="left" valign="top"><p>Format:</p></td>
<td><p><span class="bold"><strong>exclude_customvar_name=<name1[,name2,...]|*></strong></span></p></td>
</tr>
<tr>
<td align="left" valign="top"><p>Example:</p></td>
<td><p><span class="color"><font color="red"><span class="bold"><strong>exclude_customvar_name=<password></strong></span></font></span></p></td>
</tr>
</tbody>
</table>
</div>
<p>Custom variables are visible in the Classic UI (as of Icinga 1.11). Due to the fact that some names contain sensitive
information it should be possible to hide it from the user. The directive "exclude_customvar_name" specifies a comma-separated list of
strings. Variable names containing these strings will not be displayed. Specifying "*" instead of a list will exclude all custom variable
names.</p>
<div class="note" title="Note" style="margin-left: 0.5in; margin-right: 0.5in;"><table border="0" summary="Note">
<tr>
<td rowspan="2" align="center" valign="top" width="25"><img alt="[Note]" src="../images/note.png"></td>
<th align="left">Note</th>
</tr>
<tr><td align="left" valign="top">
<p>This option is available starting with Icinga 1.11</p>
</td></tr>
</table></div>
<p><a name="configcgi-exclude_customvar_value"></a><span class="bold"><strong>Exclude display of custom variable
values</strong></span></p>
<div class="informaltable">
<table border="0">
<colgroup>
<col>
<col>
</colgroup>
<tbody>
<tr>
<td align="left" valign="top"><p>Format:</p></td>
<td><p><span class="bold"><strong>exclude_customvar_value=<value1[,value2,...]|*></strong></span></p></td>
</tr>
<tr>
<td align="left" valign="top"><p>Example:</p></td>
<td><p><span class="color"><font color="red"><span class="bold"><strong>exclude_customvar_value=<secret></strong></span></font></span></p></td>
</tr>
</tbody>
</table>
</div>
<p>Custom variables are visible in the Classic UI (as of Icinga 1.11). Due to the fact that some values contain sensitive
information it should be possible to hide it from the user. The directive "exclude_customvar_value" specifies a comma-separated list of
strings. Variable values containing these strings will not be displayed. Specifying "*" instead of a list will exclude all custom variable
values.</p>
<div class="note" title="Note" style="margin-left: 0.5in; margin-right: 0.5in;"><table border="0" summary="Note">
<tr>
<td rowspan="2" align="center" valign="top" width="25"><img alt="[Note]" src="../images/note.png"></td>
<th align="left">Note</th>
</tr>
<tr><td align="left" valign="top">
<p>This option is available starting with Icinga 1.11</p>
</td></tr>
</table></div>
<p><a name="configcgi-sort_status_data_by_default"></a><span class="bold"><strong>Sort status data by default</strong></span></p>
<div class="informaltable">
<table border="0">
<colgroup>
<col>
<col>
</colgroup>
<tbody>
<tr>
<td align="left" valign="top"><p>Format:</p></td>
<td><p><span class="bold"><strong>sort_status_data_by_default=<0|1></strong></span></p></td>
</tr>
<tr>
<td align="left" valign="top"><p>Example:</p></td>
<td><p><span class="color"><font color="red"><span class="bold"><strong>sort_status_data_by_default=<0></strong></span></font></span></p></td>
</tr>
</tbody>
</table>
</div>
<p>This option forces status.cgi to sort status data by default. Data will be sorted ascending. First by host name and then by service
description. This is helpful if status data in status.dat is not sorted properly. This can occur especially if you use Icinga2. By default
this options is switched off (0) to avoid possible higher cpu load in huge environments.</p>
<div class="note" title="Note" style="margin-left: 0.5in; margin-right: 0.5in;"><table border="0" summary="Note">
<tr>
<td rowspan="2" align="center" valign="top" width="25"><img alt="[Note]" src="../images/note.png"></td>
<th align="left">Note</th>
</tr>
<tr><td align="left" valign="top">
<p>This option is available starting with Icinga 1.12</p>
</td></tr>
</table></div>
<p><a name="configcgi-set_sticky_acknowledgment"></a><span class="bold"><strong>State of stickiness of
acknowledgements</strong></span></p>
<div class="informaltable">
<table border="0">
<colgroup>
<col>
<col>
</colgroup>
<tbody>
<tr>
<td align="left" valign="top"><p>Format:</p></td>
<td><p><span class="bold"><strong>set_sticky_acknowledgment=<0|1></strong></span></p></td>
</tr>
<tr>
<td align="left" valign="top"><p>Example:</p></td>
<td><p><span class="color"><font color="red"><span class="bold"><strong>set_sticky_acknowledgment=<0></strong></span></font></span></p></td>
</tr>
</tbody>
</table>
</div>
<p>This option controls the initial state of the "Sticky Acknowledgment:" checkbox when acknowledging a problem. Set this to 1 to force
stickiness by default and 0 to not. The default is 1 (ACKs are sticky). This may be overridden in the CGI dialogue.</p>
<div class="note" title="Note" style="margin-left: 0.5in; margin-right: 0.5in;"><table border="0" summary="Note">
<tr>
<td rowspan="2" align="center" valign="top" width="25"><img alt="[Note]" src="../images/note.png"></td>
<th align="left">Note</th>
</tr>
<tr><td align="left" valign="top">
<p>This option is available starting with Icinga 1.12</p>
</td></tr>
</table></div>
<a class="indexterm" name="idm140381631890480"></a>
<a class="indexterm" name="idm140381631889472"></a>
<a class="indexterm" name="idm140381631887920"></a>
<a class="indexterm" name="idm140381631886368"></a>
<a class="indexterm" name="idm140381631884608"></a>
<a class="indexterm" name="idm140381631883120"></a>
<a class="indexterm" name="idm140381631881488"></a>
<a class="indexterm" name="idm140381631879856"></a>
<a class="indexterm" name="idm140381631878160"></a>
<a class="indexterm" name="idm140381631876464"></a>
<a class="indexterm" name="idm140381631874928"></a>
<a class="indexterm" name="idm140381631873008"></a>
<a class="indexterm" name="idm140381631871344"></a>
<a class="indexterm" name="idm140381631869584"></a>
<a class="indexterm" name="idm140381631867920"></a>
<a class="indexterm" name="idm140381631866256"></a>
<a class="indexterm" name="idm140381631864544"></a>
<a class="indexterm" name="idm140381631862864"></a>
<a class="indexterm" name="idm140381631861216"></a>
<a class="indexterm" name="idm140381631859472"></a>
<a class="indexterm" name="idm140381631857840"></a>
<a class="indexterm" name="idm140381631856128"></a>
<a class="indexterm" name="idm140381631854464"></a>
<a class="indexterm" name="idm140381631852784"></a>
<a class="indexterm" name="idm140381631851072"></a>
<a class="indexterm" name="idm140381631849392"></a>
<a class="indexterm" name="idm140381631847616"></a>
<a class="indexterm" name="idm140381631846000"></a>
<a class="indexterm" name="idm140381631844320"></a>
<a class="indexterm" name="idm140381631842656"></a>
<a class="indexterm" name="idm140381631840992"></a>
<a class="indexterm" name="idm140381631839440"></a>
<a class="indexterm" name="idm140381631837680"></a>
<a class="indexterm" name="idm140381631836160"></a>
<a class="indexterm" name="idm140381631834528"></a>
<a class="indexterm" name="idm140381631832896"></a>
<a class="indexterm" name="idm140381631831264"></a>
<a class="indexterm" name="idm140381631829584"></a>
<a class="indexterm" name="idm140381631827920"></a>
<a class="indexterm" name="idm140381631826368"></a>
<a class="indexterm" name="idm140381631824704"></a>
<a class="indexterm" name="idm140381631822944"></a>
<a class="indexterm" name="idm140381631821328"></a>
<a class="indexterm" name="idm140381631819600"></a>
<a class="indexterm" name="idm140381631817936"></a>
<a class="indexterm" name="idm140381631816416"></a>
<a class="indexterm" name="idm140381631814688"></a>
<a class="indexterm" name="idm140381631813136"></a>
<a class="indexterm" name="idm140381631811920"></a>
<a class="indexterm" name="idm140381631810256"></a>
<a class="indexterm" name="idm140381631808704"></a>
<a class="indexterm" name="idm140381631807200"></a>
<a class="indexterm" name="idm140381631805568"></a>
<a class="indexterm" name="idm140381631803936"></a>
<a class="indexterm" name="idm140381631802320"></a>
<a class="indexterm" name="idm140381631800656"></a>
<a class="indexterm" name="idm140381631799008"></a>
<a class="indexterm" name="idm140381631797328"></a>
<a class="indexterm" name="idm140381631795664"></a>
<a class="indexterm" name="idm140381631793984"></a>
<a class="indexterm" name="idm140381631792336"></a>
<a class="indexterm" name="idm140381631790688"></a>
<a class="indexterm" name="idm140381631788928"></a>
<a class="indexterm" name="idm140381631787280"></a>
<a class="indexterm" name="idm140381631785664"></a>
<a class="indexterm" name="idm140381631783984"></a>
<a class="indexterm" name="idm140381631782352"></a>
<a class="indexterm" name="idm140381631780640"></a>
<a class="indexterm" name="idm140381631778992"></a>
<a class="indexterm" name="idm140381631777376"></a>
<a class="indexterm" name="idm140381631775696"></a>
<a class="indexterm" name="idm140381631774016"></a>
<a class="indexterm" name="idm140381631772256"></a>
<a class="indexterm" name="idm140381631770656"></a>
<a class="indexterm" name="idm140381631769008"></a>
<a class="indexterm" name="idm140381631767328"></a>
</div>
<div class="navfooter">
<hr>
<table width="100%" summary="Navigation footer">
<tr>
<td width="40%" align="left">
<a accesskey="p" href="customobjectvars.html">Prev</a> </td>
<td width="20%" align="center"><a accesskey="u" href="ch03.html">Up</a></td>
<td width="40%" align="right"> <a accesskey="n" href="ch04.html">Next</a>
</td>
</tr>
<tr>
<td width="40%" align="left" valign="top">3.5. Custom Object Variables </td>
<td width="20%" align="center"><a accesskey="h" href="index.html">Home</a></td>
<td width="40%" align="right" valign="top"> Chapter 4. Running Icinga</td>
</tr>
</table>
</div>
<P class="copyright">© 1999-2009 Ethan Galstad, 2009-2017 Icinga Development Team, https://www.icinga.com</P>
</body>
</html>
|
