Return to README CVS log

Up to [local] / nagios / check_hw_sensors

Annotation of nagios/check_hw_sensors/README, Revision 1.8

1.8     ! andrew      1: check_hw_sensors - monitors sysctl hw.sensors on OpenBSD
1.4       andrew      2:     check_hw_sensors [-i] (-f [<FILENAME>]|(-s <hw.sensors id> [-w limit] [-c limit]))
1.1       andrew      3:
                      4: Usage:
1.4       andrew      5:     -i, --ignore-status
1.8     ! andrew      6:         Don't automatically check the status of sensors that report it.
1.1       andrew      7:     -f, --filename=FILE
                      8:         FILE to load checks from (defaults to /etc/sensorsd.conf)
                      9:     -s, --sensor=ID
1.8     ! andrew     10:         ID of a single sensor.  "-s kate0.temp0" means hw.sensors.kate0.temp0
        !            11:         Overrides --filename.
1.1       andrew     12:     -w, --warning=RANGE or single ENTRY
                     13:         Exit with WARNING status if outside of RANGE or if != ENTRY
1.2       andrew     14:     -c, --critical=RANGE or single ENTRY
1.1       andrew     15:         Exit with CRITICAL status if outside of RANGE or if != ENTRY
                     16:
1.2       andrew     17: FILE is in the same format as sensorsd.conf(5) plus some additional
                     18: entries.  These additional entries in the file are ignored by
1.8     ! andrew     19: sensorsd(8) this means you can use the same config file for check_hw_sensors
        !            20: as well as sensorsd(8).
1.1       andrew     21:
                     22: check_hw_sensors understands the following entries:
                     23:
1.4       andrew     24:     low, high, crit, warn, crit.low, crit.high, warn.low, warn.high,
                     25:     ignore, status
1.1       andrew     26:
                     27: An ENTRY depends on the type.  The descriptions in sensorsd.conf(5)
                     28: can be used when appropriate, or you can use the following:
                     29:
1.5       andrew     30:     fanrpm, volts_dc, amps, watthour, amphour, integer (raw), percent,
                     31:     lux or timedelta - Anything that includes digits.  Both the value of
                     32:     the check and the value of the sensor response that are not either a
                     33:     digit or period are stripped and then the two resultant values are
                     34:     compared.
1.1       andrew     35:
                     36:     temp - Can be as above, but if the entry has an F in it,
                     37:     it compares farenheit, otherwise it uses celcius.
                     38:
                     39:     indicator or drive - does a case sensitive match of each
                     40:     entry in the comma separated list and if it does not match
1.5       andrew     41:     any of the entries, it sets the status.
1.1       andrew     42:
                     43: The entries 'crit' or 'warn' (or the -c or -w on the command line)
                     44: may be a RANGE or a comma separated list of acceptable values.
                     45: The comma separated list of values contains a list of things that
                     46: will NOT cause the status.  This is possibly counterintuitive, but
                     47: you are more likely to know good values than bad values.
                     48:
                     49: A RANGE is a low ENTRY and a high ENTRY separated by a colon (:).
                     50: It can also be low: or :high with the other side left blank to only
1.8     ! andrew     51: make the single check.
1.1       andrew     52:
1.4       andrew     53: An entry marked "ignore" will cause that sensor to be skipped.
1.5       andrew     54: Generally used with state checking of all sensors to ignore sensors you
1.4       andrew     55: don't care about or that report incorrectly.
                     56:
                     57: If you are using --ignore-status, you can still check the status of
                     58: individual sensors with a status entry.
                     59:
1.8     ! andrew     60: check_hw_sensors v1.26
        !            61: Copyright (c) 2009 Andrew Fresh <andrew@afresh1.com>
        !            62: Permission to use, copy, modify, and distribute this software for any
        !            63: purpose with or without fee is hereby granted, provided that the above
        !            64: copyright notice and this permission notice appear in all copies.
        !            65:
        !            66: THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
        !            67: WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
        !            68: MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
        !            69: ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
        !            70: WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
        !            71: ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
        !            72: OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.