Debian Codegraph @

autotests/html/nagios.cfg.dark.html

raw
1 <!DOCTYPE html>
2 <html><head>
3 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/>
4 <title>nagios.cfg</title>
5 <meta name="generator" content="KF5::SyntaxHighlighting - Definition (Nagios) - Theme (Breeze Dark)"/>
6 </head><body style="background-color:#232629;color:#cfcfc2"><pre>
7 <span style="color:#7a7c7d">##############################################################################</span>
8 <span style="color:#7a7c7d">#</span>
9 <span style="color:#7a7c7d"># NAGIOS.CFG - Sample Main Config File for Nagios @VERSION@</span>
10 <span style="color:#7a7c7d">#</span>
11 <span style="color:#7a7c7d"># Read the documentation for more information on this configuration</span>
12 <span style="color:#7a7c7d"># file. I've provided some comments here, but things may not be so</span>
13 <span style="color:#7a7c7d"># clear without further explanation.</span>
14 <span style="color:#7a7c7d">#</span>
15 <span style="color:#7a7c7d">#</span>
16 <span style="color:#7a7c7d">##############################################################################</span>
17
18
19 <span style="color:#7a7c7d"># LOG FILE</span>
20 <span style="color:#7a7c7d"># This is the main log file where service and host events are logged</span>
21 <span style="color:#7a7c7d"># for historical purposes. This should be the first option specified</span>
22 <span style="color:#7a7c7d"># in the config file!!!</span>
23
24 log_file<span style="color:#27ae60">=</span><span style="color:#f44f4f">@localstatedir@/nagios.log</span>
25
26
27
28 <span style="color:#7a7c7d"># OBJECT CONFIGURATION FILE(S)</span>
29 <span style="color:#7a7c7d"># These are the object configuration files in which you define hosts,</span>
30 <span style="color:#7a7c7d"># host groups, contacts, contact groups, services, etc.</span>
31 <span style="color:#7a7c7d"># You can split your object definitions across several config files</span>
32 <span style="color:#7a7c7d"># if you wish (as shown below), or keep them all in a single config file.</span>
33
34 <span style="color:#7a7c7d"># You can specify individual object config files as shown below:</span>
35 cfg_file<span style="color:#27ae60">=</span><span style="color:#f44f4f">@sysconfdir@/objects/commands.cfg</span>
36 cfg_file<span style="color:#27ae60">=</span><span style="color:#f44f4f">@sysconfdir@/objects/contacts.cfg</span>
37 cfg_file<span style="color:#27ae60">=</span><span style="color:#f44f4f">@sysconfdir@/objects/timeperiods.cfg</span>
38 cfg_file<span style="color:#27ae60">=</span><span style="color:#f44f4f">@sysconfdir@/objects/templates.cfg</span>
39
40 <span style="color:#7a7c7d"># Definitions for monitoring the local (Linux) host</span>
41 cfg_file<span style="color:#27ae60">=</span><span style="color:#f44f4f">@sysconfdir@/objects/localhost.cfg</span>
42
43 <span style="color:#7a7c7d"># Definitions for monitoring a Windows machine</span>
44 <span style="color:#7a7c7d">#cfg_file=@sysconfdir@/objects/windows.cfg</span>
45
46 <span style="color:#7a7c7d"># Definitions for monitoring a router/switch</span>
47 <span style="color:#7a7c7d">#cfg_file=@sysconfdir@/objects/switch.cfg</span>
48
49 <span style="color:#7a7c7d"># Definitions for monitoring a network printer</span>
50 <span style="color:#7a7c7d">#cfg_file=@sysconfdir@/objects/printer.cfg</span>
51
52
53 <span style="color:#7a7c7d"># You can also tell Nagios to process all config files (with a .cfg</span>
54 <span style="color:#7a7c7d"># extension) in a particular directory by using the cfg_dir</span>
55 <span style="color:#7a7c7d"># directive as shown below:</span>
56
57 <span style="color:#7a7c7d">#cfg_dir=@sysconfdir@/servers</span>
58 <span style="color:#7a7c7d">#cfg_dir=@sysconfdir@/printers</span>
59 <span style="color:#7a7c7d">#cfg_dir=@sysconfdir@/switches</span>
60 <span style="color:#7a7c7d">#cfg_dir=@sysconfdir@/routers</span>
61
62
63
64
65 <span style="color:#7a7c7d"># OBJECT CACHE FILE</span>
66 <span style="color:#7a7c7d"># This option determines where object definitions are cached when</span>
67 <span style="color:#7a7c7d"># Nagios starts/restarts. The CGIs read object definitions from</span>
68 <span style="color:#7a7c7d"># this cache file (rather than looking at the object config files</span>
69 <span style="color:#7a7c7d"># directly) in order to prevent inconsistencies that can occur</span>
70 <span style="color:#7a7c7d"># when the config files are modified after Nagios starts.</span>
71
72 object_cache_file<span style="color:#27ae60">=</span><span style="color:#f44f4f">@localstatedir@/objects.cache</span>
73
74
75
76 <span style="color:#7a7c7d"># PRE-CACHED OBJECT FILE</span>
77 <span style="color:#7a7c7d"># This options determines the location of the precached object file.</span>
78 <span style="color:#7a7c7d"># If you run Nagios with the -p command line option, it will preprocess</span>
79 <span style="color:#7a7c7d"># your object configuration file(s) and write the cached config to this</span>
80 <span style="color:#7a7c7d"># file. You can then start Nagios with the -u option to have it read</span>
81 <span style="color:#7a7c7d"># object definitions from this precached file, rather than the standard</span>
82 <span style="color:#7a7c7d"># object configuration files (see the cfg_file and cfg_dir options above).</span>
83 <span style="color:#7a7c7d"># Using a precached object file can speed up the time needed to (re)start</span>
84 <span style="color:#7a7c7d"># the Nagios process if you've got a large and/or complex configuration.</span>
85 <span style="color:#7a7c7d"># Read the documentation section on optimizing Nagios to find our more</span>
86 <span style="color:#7a7c7d"># about how this feature works.</span>
87
88 precached_object_file<span style="color:#27ae60">=</span><span style="color:#f44f4f">@localstatedir@/objects.precache</span>
89
90
91
92 <span style="color:#7a7c7d"># RESOURCE FILE</span>
93 <span style="color:#7a7c7d"># This is an optional resource file that contains $USERx$ macro</span>
94 <span style="color:#7a7c7d"># definitions. Multiple resource files can be specified by using</span>
95 <span style="color:#7a7c7d"># multiple resource_file definitions. The CGIs will not attempt to</span>
96 <span style="color:#7a7c7d"># read the contents of resource files, so information that is</span>
97 <span style="color:#7a7c7d"># considered to be sensitive (usernames, passwords, etc) can be</span>
98 <span style="color:#7a7c7d"># defined as macros in this file and restrictive permissions (600)</span>
99 <span style="color:#7a7c7d"># can be placed on this file.</span>
100
101 resource_file<span style="color:#27ae60">=</span><span style="color:#f44f4f">@sysconfdir@/resource.cfg</span>
102
103
104
105 <span style="color:#7a7c7d"># STATUS FILE</span>
106 <span style="color:#7a7c7d"># This is where the current status of all monitored services and</span>
107 <span style="color:#7a7c7d"># hosts is stored. Its contents are read and processed by the CGIs.</span>
108 <span style="color:#7a7c7d"># The contents of the status file are deleted every time Nagios</span>
109 <span style="color:#7a7c7d"># restarts.</span>
110
111 status_file<span style="color:#27ae60">=</span><span style="color:#f44f4f">@localstatedir@/status.dat</span>
112
113
114
115 <span style="color:#7a7c7d"># STATUS FILE UPDATE INTERVAL</span>
116 <span style="color:#7a7c7d"># This option determines the frequency (in seconds) that</span>
117 <span style="color:#7a7c7d"># Nagios will periodically dump program, host, and</span>
118 <span style="color:#7a7c7d"># service status data.</span>
119
120 status_update_interval<span style="color:#27ae60">=</span><span style="color:#f67400">10</span>
121
122
123
124 <span style="color:#7a7c7d"># NAGIOS USER</span>
125 <span style="color:#7a7c7d"># This determines the effective user that Nagios should run as.</span>
126 <span style="color:#7a7c7d"># You can either supply a username or a UID.</span>
127
128 nagios_user<span style="color:#27ae60">=</span><span style="color:#f44f4f">@nagios_user@</span>
129
130
131
132 <span style="color:#7a7c7d"># NAGIOS GROUP</span>
133 <span style="color:#7a7c7d"># This determines the effective group that Nagios should run as.</span>
134 <span style="color:#7a7c7d"># You can either supply a group name or a GID.</span>
135
136 nagios_group<span style="color:#27ae60">=</span><span style="color:#f44f4f">@nagios_grp@</span>
137
138
139
140 <span style="color:#7a7c7d"># EXTERNAL COMMAND OPTION</span>
141 <span style="color:#7a7c7d"># This option allows you to specify whether or not Nagios should check</span>
142 <span style="color:#7a7c7d"># for external commands (in the command file defined below).</span>
143 <span style="color:#7a7c7d"># By default Nagios will check for external commands.</span>
144 <span style="color:#7a7c7d"># If you want to be able to use the CGI command interface</span>
145 <span style="color:#7a7c7d"># you will have to enable this.</span>
146 <span style="color:#7a7c7d"># Values: 0 = disable commands, 1 = enable commands</span>
147
148 check_external_commands<span style="color:#27ae60">=</span><span style="color:#f67400">1</span>
149
150
151
152 <span style="color:#7a7c7d"># EXTERNAL COMMAND FILE</span>
153 <span style="color:#7a7c7d"># This is the file that Nagios checks for external command requests.</span>
154 <span style="color:#7a7c7d"># It is also where the command CGI will write commands that are submitted</span>
155 <span style="color:#7a7c7d"># by users, so it must be writeable by the user that the web server</span>
156 <span style="color:#7a7c7d"># is running as (usually 'nobody'). Permissions should be set at the</span>
157 <span style="color:#7a7c7d"># directory level instead of on the file, as the file is deleted every</span>
158 <span style="color:#7a7c7d"># time its contents are processed.</span>
159
160 command_file<span style="color:#27ae60">=</span><span style="color:#f44f4f">@localstatedir@/rw/nagios.cmd</span>
161
162
163
164 <span style="color:#7a7c7d"># QUERY HANDLER INTERFACE</span>
165 <span style="color:#7a7c7d"># This is the socket that is created for the Query Handler interface</span>
166
167 <span style="color:#7a7c7d">#query_socket=@localstatedir@/rw/nagios.qh</span>
168
169
170
171 <span style="color:#7a7c7d"># LOCK FILE</span>
172 <span style="color:#7a7c7d"># This is the lockfile that Nagios will use to store its PID number</span>
173 <span style="color:#7a7c7d"># in when it is running in daemon mode.</span>
174
175 lock_file<span style="color:#27ae60">=</span><span style="color:#f44f4f">@subsyslockfile@</span>
176
177
178
179 <span style="color:#7a7c7d"># TEMP FILE</span>
180 <span style="color:#7a7c7d"># This is a temporary file that is used as scratch space when Nagios</span>
181 <span style="color:#7a7c7d"># updates the status log, cleans the comment file, etc. This file</span>
182 <span style="color:#7a7c7d"># is created, used, and deleted throughout the time that Nagios is</span>
183 <span style="color:#7a7c7d"># running.</span>
184
185 temp_file<span style="color:#27ae60">=</span><span style="color:#f44f4f">@localstatedir@/nagios.tmp</span>
186
187
188
189 <span style="color:#7a7c7d"># TEMP PATH</span>
190 <span style="color:#7a7c7d"># This is path where Nagios can create temp files for service and</span>
191 <span style="color:#7a7c7d"># host check results, etc.</span>
192
193 temp_path<span style="color:#27ae60">=</span><span style="color:#f44f4f">@TMPDIR@</span>
194
195
196
197 <span style="color:#7a7c7d"># EVENT BROKER OPTIONS</span>
198 <span style="color:#7a7c7d"># Controls what (if any) data gets sent to the event broker.</span>
199 <span style="color:#7a7c7d"># Values: 0 = Broker nothing</span>
200 <span style="color:#7a7c7d"># -1 = Broker everything</span>
201 <span style="color:#7a7c7d"># &lt;other> = See documentation</span>
202
203 event_broker_options<span style="color:#27ae60">=</span><span style="color:#f44f4f">-</span><span style="color:#f67400">1</span>
204
205
206
207 <span style="color:#7a7c7d"># EVENT BROKER MODULE(S)</span>
208 <span style="color:#7a7c7d"># This directive is used to specify an event broker module that should</span>
209 <span style="color:#7a7c7d"># by loaded by Nagios at startup. Use multiple directives if you want</span>
210 <span style="color:#7a7c7d"># to load more than one module. Arguments that should be passed to</span>
211 <span style="color:#7a7c7d"># the module at startup are separated from the module path by a space.</span>
212 <span style="color:#7a7c7d">#</span>
213 <span style="color:#7a7c7d">#!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!</span>
214 <span style="color:#7a7c7d"># </span><span style="color:#ca9219;background-color:#451e1a;font-weight:bold">WARNING</span><span style="color:#7a7c7d"> !!! </span><span style="color:#ca9219;background-color:#451e1a;font-weight:bold">WARNING</span><span style="color:#7a7c7d"> !!! </span><span style="color:#ca9219;background-color:#451e1a;font-weight:bold">WARNING</span><span style="color:#7a7c7d"> !!! </span><span style="color:#ca9219;background-color:#451e1a;font-weight:bold">WARNING</span><span style="color:#7a7c7d"> !!! </span><span style="color:#ca9219;background-color:#451e1a;font-weight:bold">WARNING</span><span style="color:#7a7c7d"> !!! </span><span style="color:#ca9219;background-color:#451e1a;font-weight:bold">WARNING</span>
215 <span style="color:#7a7c7d">#!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!</span>
216 <span style="color:#7a7c7d">#</span>
217 <span style="color:#7a7c7d"># Do NOT overwrite modules while they are being used by Nagios or Nagios</span>
218 <span style="color:#7a7c7d"># will crash in a fiery display of SEGFAULT glory. This is a bug/limitation</span>
219 <span style="color:#7a7c7d"># either in dlopen(), the kernel, and/or the filesystem. And maybe Nagios...</span>
220 <span style="color:#7a7c7d">#</span>
221 <span style="color:#7a7c7d"># The correct/safe way of updating a module is by using one of these methods:</span>
222 <span style="color:#7a7c7d"># 1. Shutdown Nagios, replace the module file, restart Nagios</span>
223 <span style="color:#7a7c7d"># 2. Delete the original module file, move the new module file into place,</span>
224 <span style="color:#7a7c7d"># restart Nagios</span>
225 <span style="color:#7a7c7d">#</span>
226 <span style="color:#7a7c7d"># Example:</span>
227 <span style="color:#7a7c7d">#</span>
228 <span style="color:#7a7c7d"># broker_module=&lt;modulepath> [moduleargs]</span>
229
230 <span style="color:#7a7c7d">#broker_module=/somewhere/module1.o</span>
231 <span style="color:#7a7c7d">#broker_module=/somewhere/module2.o arg1 arg2=3 debug=0</span>
232
233
234
235 <span style="color:#7a7c7d"># LOG ROTATION METHOD</span>
236 <span style="color:#7a7c7d"># This is the log rotation method that Nagios should use to rotate</span>
237 <span style="color:#7a7c7d"># the main log file. Values are as follows..</span>
238 <span style="color:#7a7c7d"># n = None - don't rotate the log</span>
239 <span style="color:#7a7c7d"># h = Hourly rotation (top of the hour)</span>
240 <span style="color:#7a7c7d"># d = Daily rotation (midnight every day)</span>
241 <span style="color:#7a7c7d"># w = Weekly rotation (midnight on Saturday evening)</span>
242 <span style="color:#7a7c7d"># m = Monthly rotation (midnight last day of month)</span>
243
244 log_rotation_method<span style="color:#27ae60">=</span><span style="color:#f44f4f">d</span>
245
246
247
248 <span style="color:#7a7c7d"># LOG ARCHIVE PATH</span>
249 <span style="color:#7a7c7d"># This is the directory where archived (rotated) log files should be</span>
250 <span style="color:#7a7c7d"># placed (assuming you've chosen to do log rotation).</span>
251
252 log_archive_path<span style="color:#27ae60">=</span><span style="color:#f44f4f">@localstatedir@/archives</span>
253
254
255
256 <span style="color:#7a7c7d"># LOGGING OPTIONS</span>
257 <span style="color:#7a7c7d"># If you want messages logged to the syslog facility, as well as the</span>
258 <span style="color:#7a7c7d"># Nagios log file set this option to 1. If not, set it to 0.</span>
259
260 use_syslog<span style="color:#27ae60">=</span><span style="color:#f67400">1</span>
261
262
263
264 <span style="color:#7a7c7d"># NOTIFICATION LOGGING OPTION</span>
265 <span style="color:#7a7c7d"># If you don't want notifications to be logged, set this value to 0.</span>
266 <span style="color:#7a7c7d"># If notifications should be logged, set the value to 1.</span>
267
268 log_notifications<span style="color:#27ae60">=</span><span style="color:#f67400">1</span>
269
270
271
272 <span style="color:#7a7c7d"># SERVICE RETRY LOGGING OPTION</span>
273 <span style="color:#7a7c7d"># If you don't want service check retries to be logged, set this value</span>
274 <span style="color:#7a7c7d"># to 0. If retries should be logged, set the value to 1.</span>
275
276 log_service_retries<span style="color:#27ae60">=</span><span style="color:#f67400">1</span>
277
278
279
280 <span style="color:#7a7c7d"># HOST RETRY LOGGING OPTION</span>
281 <span style="color:#7a7c7d"># If you don't want host check retries to be logged, set this value to</span>
282 <span style="color:#7a7c7d"># 0. If retries should be logged, set the value to 1.</span>
283
284 log_host_retries<span style="color:#27ae60">=</span><span style="color:#f67400">1</span>
285
286
287
288 <span style="color:#7a7c7d"># EVENT HANDLER LOGGING OPTION</span>
289 <span style="color:#7a7c7d"># If you don't want host and service event handlers to be logged, set</span>
290 <span style="color:#7a7c7d"># this value to 0. If event handlers should be logged, set the value</span>
291 <span style="color:#7a7c7d"># to 1.</span>
292
293 log_event_handlers<span style="color:#27ae60">=</span><span style="color:#f67400">1</span>
294
295
296
297 <span style="color:#7a7c7d"># INITIAL STATES LOGGING OPTION</span>
298 <span style="color:#7a7c7d"># If you want Nagios to log all initial host and service states to</span>
299 <span style="color:#7a7c7d"># the main log file (the first time the service or host is checked)</span>
300 <span style="color:#7a7c7d"># you can enable this option by setting this value to 1. If you</span>
301 <span style="color:#7a7c7d"># are not using an external application that does long term state</span>
302 <span style="color:#7a7c7d"># statistics reporting, you do not need to enable this option. In</span>
303 <span style="color:#7a7c7d"># this case, set the value to 0.</span>
304
305 log_initial_states<span style="color:#27ae60">=</span><span style="color:#f67400">0</span>
306
307
308
309 <span style="color:#7a7c7d"># CURRENT STATES LOGGING OPTION</span>
310 <span style="color:#7a7c7d"># If you don't want Nagios to log all current host and service states</span>
311 <span style="color:#7a7c7d"># after log has been rotated to the main log file, you can disable this</span>
312 <span style="color:#7a7c7d"># option by setting this value to 0. Default value is 1.</span>
313
314 log_current_states<span style="color:#27ae60">=</span><span style="color:#f67400">1</span>
315
316
317
318 <span style="color:#7a7c7d"># EXTERNAL COMMANDS LOGGING OPTION</span>
319 <span style="color:#7a7c7d"># If you don't want Nagios to log external commands, set this value</span>
320 <span style="color:#7a7c7d"># to 0. If external commands should be logged, set this value to 1.</span>
321 <span style="color:#7a7c7d"># Note: This option does not include logging of passive service</span>
322 <span style="color:#7a7c7d"># checks - see the option below for controlling whether or not</span>
323 <span style="color:#7a7c7d"># passive checks are logged.</span>
324
325 log_external_commands<span style="color:#27ae60">=</span><span style="color:#f67400">1</span>
326
327
328
329 <span style="color:#7a7c7d"># PASSIVE CHECKS LOGGING OPTION</span>
330 <span style="color:#7a7c7d"># If you don't want Nagios to log passive host and service checks, set</span>
331 <span style="color:#7a7c7d"># this value to 0. If passive checks should be logged, set</span>
332 <span style="color:#7a7c7d"># this value to 1.</span>
333
334 log_passive_checks<span style="color:#27ae60">=</span><span style="color:#f67400">1</span>
335
336
337
338 <span style="color:#7a7c7d"># GLOBAL HOST AND SERVICE EVENT HANDLERS</span>
339 <span style="color:#7a7c7d"># These options allow you to specify a host and service event handler</span>
340 <span style="color:#7a7c7d"># command that is to be run for every host or service state change.</span>
341 <span style="color:#7a7c7d"># The global event handler is executed immediately prior to the event</span>
342 <span style="color:#7a7c7d"># handler that you have optionally specified in each host or</span>
343 <span style="color:#7a7c7d"># service definition. The command argument is the short name of a</span>
344 <span style="color:#7a7c7d"># command definition that you define in your host configuration file.</span>
345 <span style="color:#7a7c7d"># Read the HTML docs for more information.</span>
346
347 <span style="color:#7a7c7d">#global_host_event_handler=somecommand</span>
348 <span style="color:#7a7c7d">#global_service_event_handler=somecommand</span>
349 </pre></body></html>