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
|
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<title>CGI Configuration File Options</title>
<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.0.2 Documentation">
<link rel="up" href="ch03.html" title="Chapter 3. Configuring Icinga">
<link rel="prev" href="customobjectvars.html" title="Custom Object Variables">
<link rel="next" href="cgiauth.html" title="Authentication And Authorization In The CGIs">
</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">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="cgiauth.html">Next</a>
</td>
</tr>
</table>
<hr>
</div>
<div class="section" title="CGI Configuration File Options">
<div class="titlepage"><div><div><h2 class="title" style="clear: both">
<a name="configcgi"></a><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/icinga.cfg</em></span>) is installed for you when you follow the <a class="link" href="quickstart.html" title="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="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 NAGIOS_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><span class="bold"><strong>Index</strong></span></p>
<div class="itemizedlist"><ul class="itemizedlist" type="disc">
<li class="listitem">
<p><a class="link" href="configcgi.html#configcgi-main_cfg_file">Main configuration file location</a></p>
</li>
<li class="listitem">
<p><a class="link" href="configcgi.html#configcgi-physical_html_path">Physical HTML path</a></p>
</li>
<li class="listitem">
<p><a class="link" href="configcgi.html#configcgi-url_html_path">URL HTML path</a></p>
</li>
</ul></div>
<div class="itemizedlist"><ul class="itemizedlist" type="disc">
<li class="listitem">
<p><a class="link" href="configcgi.html#configcgi-use_authentication">Authentication usage</a></p>
</li>
<li class="listitem">
<p><a class="link" href="configcgi.html#configcgi-default_user_name">Default user name</a></p>
</li>
<li class="listitem">
<p><a class="link" href="configcgi.html#configcgi-authorized_for_system_information">System/process information access</a></p>
</li>
<li class="listitem">
<p><a class="link" href="configcgi.html#configcgi-authorized_for_system_commands">System/process command access</a></p>
</li>
<li class="listitem">
<p><a class="link" href="configcgi.html#configcgi-authorized_for_configuration_information">Configuration information access</a></p>
</li>
<li class="listitem">
<p><a class="link" href="configcgi.html#configcgi-authorized_for_all_hosts">Global host information access</a></p>
</li>
<li class="listitem">
<p><a class="link" href="configcgi.html#configcgi-authorized_for_all_host_commands">Global host command access</a></p>
</li>
<li class="listitem">
<p><a class="link" href="configcgi.html#configcgi-authorized_for_all_services">Global service information access</a></p>
</li>
<li class="listitem">
<p><a class="link" href="configcgi.html#configcgi-authorized_for_all_service_commands">Global service command access</a></p>
</li>
<li class="listitem">
<p><a class="link" href="configcgi.html#configcgi-show_all_services_host_is_authorized_for">Show all services a host is authorized for</a></p>
</li>
</ul></div>
<div class="itemizedlist"><ul class="itemizedlist" type="disc"><li class="listitem">
<p><a class="link" href="configcgi.html#configcgi-lock_author_names">Lock author names</a></p>
</li></ul></div>
<div class="itemizedlist"><ul class="itemizedlist" type="disc">
<li class="listitem">
<p><a class="link" href="configcgi.html#configcgi-statusmap_background_image">Statusmap CGI background image</a></p>
</li>
<li class="listitem">
<p><a class="link" href="configcgi.html#configcgi-default_statusmap_layout">Default statusmap layout method</a></p>
</li>
<li class="listitem">
<p><a class="link" href="configcgi.html#configcgi-statuswrl_include">Statuswrl CGI include world</a></p>
</li>
<li class="listitem">
<p><a class="link" href="configcgi.html#configcgi-default_statuswrl_layout">Default statuswrl layout method</a></p>
</li>
</ul></div>
<div class="itemizedlist"><ul class="itemizedlist" type="disc">
<li class="listitem">
<p><a class="link" href="configcgi.html#configcgi-refresh_rate">CGI refresh rate</a></p>
</li>
<li class="listitem">
<p><a class="link" href="configcgi.html#configcgi-audio_alerts">Audio alerts</a></p>
</li>
</ul></div>
<div class="itemizedlist"><ul class="itemizedlist" type="disc"><li class="listitem">
<p><a class="link" href="configcgi.html#configcgi-ping_syntax">Ping syntax</a></p>
</li></ul></div>
<div class="itemizedlist"><ul class="itemizedlist" type="disc"><li class="listitem">
<p><a class="link" href="configcgi.html#configcgi-escape_html_tags">Escape HTML tags option</a></p>
</li></ul></div>
<div class="itemizedlist"><ul class="itemizedlist" type="disc">
<li class="listitem">
<p><a class="link" href="configcgi.html#configcgi-notes_url_target">Notes URL target</a></p>
</li>
<li class="listitem">
<p><a class="link" href="configcgi.html#configcgi-action_url_target">Action URL target</a></p>
</li>
</ul></div>
<div class="itemizedlist"><ul class="itemizedlist" type="disc">
<li class="listitem">
<p><a class="link" href="configcgi.html#configcgi-enable_splunk_integration">Splunk integration option</a></p>
</li>
<li class="listitem">
<p><a class="link" href="configcgi.html#configcgi-splunk_url">Splunk URL</a></p>
</li>
</ul></div>
<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"> <span class="bold"><strong>main_config_file=/usr/local/icinga/etc/icinga.cfg</strong></span>
</span> </p></td>
</tr>
</tbody>
</table>
</div>
<p>This specifies the location of your <a class="link" href="configmain.html" title="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"> <span class="bold"><strong>physical_html_path=/usr/local/icinga/share</strong></span>
</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"> <span class="bold"><strong>url_html_path=/icinga</strong></span> </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-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"> <span class="bold"><strong>use_authentication=1</strong></span> </span>
</p></td>
</tr>
</tbody>
</table>
</div>
<p>This option controls whether or not the CGIs will use the authentication and authorization 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 unauthorized
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 authorization
for the CGIs can be found <a class="link" href="cgiauth.html" title="Authentication And Authorization In The CGIs">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 authorization functionality (default)</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"> <span class="bold"><strong>default_user_name=guest</strong></span> </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"> <span class="bold"><strong>authorized_for_system_information=icingaadmin,theboss</strong></span> </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 authorized
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 authorization for the CGIs can be found <a class="link" href="cgiauth.html" title="Authentication And Authorization In The CGIs">here</a>.</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"> <span class="bold"><strong>authorized_for_system_commands=icingaadmin</strong></span>
</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 authorized 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 authorization for the CGIs can be found <a class="link" href="cgiauth.html" title="Authentication And Authorization In The CGIs">here</a>.</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"> <span class="bold"><strong>authorized_for_configuration_information=icingaadmin</strong></span> </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
authorization for the CGIs can be found <a class="link" href="cgiauth.html" title="Authentication And Authorization In The CGIs">here</a>.</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"> <span class="bold"><strong>authorized_for_all_hosts=icingaadmin,theboss</strong></span> </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 authorized to view information for all services. Users in this list
are <span class="emphasis"><em>not</em></span> automatically authorized 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 authorization for the CGIs can be found <a class="link" href="cgiauth.html" title="Authentication And Authorization In The CGIs">here</a>.</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"> <span class="bold"><strong>authorized_for_all_host_commands=icingaadmin</strong></span> </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 authorized to issue commands for all services.
Users in this list are <span class="emphasis"><em>not</em></span> automatically authorized 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 authorization for the CGIs can be found <a class="link" href="cgiauth.html" title="Authentication And Authorization In The CGIs">here</a>.</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"> <span class="bold"><strong>authorized_for_all_services=icingaadmin,theboss</strong></span> </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 authorized to view information for all hosts.
Users in this list are <span class="emphasis"><em>not</em></span> automatically authorized 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 authorization for the CGIs can be found <a class="link" href="cgiauth.html" title="Authentication And Authorization In The CGIs">here</a>.</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"> <span class="bold"><strong>authorized_for_all_service_commands=icingaadmin</strong></span> </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 authorized to issue
commands for all hosts. Users in this list are <span class="emphasis"><em>not</em></span> automatically authorized 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 authorization for the CGIs can be found <a class="link" href="cgiauth.html" title="Authentication And Authorization In The CGIs">here</a>.</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"> <span class="bold"><strong>show_all_services_host_is_authorized_for=1</strong></span>
</span> </p></td>
</tr>
</tbody>
</table>
</div>
<p>By default, a user can see all services on a host, if the user is authorized as contact for the host only. By disabling this option,
the user must be an authorized 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 (included starting with Icinga 1.0.2) </p>
<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"> <span class="bold"><strong>lock_author_names=1</strong></span> </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-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"> <span class="bold"><strong>statusmap_background_image=smbackground.gd2</strong></span>
</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-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"> <span class="bold"><strong>default_statusmap_layout=4</strong></span> </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-statuswrl_include"></a> <span class="bold"><strong>Statuswrl CGI Include World</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>statuswrl_include=<vrml_file></strong></span> </p></td>
</tr>
<tr>
<td align="left" valign="top"><p>Example:</p></td>
<td><p> <span class="color"> <span class="bold"><strong>statuswrl_include=myworld.wrl</strong></span> </span>
</p></td>
</tr>
</tbody>
</table>
</div>
<p>This option allows you to include your own objects in the generated VRML world. It is assumed that the file resides in 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>This file must be a fully qualified VRML world (i.e. you can view it by itself in a VRML browser).</p>
</td></tr>
</table></div>
<p><a name="configcgi-default_statuswrl_layout"></a> <span class="bold"><strong>Default Statuswrl 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_statuswrl_layout=<layout_number></strong></span> </p></td>
</tr>
<tr>
<td align="left" valign="top"><p>Example:</p></td>
<td><p> <span class="color"> <span class="bold"><strong>default_statuswrl_layout=4</strong></span> </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-statuswrl_cgi">statuswrl 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>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>
</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"> <span class="bold"><strong>refresh_rate=90</strong></span> </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-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>
</td>
</tr>
<tr>
<td align="left" valign="top"><p>Examples:</p></td>
<td>
<p>
<span class="color">
<span class="bold"><strong>host_unreachable_sound=hostu.wav</strong></span>
</span>
</p> <p>
<span class="color">
<span class="bold"><strong>host_down_sound=hostd.wav</strong></span>
</span>
</p> <p>
<span class="color">
<span class="bold"><strong>service_critical_sound=critical.wav</strong></span>
</span>
</p> <p>
<span class="color">
<span class="bold"><strong>service_warning_sound=warning.wav</strong></span>
</span>
</p> <p>
<span class="color">
<span class="bold"><strong>service_unknown_sound=unknown.wav</strong></span>
</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-ping_syntax"></a> <span class="bold"><strong>Ping Syntax</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>ping_syntax=<command></strong></span> </p></td>
</tr>
<tr>
<td align="left" valign="top"><p>Example:</p></td>
<td><p> <span class="color"> <span class="bold"><strong>ping_syntax=/bin/ping -n -U -c 5
$HOSTADDRESS$</strong></span> </span> </p></td>
</tr>
</tbody>
</table>
</div>
<p>This option determines what syntax should be used when attempting to ping a host from the WAP interface (using the <a class="link" href="cgis.html#cgis-statuswml_cgi">statuswml CGI</a>. You must include the full path to the ping binary, along with all required options. The
$HOSTADDRESS$ macro is substituted with the address of the host before the command is executed.</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"> <span class="bold"><strong>escape_html_tags=1</strong></span> </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"> <span class="bold"><strong>notes_url_target=_blank</strong></span> </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"> <span class="bold"><strong>action_url_target=_blank</strong></span> </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-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"> <span class="bold"><strong>enable_splunk_integration=1</strong></span> </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"> <span class="bold"><strong>splunk_url=http://127.0.0.1:8000/</strong></span>
</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>
<a class="indexterm" name="id1962243"></a>
<a class="indexterm" name="id1962277"></a>
<a class="indexterm" name="id1962290"></a>
<a class="indexterm" name="id1962302"></a>
<a class="indexterm" name="id1962315"></a>
<a class="indexterm" name="id1962329"></a>
<a class="indexterm" name="id1962316"></a>
<a class="indexterm" name="id1962356"></a>
<a class="indexterm" name="id1962344"></a>
<a class="indexterm" name="id1962384"></a>
<a class="indexterm" name="id1962398"></a>
<a class="indexterm" name="id1962411"></a>
<a class="indexterm" name="id1962399"></a>
<a class="indexterm" name="id1962440"></a>
<a class="indexterm" name="id1962454"></a>
<a class="indexterm" name="id1962441"></a>
<a class="indexterm" name="id1962482"></a>
<a class="indexterm" name="id1962468"></a>
<a class="indexterm" name="id1962510"></a>
<a class="indexterm" name="id1962522"></a>
<a class="indexterm" name="id1962535"></a>
<a class="indexterm" name="id1962524"></a>
<a class="indexterm" name="id1962537"></a>
<a class="indexterm" name="id1962576"></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="cgiauth.html">Next</a>
</td>
</tr>
<tr>
<td width="40%" align="left" valign="top">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"> Authentication And
Authorization In The CGIs</td>
</tr>
</table>
</div>
<P class="copyright">© 2009-2010 Icinga Development Team, http://www.icinga.org</P>
</body>
</html>
|
