CHECK_OPENMANAGE.CONF(5)

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, example:

        key1 = false
        key2 = foo

        [section]
            key1 = true
            key2 = bar

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" parameter. The section name itself can be either an exact match to the hostname, or a glob pattern, as this example shows:

        key1 = true
        key2 = foo

        [192.168.1.2]
            key1 = true

        [192.168.*]
            key1 = false
            key2 = bar

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.

In the example above, for the host 192.168.1.2 the value of key1 will be true and key2 will be bar. Any other host that matches "192.168.*" will have key1 = false and key2 = bar. All other hosts will have key1 = true and key2 = foo.

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

        [192.168.*]
            # matches e.g. 192.168.10.20

        [192.168.10[34].1]
            # matches 192.168.103.1 and 192.168.104.1

        [login?.example.com]
            # mathces 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.

COMMAND LINE OPTIONS
Unless otherwise noted, options given in the configuration file will override any corresponding command line options.

In general, avoid using the same options on command line and in the configuration file.

CONFIGURATION

  GENERAL

Check control
    Any keyword to the "--check" parameter 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 = true
            check_memory = true
            check_fans = true
            check_power = true
            check_temp = true
            check_cpu = true
            check_voltage = true
            check_batteries = true
            check_amperage = true
            check_intrusion = true
            check_sdcard = true
            check_esmhealth = true
            check_esmlog = false
            check_alertlog = false
            check_everything = false

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

    The option "check_everything" is special and 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.

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

Blacklisting
    For blacklisting the keyword "blacklist" is used, and the value is a string that uses the same syntax as the "-b" or "--blacklist" parameter. Example:

        blacklist = ctrl_fw=all/pdisk=0:0:1

    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 "BLACKLISTING" in check_openmanage(8).

Timeout
    The plugin timeout can be configured with the "timeout" keyword. The argument is number of seconds and should be a positive integer. Example:

        timeout = 60

    The corresponding command line option is "-t" or "--timeout".

Performance data
    Performance data can be turned on in the configuration file with "performance_data". Accepted values are boolean (TRUE/FALSE) or either of the keywords "minimal" and "multiline". Example:

        performance_data = true

    The corresponding command line option is "-p" or "--perfdata".

Legacy Performance data
    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. Example:

        legacy_performance_data = true

    The corresponding command line option is "--legacy-perfdata".

Temperature unit
    The temperature unit used for reporting, performance data etc. can be set with the "temperature_unit" option. Allowed values are "F" for Fahrenheit, "C" for Celsius, "K" for Kelvin and "R" for Rankine. Example:

        temperature_unit = F

    The corresponding command line option is "--tempunit". Note that the command line option "-F" or "--fahrenheit" will override both the command line option and the configuration file option.

Temperature limits
    Custom temperature limits may be configured with the options "temp_threshold_warning" and "temp_threshold_critical". These options corresponds to the command line options "-w" or "--warning" and "-c" or "--critical", respectively. They take the same arguments as the command line options. Examples:

        temp_threshold_warning = 0=30/10
        temp_threshold_critical = 0=35/8

  SNMP 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 can be set with "snmp_community". Example:

        snmp_community = mycommunity

    Corresponding command line option: "-C" or "--community"

SNMP protocol version
    The SNMP protocol version can be set with "snmp_version". Example:

        snmp_version = 2c

    Corresponding command line option: "-P" or "--protocol"

SNMP port number
    The remote port number used with SNMP can be set with "snmp_port". Example:

        snmp_port = 161

    Corresponding command line option: "--port"

Use IPv6 instead of IPv4
    The option "snmp_use_ipv6" instructs the plugin to use IPv6 instead of IPv4. This option takes a boolean value. Example:

        snmp_use_ipv6 = true

    Corresponding command line option: "-6" or "--ipv6"

Use TCP instead of UDP
    The option "snmp_use_ipv6" instructs the plugin to use IPv6 instead of IPv4. This option takes a boolean value. Example:

        snmp_use_tcp = true

    Corresponding command line option: "--tcp"

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

Include servicetag in alerts
    The option "output_servicetag" will make the plugin include the servers servicetag (serial number) in every alert. This option takes a boolean value. Example:

        output_servicetag = true

    Corresponding command line option: "-i" or "--info"

Include service state in alerts
    The option "output_servicestate" will make the plugin include the service state in any alerts. This option takes a boolean value. Example:

        output_servicestate = true

    Corresponding command line option: "-s" or "--state"

Include abbreviated service state in alerts
    The option "output_servicestate_abbr" will make the plugin include the abbreviated service state in any alerts. This option takes a boolean value. Example:

        output_servicestate_abbr = true

    Corresponding command line option: "-S" or "--short-state"

Show system info with alerts
    The option "output_sysinfo" will make the plugin output some system information with alerts. This option takes a boolean value. Example:

        output_sysinfo = true

    Corresponding command line option: "-e" or "--extinfo"

Show blacklistings in OK output
    The option "output_blacklist" will make the plugin show any blacklistings in the OK output. This option takes a boolean value. Example:

        output_blacklist = true

    Corresponding command line option: "-B" or "--show-blacklist"

Verbosity of OK output
    The option "output_ok_verbosity" lets you adjust how much information is shown in the OK output. This option takes a positive integer as parameter. Example:

        output_ok_verbosity = 3

    Corresponding command line option: "-o" or "--ok-info"

HTML output
    The output "output_html" makes the plugin produce HTML output. This option takes either a boolean value, or a country or area code. Example:

        output_html = de

    Corresponding command line option: "-I" or "--htmlinfo"

Custom line after alerts
    The option "output_post_message" lets you specify one line of information to be shown after any alerts. This option takes a string as parameter. Examples:

        output_post_message = OS: %o %r
        output_post_message = NOTE: Handled in ticket 123456

    For more information about codes and formatting, see the corresponding command line option "--postmsg" in check_openmanage(8).

Suppress or censor the servicetag
    The option "output_hide_servicetag" will censor the servicetag (serial number) in any output from the plugin. This option takes a boolean value. Example:

        output_hide_servicetag = true

    Corresponding command line option: "--hide-servicetag"

SEE ALSO
check_openmanage(8) <http://folk.uio.no/trondham/software/check_openmanage.html>