check_openmanage.conf.pod

   1 # Man page created with:
   2 #
   3 #  pod2man -s 5 -r "`./check_openmanage -V | head -n 1`" -c 'Nagios plugin' check_openmanage.conf.pod check_openmanage.conf.5
   4 #
   5 # $Id: check_openmanage.pod 20039 2011-04-26 09:56:56Z trondham $
   6
   7 =head1 NAME
   8
   9 F<check_openmanage.conf> - Configuration file for check_openmanage
  10
  11 =head1 FILE FORMAT
  12
  13 The file has an ini-style syntax and consists of sections and
  14 parameters. A section begins with the name of the section in square
  15 brackets and continues until the next section begins. An example of
  16 section with two keywords and parameters:
  17
  18 =over 8
  19
  20 I<[section]>
  21     I<key1> = I<boolean>
  22     I<key2> = I<string>
  23
  24 =back
  25
  26 The data types used are string (no quotes needed) and bool (with
  27 values of C<TRUE/FALSE>). For boolean values, C<1>, C<on> and C<true>
  28 are equivalent, likewise for C<0>, C<off> and C<false>. They are also
  29 case insensitive.
  30
  31 The root section or global section has no section name in brackets,
  32 example:
  33
  34         key1 = false
  35         key2 = foo
  36
  37         [section]
  38             key1 = true
  39             key2 = bar
  40
  41 The values set in a bracket section will override those set in the
  42 root section, in case of conflicts.
  43
  44 Lines starting with C<#> or C<;> are considered comments and ignored, as
  45 are blank lines.
  46
  47 The configuration file must be a regular file. Owner and group does
  48 not matter, but the Nagios user must have read access.
  49
  50 =head1 SECTIONS AND ORDERING
  51
  52 The section name should correspond to the hostname, i.e. the value
  53 passed to the C<-H> or C<--hostname> parameter. The section name
  54 itself can be either an exact match to the hostname, or a glob
  55 pattern, as this example shows:
  56
  57         key1 = true
  58         key2 = foo
  59
  60         [192.168.1.2]
  61             key1 = true
  62
  63         [192.168.*]
  64             key1 = false
  65             key2 = bar
  66
  67 The sections are read in order of significance. The root section is
  68 read first. Then any sections with glob patterns that match the
  69 hostname are read (alphabetically). Any section whose name is an exact
  70 match to the hostname is read last.
  71
  72 For boolean values, any conflicts are resolved by letting the section
  73 with the most significance (closest match to the hostname) override
  74 any previous definitions. For string values, they are simply added
  75 together.
  76
  77 In the example above, for the host C<192.168.1.2> the value of I<key1>
  78 will be I<true> and I<key2> will be I<bar>. Any other host that
  79 matches C<192.168.*> will have I<key1 = false> and I<key2 = bar>. All
  80 other hosts will have I<key1 = true> and I<key2 = foo>.
  81
  82 Normal shell globbing may be used for the section names. This is
  83 limited to C<*>, C<?> and C<[]>. Some examples:
  84
  85         [192.168.*]
  86             # matches e.g. 192.168.10.20
  87
  88         [192.168.10[34].1]
  89             # matches 192.168.103.1 and 192.168.104.1
  90
  91         [login?.example.com]
  92             # mathces e.g. login1.example.com
  93
  94 CAUTION! Be careful not to have more than one glob pattern section
  95 match any single host. This may lead to unpredictable results.
  96
  97 =head1 COMMAND LINE OPTIONS
  98
  99 Unless otherwise  noted, options given in the configuration file will
 100 override any corresponding command line options.
 101
 102 In general, avoid using the same options on command line and in the
 103 configuration file.
 104
 105 =head1 CONFIGURATION
 106
 107 =head2 GENERAL
 108
 109 =over 4
 110
 111 =item Check control
 112
 113 Any keyword to the C<--check> parameter are accepted in the
 114 configuration file, as C<check_I<KEYWORD>>. These options take boolean
 115 values (C<true> or C<false>). The following keywords are accepted for
 116 check control, listed here with their default values:
 117
 118         check_storage = true
 119         check_memory = true
 120         check_fans = true
 121         check_power = true
 122         check_temp = true
 123         check_cpu = true
 124         check_voltage = true
 125         check_batteries = true
 126         check_amperage = true
 127         check_intrusion = true
 128         check_sdcard = true
 129         check_esmhealth = true
 130         check_esmlog = false
 131         check_alertlog = false
 132         check_everything = false
 133
 134 If used together with the C<--check> command line option, the command
 135 line option will override the configuration file, if there is a
 136 conflict.
 137
 138 The option C<check_everything> is special and turns on all
 139 checks. Setting this option to "true" will effectively negate any
 140 other check options. This option corresponds to the C<-a> or C<--all>
 141 command line option.
 142
 143 For more information about check control, see
 144 L<check_openmanage(8)/CHECK CONTROL>.
 145
 146 =item Blacklisting
 147
 148 For blacklisting the keyword C<blacklist> is used, and the value is a
 149 string that uses the same syntax as the C<-b> or C<--blacklist>
 150 parameter. Example:
 151
 152     blacklist = ctrl_fw=all/pdisk=0:0:1
 153
 154 If used together with the C<-b> or C<--blacklist> command line option,
 155 the two blacklists from the config file and command line are merged
 156 together.
 157
 158 For more information about blacklisting, including syntax, see
 159 L<check_openmanage(8)/BLACKLISTING>.
 160
 161 =item Timeout
 162
 163 The plugin timeout can be configured with the C<timeout> keyword. The
 164 argument is number of seconds and should be a positive
 165 integer. Example:
 166
 167     timeout = 60
 168
 169 The corresponding command line option is C<-t> or C<--timeout>.
 170
 171 =item Performance data
 172
 173 Performance data can be turned on in the configuration file with
 174 C<performance_data>. Accepted values are boolean (TRUE/FALSE) or
 175 either of the keywords "minimal" and "multiline". Example:
 176
 177     performance_data = true
 178
 179 The corresponding command line option is C<-p> or <--perfdata>.
 180
 181 =item Temperature unit
 182
 183 The temperature unit used for reporting, performance data etc. can be
 184 set with the C<temperature_unit> option. Allowed values are C<F> for
 185 Fahrenheit, C<C> for Celsius, C<K> for Kelvin and C<R> for
 186 Rankine. Example:
 187
 188     temperature_unit = F
 189
 190 The corresponding command line option is C<--tempunit>. Note that the
 191 command line option C<-F> or C<--fahrenheit> will override both the
 192 command line option and the configuration file option.
 193
 194 =item Temperature limits
 195
 196 Custom temperature limits may be configured with the options
 197 C<temp_threshold_warning> and C<temp_threshold_critical>. These
 198 options corresponds to the command line options C<-w> or C<--warning>
 199 and C<-c> or C<--critical>, respectively. They take the same arguments
 200 as the command line options. Examples:
 201
 202     temp_threshold_warning = 0=30/10
 203     temp_threshold_critical = 0=35/8
 204
 205 =back
 206
 207 =head2 SNMP OPTIONS
 208
 209 Several SNMP related options may be set in the configuration file. The
 210 configuration file may contain the following SNMP options:
 211
 212 =over 4
 213
 214 =item SNMP community string
 215
 216 The SNMP community string can be set with C<snmp_community>. Example:
 217
 218     snmp_community = mycommunity
 219
 220 Corresponding command line option: C<-C> or C<--community>
 221
 222 =item SNMP protocol version
 223
 224 The SNMP protocol version can be set with C<snmp_version>. Example:
 225
 226     snmp_version = 2
 227
 228 Corresponding command line option: C<-P> or C<--protocol>
 229
 230 =item SNMP port number
 231
 232 The remote port number used with SNMP can be set with
 233 C<snmp_port>. Example:
 234
 235     snmp_port = 161
 236
 237 Corresponding command line option: C<--port>
 238
 239 =item Use IPv6 instead of IPv4
 240
 241 The option C<snmp_use_ipv6> instructs the plugin to use IPv6 instead
 242 of IPv4. This option takes a boolean value. Example:
 243
 244     snmp_use_ipv6 = true
 245
 246 Corresponding command line option: C<-6> or C<--ipv6>
 247
 248 =item Use TCP instead of UDP
 249
 250 The option C<snmp_use_ipv6> instructs the plugin to use IPv6 instead
 251 of IPv4. This option takes a boolean value. Example:
 252
 253     snmp_use_tcp = true
 254
 255 Corresponding command line option: C<--tcp>
 256
 257 =back
 258
 259 =head2 OUTPUT CONTROL
 260
 261 These options gives some control over the output given by the plugin.
 262
 263 =over 4
 264
 265 =item Include servicetag in alerts
 266
 267 The option C<output_servicetag> will make the plugin include the
 268 servers servicetag (serial number) in every alert. This option takes a
 269 boolean value. Example:
 270
 271     output_servicetag = true
 272
 273 Corresponding command line option: C<-i> or C<--info>
 274
 275 =item Include service state in alerts
 276
 277 The option C<output_servicestate> will make the plugin include the
 278 service state in any alerts. This option takes a boolean
 279 value. Example:
 280
 281     output_servicestate = true
 282
 283 Corresponding command line option: C<-s> or C<--state>
 284
 285 =item Include abbreviated service state in alerts
 286
 287 The option C<output_servicestate_abbr> will make the plugin include
 288 the abbreviated service state in any alerts. This option takes a
 289 boolean value. Example:
 290
 291     output_servicestate_abbr = true
 292
 293 Corresponding command line option: C<-S> or C<--short-state>
 294
 295 =item Show system info with alerts
 296
 297 The option C<output_sysinfo> will make the plugin output some system
 298 information with alerts. This option takes a boolean value. Example:
 299
 300     output_sysinfo = true
 301
 302 Corresponding command line option: C<-e> or C<--extinfo>
 303
 304 =item Show blacklistings in OK output
 305
 306 The option C<output_blacklist> will make the plugin show any
 307 blacklistings in the OK output. This option takes a boolean
 308 value. Example:
 309
 310     output_blacklist = true
 311
 312 Corresponding command line option: C<-B> or C<--show-blacklist>
 313
 314 =item Verbosity of OK output
 315
 316 The option C<output_ok_verbosity> lets you adjust how much information
 317 is shown in the OK output. This option takes a positive integer as
 318 parameter. Example:
 319
 320     output_ok_verbosity = 3
 321
 322 Corresponding command line option: C<-o> or C<--ok-info>
 323
 324 =item HTML output
 325
 326 The output C<output_html> makes the plugin produce HTML output. This
 327 option takes either a boolean value, or a country or area
 328 code. Example:
 329
 330     output_html = de
 331
 332 Corresponding command line option: C<-I> or C<--htmlinfo>
 333
 334 =item Custom line after alerts
 335
 336 The option C<output_post_message> lets you specify one line of
 337 information to be shown after any alerts. This option takes a string
 338 as parameter. Examples:
 339
 340     output_post_message = OS: %o %r
 341     output_post_message = NOTE: Handled in ticket 123456
 342
 343 For more information about codes and formatting, see the corresponding
 344 command line option C<--postmsg> in L<check_openmanage(8)>.
 345
 346 =back
 347
 348 =head1 SEE ALSO
 349
 350 L<check_openmanage(8)>
 351 L<http://folk.uio.no/trondham/software/check_openmanage.html>
 352
 353 =cut