check_openmanage.conf (5) - Linux Manuals

check_openmanage.conf: Configuration file for check_openmanage

Command to display check_openmanage.conf manual in Linux: $ man 5 check_openmanage.conf

NAME

check_openmanage.conf - Configuration file for check_openmanage

FILE FORMAT

The file has an ini-style syntax and consists of sections and parameters. A section begins with the name of the section in square brackets and continues until the next section begins. An example of section with two keywords and parameters:

        [section]
            key1 = boolean
            key2 = string

The data types used are string (no quotes needed) and bool (with values of "TRUE/FALSE"). For boolean values, "1", "on" and "true" are equivalent, likewise for "0", "off" and "false". They are also case insensitive.

The root section or global section has no section name in brackets:

        key1 = value1
        key2 = value2
        
        [section]
            key3 = value3
            key4 = value4

The values set in a bracket section will override those set in the root section, in case of conflicts.

Lines starting with "#" or ";" are considered comments and ignored, as are blank lines.

The configuration file must be a regular file. Owner and group does not matter, but the Nagios user must have read access.

SECTIONS AND ORDERING

The section name should correspond to the hostname, i.e. the value passed to the -H or --hostname command line option. The section name itself can be either an exact match to the hostname, or a glob pattern.

The sections are read in order of significance. The root section is read first. Then any sections with glob patterns that match the hostname are read (alphabetically). Any section whose name is an exact match to the hostname is read last.

For boolean values, any conflicts are resolved by letting the section with the most significance (closest match to the hostname) override any previous definitions. For string values, they are simply added together.

Normal shell globbing may be used for the section names. This is limited to "*", "?" and "[]". Some examples:

        [web*.example.com]
            # matches e.g. webmail.example.com

        [pgsql-[34].example.com]
            # matches pgsql-3.example.com and pgsql-4.example.com

        [login?.example.com]
            # matches e.g. login1.example.com

CAUTION: Be careful not to have more than one glob pattern section match any single host. This may lead to unpredictable results.

CONFIGURATION

All configuration file options have a corresponding command line option. Usually, the command line option will override the configuration file option, if used simultaneously.

Each option is described briefly. For more information about syntax, legal values etc. refer to the corresponding command line option in check_openmanage(8).

Check control configuration options

Any keyword to the --check command line option are accepted in the configuration file, as "check_<keyword>". These options take boolean values ("true" or "false"). The following keywords are accepted for check control, listed here with their default values:

check_storage

: Check storage subsystem (controllers, disks etc.). Default: TRUE

check_memory

: Check memory (dimms). Default: TRUE

check_fans

: Check chassis fans. Default: TRUE

check_power

: Check power supplies. Default: TRUE

check_temp

: Check temperature sensors. Default: TRUE

check_cpu

: Check CPUs. Default: TRUE

check_voltage

: Check voltage sensors. Default: TRUE

check_batteries

: Check system batteries. Default: TRUE

check_amperage

: Check amperage probes. Default: TRUE

check_intrusion

: Check chassis intrusion. Default: TRUE

check_sdcard

: Check SD cards. Default: TRUE

check_esmhealth

: Check the ESM log health, i.e. fill grade. Default: TRUE

check_servicetag

: Check that the service tag (serial number) is sane and not empty. Default: TRUE

check_esmlog

: Check the ESM log content. Default: FALSE

check_alertlog

: Check the alert log content. Default: FALSE

check_everything

: Special option that turns on all checks. Setting this option to "true" will effectively negate any other check options. This option corresponds to the -a or --all command line option.

If used together with the --check command line option, the command line option will override the configuration file, if there is a conflict.

For more information about check control, see the CHECK CONTROL section in check_openmanage(8).

General configuration options

blacklist (string)

Blacklist components. The argument is a string that uses the same syntax as the -b or --blacklist command line option.

If used together with the -b or --blacklist command line option, the two blacklists from the config file and command line are merged together.

For more information about blacklisting, including syntax, see the BLACKLISTING section in check_openmanage(8).

