1CHECK_OPENMANAGE.C(5) Nagios plugin CHECK_OPENMANAGE.C(5)
2
3
4
6 check_openmanage.conf - Configuration file for check_openmanage
7
9 The file has an ini-style syntax and consists of sections and
10 parameters. A section begins with the name of the section in square
11 brackets and continues until the next section begins. An example of
12 section with two keywords and parameters:
13
14 [section]
15 key1 = boolean
16 key2 = string
17
18
19 The data types used are string (no quotes needed) and bool (with values
20 of “TRUE/FALSE”). For boolean values, “1”, “on” and “true” are
21 equivalent, likewise for “0”, “off” and “false”. They are also case
22 insensitive.
23
24 The root section or global section has no section name in brackets:
25
26 key1 = value1
27 key2 = value2
28
29 [section]
30 key3 = value3
31 key4 = value4
32
33
34 The values set in a bracket section will override those set in the root
35 section, in case of conflicts.
36
37 Lines starting with “#” or “;” are considered comments and ignored, as
38 are blank lines.
39
40 The configuration file must be a regular file. Owner and group does not
41 matter, but the Nagios user must have read access.
42
44 The section name should correspond to the hostname, i.e. the value
45 passed to the -H or --hostname command line option. The section name
46 itself can be either an exact match to the hostname, or a glob pattern.
47
48 The sections are read in order of significance. The root section is
49 read first. Then any sections with glob patterns that match the
50 hostname are read (alphabetically). Any section whose name is an exact
51 match to the hostname is read last.
52
53 For boolean values, any conflicts are resolved by letting the section
54 with the most significance (closest match to the hostname) override any
55 previous definitions. For string values, they are simply added
56 together.
57
58 Normal shell globbing may be used for the section names. This is
59 limited to “*”, “?” and “[]”. Some examples:
60
61 [web*.example.com]
62 # matches e.g. webmail.example.com
63
64 [pgsql-[34].example.com]
65 # matches pgsql-3.example.com and pgsql-4.example.com
66
67 [login?.example.com]
68 # matches e.g. login1.example.com
69
70
71 CAUTION: Be careful not to have more than one glob pattern section
72 match any single host. This may lead to unpredictable results.
73
75 All configuration file options have a corresponding command line
76 option. Usually, the command line option will override the
77 configuration file option, if used simultaneously.
78
79 Each option is described briefly. For more information about syntax,
80 legal values etc. refer to the corresponding command line option in
81 check_openmanage(8).
82
83 Check control configuration options
84 Any keyword to the --check command line option are accepted in the
85 configuration file, as “check_<keyword>”. These options take boolean
86 values (“true” or “false”). The following keywords are accepted for
87 check control, listed here with their default values:
88
89 check_storage
90 Check storage subsystem (controllers, disks etc.). Default: TRUE
91
92 check_memory
93 Check memory (dimms). Default: TRUE
94
95 check_fans
96 Check chassis fans. Default: TRUE
97
98 check_power
99 Check power supplies. Default: TRUE
100
101 check_temp
102 Check temperature sensors. Default: TRUE
103
104 check_cpu
105 Check CPUs. Default: TRUE
106
107 check_voltage
108 Check voltage sensors. Default: TRUE
109
110 check_batteries
111 Check system batteries. Default: TRUE
112
113 check_amperage
114 Check amperage probes. Default: TRUE
115
116 check_intrusion
117 Check chassis intrusion. Default: TRUE
118
119 check_sdcard
120 Check SD cards. Default: TRUE
121
122 check_esmhealth
123 Check the ESM log health, i.e. fill grade. Default: TRUE
124
125 check_servicetag
126 Check that the service tag (serial number) is sane and not empty.
127 Default: TRUE
128
129 check_esmlog
130 Check the ESM log content. Default: FALSE
131
132 check_alertlog
133 Check the alert log content. Default: FALSE
134
135 check_everything
136 Special option that turns on all checks. Setting this option to
137 "true" will effectively negate any other check options. This option
138 corresponds to the -a or --all command line option.
139
140 If used together with the --check command line option, the command line
141 option will override the configuration file, if there is a conflict.
142
143 For more information about check control, see the CHECK CONTROL section
144 in check_openmanage(8).
145
146 General configuration options
147 blacklist (string)
148 Blacklist components. The argument is a string that uses the same
149 syntax as the -b or --blacklist command line option.
150
151 If used together with the -b or --blacklist command line option,
152 the two blacklists from the config file and command line are merged
153 together.
154
155 For more information about blacklisting, including syntax, see the
156 BLACKLISTING section in check_openmanage(8).
157
158 timeout (integer)
159 The plugin timeout. The argument is number of seconds and should be
160 a positive integer.
161
162 Corresponding command line option: -t, --timeout
163
164 performance_data (boolean or string)
165 Turn on/off performance data reporting. Accepted values are boolean
166 (TRUE/FALSE) or either of the keywords “minimal” and “multiline”.
167
168 Corresponding command line option: -p, --perfdata
169
170 legacy_performance_data (boolean)
171 With version 3.7.0, performance data output changed. The new format
172 is not compatible with the old format. Users who wish to postpone
173 switching to the new performance data API may use this option. This
174 option takes a boolean value.
175
176 Corresponding command line option: --legacy-perfdata
177
178 temperature_unit (char)
179 The temperature unit used for reporting, performance data etc. can
180 be set with the this option.
181
182 Corresponding command line option: --tempunit
183
184 NOTE: The command line option -F or --fahrenheit will override both
185 the command line option and the configuration file option.
186
187 temp_threshold_warning (string)
188 Custom temperature warning limits.
189
190 Corresponding command line option: -w, --warning
191
192 temp_threshold_critical (string)
193 Custom temperature critical limits.
194
195 Corresponding command line option: -c, --critical
196
197 vdisk_critical (boolean)
198 Make all alerts concerning virtual disks appear as critical.
199
200 Corresponding command line option: --vdisk-critical
201
202 SNMP configuration options
203 Several SNMP related options may be set in the configuration file. The
204 configuration file may contain the following SNMP options:
205
206 snmp_community (string)
207 The SNMP community string.
208
209 Corresponding command line option: -C, --community
210
211 snmp_version (string)
212 The SNMP protocol version.
213
214 Corresponding command line option: -P, --protocol
215
216 snmp_port (integer)
217 The remote port number used with SNMP.
218
219 Corresponding command line option: --port
220
221 snmp_use_ipv6 (boolean)
222 Toggle using IPv6 instead of IPv4.
223
224 Corresponding command line option: -6, --ipv6
225
226 snmp_use_tcp (boolean)
227 Toggle using TCP instead of UDP as transport protocol.
228
229 Corresponding command line option: --tcp
230
231 snmp_timeout (integer)
232 Set timeout in seconds for the SNMP object of Net::SNMP.
233
234 Corresponding command line option: --snmp-timeout
235
236 Output configuration options
237 These options gives some control over the output given by the plugin.
238
239 output_servicetag (boolean)
240 Toggle inclusion of the service tag (serial number) of the
241 monitored host in alerts.
242
243 Corresponding command line option: -i, --info
244
245 output_servicestate (boolean)
246 Toggle inclusion of the service state in alerts.
247
248 Corresponding command line option: -s, --state
249
250 output_servicestate_abbr (boolean)
251 Toggle inclusion of the abbreviated service state in alerts.
252
253 Corresponding command line option: -S, --short-state
254
255 output_sysinfo (boolean)
256 Toggle inclusion of a short system information summary in case of
257 alerts.
258
259 Corresponding command line option: -e, --extinfo
260
261 output_blacklist (boolean)
262 Toggle showing any blacklistings in the OK output.
263
264 Corresponding command line option: -B, --show-blacklist
265
266 output_ok_verbosity (integer)
267 This option specifies how much information is shown in the OK
268 output.
269
270 Corresponding command line option: -o, --ok-info
271
272 output_html (boolean or code)
273 This option toggles HTML output. Argument is either a boolean
274 value, or a country or area code. Se check_openmanage(8) for more
275 information and list of supported country and area codes.
276
277 Corresponding command line option: -I, --htmlinfo
278
279 output_post_message (string)
280 Specify one line of information to be shown after alerts.
281
282 Corresponding command line option: --postmsg
283
284 output_hide_servicetag (boolean)
285 This option toggles censoring of the service tag (serial number) in
286 any output from the plugin.
287
288 Corresponding command line option: --hide-servicetag
289
291 The following example shows a typical check_openmanage config, with a
292 global section and a few host sections.
293
294 # Global definitions
295 output_blacklist = true
296 output_ok_verbosity = 3
297 output_sysinfo = true
298 output_html = us
299
300 # Local definitions (exact or glob pattern)
301 [esx??.example.com]
302 blacklist = ctrl_fw=all
303 check_storage = false
304
305 [mysql01.example.com]
306 performance_data = true
307
308 [web0[123].example.com]
309 performance_data = true
310 blacklist = ctrl_driver=all
311
312 [*.hpc.example.com]
313 performance_data = true
314
315
316
318 check_openmanage(8),
319 http://folk.uio.no/trondham/software/check_openmanage.html
320
322 Trond Hasle Amundsen <t.h.amundsen@usit.uio.no>
323
324
325
326check_openmanage 07/22/2022 CHECK_OPENMANAGE.C(5)