timeout (integer)

: The plugin timeout. The argument is number of seconds and should be a positive integer.
Corresponding command line option: -t, --timeout

performance_data (boolean or string)

: Turn on/off performance data reporting. Accepted values are boolean (TRUE/FALSE) or either of the keywords "minimal" and "multiline".
Corresponding command line option: -p, --perfdata

legacy_performance_data (boolean)

: With version 3.7.0, performance data output changed. The new format is not compatible with the old format. Users who wish to postpone switching to the new performance data API may use this option. This option takes a boolean value.
Corresponding command line option: --legacy-perfdata

temperature_unit (char)

The temperature unit used for reporting, performance data etc. can be set with the this option.

Corresponding command line option: --tempunit

NOTE: The command line option -F or --fahrenheit will override both the command line option and the configuration file option.

temp_threshold_warning (string)

: Custom temperature warning limits.
Corresponding command line option: -w, --warning

temp_threshold_critical (string)

: Custom temperature critical limits.
Corresponding command line option: -c, --critical

vdisk_critical (boolean)

: Make all alerts concerning virtual disks appear as critical.
Corresponding command line option: --vdisk-critical

SNMP configuration options

Several SNMP related options may be set in the configuration file. The configuration file may contain the following SNMP options:

snmp_community (string)

: The SNMP community string.
Corresponding command line option: -C, --community

snmp_version (string)

: The SNMP protocol version.
Corresponding command line option: -P, --protocol

snmp_port (integer)

: The remote port number used with SNMP.
Corresponding command line option: --port

snmp_use_ipv6 (boolean)

: Toggle using IPv6 instead of IPv4.
Corresponding command line option: -6, --ipv6

snmp_use_tcp (boolean)

: Toggle using TCP instead of UDP as transport protocol.
Corresponding command line option: --tcp

snmp_timeout (integer)

: Set timeout in seconds for the SNMP object of Net::SNMP.
Corresponding command line option: --snmp-timeout

Output configuration options

These options gives some control over the output given by the plugin.

output_servicetag (boolean)

: Toggle inclusion of the service tag (serial number) of the monitored host in alerts.
Corresponding command line option: -i, --info

output_servicestate (boolean)

: Toggle inclusion of the service state in alerts.
Corresponding command line option: -s, --state

output_servicestate_abbr (boolean)

: Toggle inclusion of the abbreviated service state in alerts.
Corresponding command line option: -S, --short-state

output_sysinfo (boolean)

: Toggle inclusion of a short system information summary in case of alerts.
Corresponding command line option: -e, --extinfo

output_blacklist (boolean)

: Toggle showing any blacklistings in the OK output.
Corresponding command line option: -B, --show-blacklist

output_ok_verbosity (integer)

: This option specifies how much information is shown in the OK output.
Corresponding command line option: -o, --ok-info

output_html (boolean or code)

: This option toggles HTML output. Argument is either a boolean value, or a country or area code. Se check_openmanage(8) for more information and list of supported country and area codes.
Corresponding command line option: -I, --htmlinfo

output_post_message (string)

: Specify one line of information to be shown after alerts.
Corresponding command line option: --postmsg

output_hide_servicetag (boolean)

: This option toggles censoring of the service tag (serial number) in any output from the plugin.
Corresponding command line option: --hide-servicetag

EXAMPLE

The following example shows a typical check_openmanage config, with a global section and a few host sections.

# Global definitions
output_blacklist = true
output_ok_verbosity = 3
output_sysinfo = true
output_html = us

# Local definitions (exact or glob pattern)
[esx??.example.com]
    blacklist = ctrl_fw=all
    check_storage = false

[mysql01.example.com]
    performance_data = true

[web0[123].example.com]
    performance_data = true
    blacklist = ctrl_driver=all

[*.hpc.example.com]
    performance_data = true

AUTHORS

Trond Hasle Amundsen <t.h.amundsen [at] usit.uio.no>