There are 2 levels of documentation for every plugin:
You can also access the most recent --help output for each plugin on the internet at http://nagiosplugins.org/man/check_dummy.
Authenticated users can add comments to each man page.
(Note: perl plugins are not automatically updated yet.)
check_apt v1991 (nagios-plugins 1.4.12)
Copyright (c) 2006-2008 Nagios Plugin Development Team
<nagiosplug-devel@lists.sourceforge.net>
This plugin checks for software updates on systems that use
package management systems based on the apt-get(8) command
found in Debian GNU/Linux
Usage:check_apt [[-d|-u|-U]opts] [-n] [-t timeout]
Options:
-h, --help
Print detailed help screen
-V, --version
Print version information
-t, --timeout=INTEGER
Seconds before connection times out (default: 10)
-U, --upgrade=OPTS
[Default] Perform an upgrade. If an optional OPTS argument is provided,
apt-get will be run with these command line options instead of the
default (-o 'Debug::NoLocking=true' -s -qq).
Note that you may be required to have root privileges if you do not use
the default options.
-d, --dist-upgrade=OPTS
Perform a dist-upgrade instead of normal upgrade. Like with -U OPTS
can be provided to override the default options.
-n, --no-upgrade
Do not run the upgrade. Probably not useful (without -u at least).
-i, --include=REGEXP
Include only packages matching REGEXP. Can be specified multiple times
the values will be combined together. Any patches matching this list
cause the plugin to return WARNING status. Others will be ignored.
Default is to include all packages.
-e, --exclude=REGEXP
Exclude packages matching REGEXP from the list of packages that would
otherwise be included. Can be specified multiple times; the values
will be combined together. Default is to exclude no packages.
-c, --critical=REGEXP
If the full package information of any of the upgradable packages match
this REGEXP, the plugin will return CRITICAL status. Can be specified
multiple times like above. Default is a regexp matching security
upgrades for Debian and Ubuntu:
^[^\(]*\([^ ]* (Debian-Security:|Ubuntu:[^/]*/[^-]*-security)
Note that the package must first match the include list before its
information is compared against the critical list.
The following options require root privileges and should be used with care:
-u, --update=OPTS
First perform an 'apt-get update'. An optional OPTS parameter overrides
the default options. Note: you may also need to adjust the global
timeout (with -t) to prevent the plugin from timing out if apt-get
upgrade is expected to take longer than the default timeout.
Send email to nagios-users@lists.sourceforge.net if you have questions
regarding use of this software. To submit patches or suggest improvements,
send email to nagiosplug-devel@lists.sourceforge.net
check_by_ssh v2002 (nagios-plugins 1.4.12)
Copyright (c) 1999 Karl DeBisschop <kdebisschop@users.sourceforge.net>
Copyright (c) 2000-2008 Nagios Plugin Development Team
<nagiosplug-devel@lists.sourceforge.net>
This plugin uses SSH to execute commands on a remote host
Usage: check_by_ssh -H <host> -C <command> [-fqv] [-1|-2] [-4|-6]
[-S [lines]] [-E [lines]] [-t timeout] [-i identity]
[-l user] [-n name] [-s servicelist] [-O outputfile]
[-p port] [-o ssh-option]
Options:
-h, --help
Print detailed help screen
-V, --version
Print version information
-H, --hostname=ADDRESS
Host name, IP Address, or unix socket (must be an absolute path)
-p, --port=INTEGER
Port number (default: none)
-4, --use-ipv4
Use IPv4 connection
-6, --use-ipv6
Use IPv6 connection
-1, --proto1
tell ssh to use Protocol 1 [optional]
-2, --proto2
tell ssh to use Protocol 2 [optional]
-S, --skip-stdout[=n]
Ignore all or (if specified) first n lines on STDOUT [optional]
-E, --skip-stderr[=n]
Ignore all or (if specified) first n lines on STDERR [optional]
-f
tells ssh to fork rather than create a tty [optional]. This will always return OK if ssh is executed
-C, --command='COMMAND STRING'
command to execute on the remote machine
-l, --logname=USERNAME
SSH user name on remote host [optional]
-i, --identity=KEYFILE
identity of an authorized key [optional]
-O, --output=FILE
external command file for nagios [optional]
-s, --services=LIST
list of nagios service names, separated by ':' [optional]
-n, --name=NAME
short name of host in nagios configuration [optional]
-o, --ssh-option=OPTION
Call ssh with '-o OPTION' (may be used multiple times) [optional]
-q, --quiet
Tell ssh to suppress warning and diagnostic messages [optional]
-w, --warning=DOUBLE
Response time to result in warning status (seconds)
-c, --critical=DOUBLE
Response time to result in critical status (seconds)
-t, --timeout=INTEGER
Seconds before connection times out (default: 10)
-v, --verbose
Show details for command-line debugging (Nagios may truncate output)
The most common mode of use is to refer to a local identity file with
the '-i' option. In this mode, the identity pair should have a null
passphrase and the public key should be listed in the authorized_keys
file of the remote host. Usually the key will be restricted to running
only one command on the remote server. If the remote SSH server tracks
invocation arguments, the one remote program may be an agent that can
execute additional commands as proxy
To use passive mode, provide multiple '-C' options, and provide
all of -O, -s, and -n options (servicelist order must match '-C'options)
Examples:
$ check_by_ssh -H localhost -n lh -s c1:c2:c3 -C uptime -C uptime -C uptime -O /tmp/foo
$ cat /tmp/foo
[1080933700] PROCESS_SERVICE_CHECK_RESULT;flint;c1;0; up 2 days
[1080933700] PROCESS_SERVICE_CHECK_RESULT;flint;c2;0; up 2 days
[1080933700] PROCESS_SERVICE_CHECK_RESULT;flint;c3;0; up 2 days
Send email to nagios-users@lists.sourceforge.net if you have questions
regarding use of this software. To submit patches or suggest improvements,
send email to nagiosplug-devel@lists.sourceforge.net
check_clamd v1991 (nagios-plugins 1.4.12)
Copyright (c) 1999 Ethan Galstad <nagios@nagios.org>
Copyright (c) 1999-2008 Nagios Plugin Development Team
<nagiosplug-devel@lists.sourceforge.net>
This plugin tests CLAMD connections with the specified host (or unix socket).
Usage:check_clamd -H host -p port [-w <warning time>] [-c <critical time>] [-s <send string>]
[-e <expect string>] [-q <quit string>][-m <maximum bytes>] [-d <delay>]
[-t <timeout seconds>] [-r <refuse state>] [-M <mismatch state>] [-v] [-4|-6] [-j]
[-D <days to cert expiry>] [-S <use SSL>] [-E]
Options:
-h, --help
Print detailed help screen
-V, --version
Print version information
-H, --hostname=ADDRESS
Host name, IP Address, or unix socket (must be an absolute path)
-p, --port=INTEGER
Port number (default: none)
-4, --use-ipv4
Use IPv4 connection
-6, --use-ipv6
Use IPv6 connection
-E, --escape
Can use \n, \r, \t or \ in send or quit string. Must come before send or quit option
Default: nothing added to send, \r\n added to end of quit
-s, --send=STRING
String to send to the server
-e, --expect=STRING
String to expect in server response (may be repeated)
-A, --all
All expect strings need to occur in server response. Default is any
-q, --quit=STRING
String to send server to initiate a clean close of the connection
-r, --refuse=ok|warn|crit
Accept tcp refusals with states ok, warn, crit (default: crit)
-M, --mismatch=ok|warn|crit
Accept expected string mismatches with states ok, warn, crit (default: warn)
-j, --jail
Hide output from TCP socket
-m, --maxbytes=INTEGER
Close connection once more than this number of bytes are received
-d, --delay=INTEGER
Seconds to wait between sending string and polling for response
-D, --certificate=INTEGER
Minimum number of days a certificate has to be valid.
-S, --ssl
Use SSL for the connection.
-w, --warning=DOUBLE
Response time to result in warning status (seconds)
-c, --critical=DOUBLE
Response time to result in critical status (seconds)
-t, --timeout=INTEGER
Seconds before connection times out (default: 10)
-v, --verbose
Show details for command-line debugging (Nagios may truncate output)
Send email to nagios-users@lists.sourceforge.net if you have questions
regarding use of this software. To submit patches or suggest improvements,
send email to nagiosplug-devel@lists.sourceforge.net
check_cluster v1991 (nagios-plugins 1.4.12) Copyright (c) 2000-2004 Ethan Galstad (nagios@nagios.org) Copyright (c) 2000-2007 Nagios Plugin Development Team <nagiosplug-devel@lists.sourceforge.net> Host/Service Cluster Plugin for Nagios 2 Usage: check_cluster (-s | -h) -d val1[,val2,...,valn] [-l label] [-w threshold] [-c threshold] [-v] [--help] Options: -s, --service Check service cluster status -h, --host Check host cluster status -l, --label=STRING Optional prepended text output (i.e. "Host cluster") -w, --warning=THRESHOLD Specifies the range of hosts or services in cluster that must be in a non-OK state in order to return a WARNING status level -c, --critical=THRESHOLD Specifies the range of hosts or services in cluster that must be in a non-OK state in order to return a CRITICAL status level -d, --data=LIST The status codes of the hosts or services in the cluster, separated by commas -v, --verbose Show details for command-line debugging (Nagios may truncate output) Notes: See: http://nagiosplug.sourceforge.net/developer-guidelines.html#THRESHOLDFOR... for THRESHOLD format and examples. Send email to nagios-users@lists.sourceforge.net if you have questions regarding use of this software. To submit patches or suggest improvements, send email to nagiosplug-devel@lists.sourceforge.net
check_dhcp v1991 (nagios-plugins 1.4.12) Copyright (c) 2001-2004 Ethan Galstad (nagios@nagios.org) Copyright (c) 2001-2007 Nagios Plugin Development Team <nagiosplug-devel@lists.sourceforge.net> This plugin tests the availability of DHCP servers on a network. Usage: check_dhcp [-v] [-u] [-s serverip] [-r requestedip] [-t timeout] [-i interface] [-m mac] Options: -h, --help Print detailed help screen -V, --version Print version information -v, --verbose Show details for command-line debugging (Nagios may truncate output) -s, --serverip=IPADDRESS IP address of DHCP server that we must hear from -r, --requestedip=IPADDRESS IP address that should be offered by at least one DHCP server -t, --timeout=INTEGER Seconds to wait for DHCPOFFER before timeout occurs -i, --interface=STRING Interface to to use for listening (i.e. eth0) -m, --mac=STRING MAC address to use in the DHCP request -u, --unicast Unicast testing: mimic a DHCP relay, requires -s Send email to nagios-users@lists.sourceforge.net if you have questions regarding use of this software. To submit patches or suggest improvements, send email to nagiosplug-devel@lists.sourceforge.net
check_dig v2011 (nagios-plugins 1.4.12)
Copyright (c) 2000 Karl DeBisschop <kdebisschop@users.sourceforge.net>
Copyright (c) 2002-2008 Nagios Plugin Development Team
<nagiosplug-devel@lists.sourceforge.net>
This plugin test the DNS service on the specified host using dig
Usage:check_dig -l <query_address> [-H <host>] [-p <server port>]
[-T <query type>] [-w <warning interval>] [-c <critical interval>]
[-t <timeout>] [-a <expected answer address>] [-v]
Options:
-h, --help
Print detailed help screen
-V, --version
Print version information
-H, --hostname=ADDRESS
Host name, IP Address, or unix socket (must be an absolute path)
-p, --port=INTEGER
Port number (default: 53)
-l, --query_address=STRING
Machine name to lookup
-T, --record_type=STRING
Record type to lookup (default: A)
-a, --expected_address=STRING
An address expected to be in the answer section. If not set, uses whatever
was in -l
-A, --dig-arguments=STRING
Pass STRING as argument(s) to dig
-w, --warning=DOUBLE
Response time to result in warning status (seconds)
-c, --critical=DOUBLE
Response time to result in critical status (seconds)
-t, --timeout=INTEGER
Seconds before connection times out (default: 10)
-v, --verbose
Show details for command-line debugging (Nagios may truncate output)
Examples:
check_dig -H DNSSERVER -l www.example.com -A "+tcp"
This will send a tcp query to DNSSERVER for www.example.com
Send email to nagios-users@lists.sourceforge.net if you have questions
regarding use of this software. To submit patches or suggest improvements,
send email to nagiosplug-devel@lists.sourceforge.net
check_disk v1991 (nagios-plugins 1.4.12)
Copyright (c) 1999 Ethan Galstad <nagios@nagios.org>
Copyright (c) 1999-2008 Nagios Plugin Development Team
<nagiosplug-devel@lists.sourceforge.net>
This plugin checks the amount of used disk space on a mounted file system
and generates an alert if free space is less than one of the threshold values
Usage: check_disk -w limit -c limit [-W limit] [-K limit] {-p path | -x device}
[-C] [-E] [-e] [-g group ] [-k] [-l] [-M] [-m] [-R path ] [-r path ]
[-t timeout] [-u unit] [-v] [-X type]
Options:
-h, --help
Print detailed help screen
-V, --version
Print version information
-w, --warning=INTEGER
Exit with WARNING status if less than INTEGER units of disk are free
-w, --warning=PERCENT%
Exit with WARNING status if less than PERCENT of disk space is free
-c, --critical=INTEGER
Exit with CRITICAL status if less than INTEGER units of disk are free
-c, --critical=PERCENT%
Exit with CRITCAL status if less than PERCENT of disk space is free
-W, --iwarning=PERCENT%
Exit with WARNING status if less than PERCENT of inode space is free
-K, --icritical=PERCENT%
Exit with CRITICAL status if less than PERCENT of inode space is free
-p, --path=PATH, --partition=PARTITION
Path or partition (may be repeated)
-x, --exclude_device=PATH <STRING>
Ignore device (only works if -p unspecified)
-C, --clear
Clear thresholds
-E, --exact-match
For paths or partitions specified with -p, only check for exact paths
-e, --errors-only
Display only devices/mountpoints with errors
-g, --group=NAME
Group pathes. Thresholds apply to (free-)space of all partitions together
-k, --kilobytes
Same as '--units kB'
-l, --local
Only check local filesystems
-L, --stat-remote-fs
Only check local filesystems against thresholds. Yet call stat on remote filesystems
to test if they are accessible (e.g. to detect Stale NFS Handles)
-M, --mountpoint
Display the mountpoint instead of the partition
-m, --megabytes
Same as '--units MB'
-A, --all
Explicitly select all pathes. This is equivalent to -R '.*'
-R, --eregi-path=PATH, --eregi-partition=PARTITION
Case insensitive regular expression for path/partition (may be repeated)
-r, --ereg-path=PATH, --ereg-partition=PARTITION
Regular expression for path or partition (may be repeated)
-I, --ignore-eregi-path=PATH, --ignore-eregi-partition=PARTITION
Regular expression to ignore selected path/partition (case insensitive) (may be repeated)
-i, --ignore-ereg-path=PATH, --ignore-ereg-partition=PARTITION
Regular expression to ignore selected path or partition (may be repeated)
-t, --timeout=INTEGER
Seconds before connection times out (default: 10)
-u, --units=STRING
Choose bytes, kB, MB, GB, TB (default: MB)
-v, --verbose
Show details for command-line debugging (Nagios may truncate output)
-X, --exclude-type=TYPE
Ignore all filesystems of indicated type (may be repeated)
Examples:
check_disk -w 10% -c 5% -p /tmp -p /var -C -w 100000 -c 50000 -p /
Checks /tmp and /var at 10% and 5%, and / at 100MB and 50MB
check_disk -w 100M -c 50M -C -w 1000M -c 500M -g sidDATA -r '^/oracle/SID/data.*$'
Checks all filesystems not matching -r at 100M and 50M. The fs matching the -r regex
are grouped which means the freespace thresholds are applied to all disks together
check_disk -w 100M -c 50M -C -w 1000M -c 500M -p /foo -C -w 5% -c 3% -p /bar
Checks /foo for 1000M/500M and /bar for 5/3%. All remaining volumes use 100M/50M
Send email to nagios-users@lists.sourceforge.net if you have questions
regarding use of this software. To submit patches or suggest improvements,
send email to nagiosplug-devel@lists.sourceforge.net
check_dns v1992 (nagios-plugins 1.4.12)
Copyright (c) 1999 Ethan Galstad <nagios@nagios.org>
Copyright (c) 2000-2008 Nagios Plugin Development Team
<nagiosplug-devel@lists.sourceforge.net>
This plugin uses the nslookup program to obtain the IP address for the given host/domain query.
An optional DNS server to use may be specified.
If no DNS server is specified, the default server(s) specified in /etc/resolv.conf will be used.
Usage:check_dns -H host [-s server] [-a expected-address] [-A] [-t timeout] [-w warn] [-c crit]
Options:
-h, --help
Print detailed help screen
-V, --version
Print version information
-H, --hostname=HOST
The name or address you want to query
-s, --server=HOST
Optional DNS server you want to use for the lookup
-a, --expected-address=IP-ADDRESS|HOST
Optional IP-ADDRESS you expect the DNS server to return. HOST must end with
a dot (.). This option can be repeated multiple times (Returns OK if any
value match). If multiple addresses are returned at once, you have to match
the whole string of addresses separated with commas (sorted alphabetically).
-A, --expect-authority
Optionally expect the DNS server to be authoritative for the lookup
-w, --warning=seconds
Return warning if elapsed time exceeds value. Default off
-c, --critical=seconds
Return critical if elapsed time exceeds value. Default off
-t, --timeout=INTEGER
Seconds before connection times out (default: 10)
Send email to nagios-users@lists.sourceforge.net if you have questions
regarding use of this software. To submit patches or suggest improvements,
send email to nagiosplug-devel@lists.sourceforge.net
check_dummy v1984 (nagios-plugins 1.4.12)
Copyright (c) 1999 Ethan Galstad <nagios@nagios.org>
Copyright (c) 1999-2007 Nagios Plugin Development Team
<nagiosplug-devel@lists.sourceforge.net>
This plugin will simply return the state corresponding to the numeric value
of the <state> argument with optional text
Usage: check_dummy <integer state> [optional text]
Options:
-h, --help
Print detailed help screen
-V, --version
Print version information
Send email to nagios-users@lists.sourceforge.net if you have questions
regarding use of this software. To submit patches or suggest improvements,
send email to nagiosplug-devel@lists.sourceforge.net
check_ftp v1991 (nagios-plugins 1.4.12)
Copyright (c) 1999 Ethan Galstad <nagios@nagios.org>
Copyright (c) 1999-2008 Nagios Plugin Development Team
<nagiosplug-devel@lists.sourceforge.net>
This plugin tests FTP connections with the specified host (or unix socket).
Usage:check_ftp -H host -p port [-w <warning time>] [-c <critical time>] [-s <send string>]
[-e <expect string>] [-q <quit string>][-m <maximum bytes>] [-d <delay>]
[-t <timeout seconds>] [-r <refuse state>] [-M <mismatch state>] [-v] [-4|-6] [-j]
[-D <days to cert expiry>] [-S <use SSL>] [-E]
Options:
-h, --help
Print detailed help screen
-V, --version
Print version information
-H, --hostname=ADDRESS
Host name, IP Address, or unix socket (must be an absolute path)
-p, --port=INTEGER
Port number (default: none)
-4, --use-ipv4
Use IPv4 connection
-6, --use-ipv6
Use IPv6 connection
-E, --escape
Can use \n, \r, \t or \ in send or quit string. Must come before send or quit option
Default: nothing added to send, \r\n added to end of quit
-s, --send=STRING
String to send to the server
-e, --expect=STRING
String to expect in server response (may be repeated)
-A, --all
All expect strings need to occur in server response. Default is any
-q, --quit=STRING
String to send server to initiate a clean close of the connection
-r, --refuse=ok|warn|crit
Accept tcp refusals with states ok, warn, crit (default: crit)
-M, --mismatch=ok|warn|crit
Accept expected string mismatches with states ok, warn, crit (default: warn)
-j, --jail
Hide output from TCP socket
-m, --maxbytes=INTEGER
Close connection once more than this number of bytes are received
-d, --delay=INTEGER
Seconds to wait between sending string and polling for response
-D, --certificate=INTEGER
Minimum number of days a certificate has to be valid.
-S, --ssl
Use SSL for the connection.
-w, --warning=DOUBLE
Response time to result in warning status (seconds)
-c, --critical=DOUBLE
Response time to result in critical status (seconds)
-t, --timeout=INTEGER
Seconds before connection times out (default: 10)
-v, --verbose
Show details for command-line debugging (Nagios may truncate output)
Send email to nagios-users@lists.sourceforge.net if you have questions
regarding use of this software. To submit patches or suggest improvements,
send email to nagiosplug-devel@lists.sourceforge.net
check_hpjd v1590 (nagios-plugins 1.4.9)
Copyright (c) 1999 Ethan Galstad <nagios@nagios.org>
Copyright (c) 2000-2006 Nagios Plugin Development Team
<nagiosplug-devel@lists.sourceforge.net>
This plugin tests the STATUS of an HP printer with a JetDirect card.
Net-snmp must be installed on the computer running the plugin.
Usage:check_hpjd -H host [-C community]
Options:
-h, --help
Print detailed help screen
-V, --version
Print version information
-C, --community=STRING
The SNMP community name (default=public)
Send email to nagios-users@lists.sourceforge.net if you have questions
regarding use of this software. To submit patches or suggest improvements,
send email to nagiosplug-devel@lists.sourceforge.net
check_http v2008 (nagios-plugins 1.4.12)
Copyright (c) 1999 Ethan Galstad <nagios@nagios.org>
Copyright (c) 1999-2008 Nagios Plugin Development Team
<nagiosplug-devel@lists.sourceforge.net>
This plugin tests the HTTP service on the specified host. It can test
normal (http) and secure (https) servers, follow redirects, search for
strings and regular expressions, check connection times, and report on
certificate expiration times.
Usage: check_http -H <vhost> | -I <IP-address> [-u <uri>] [-p <port>]
[-w <warn time>] [-c <critical time>] [-t <timeout>] [-L]
[-a auth] [-f <ok | warn | critcal | follow>] [-e <expect>]
[-s string] [-l] [-r <regex> | -R <case-insensitive regex>] [-P string]
[-m <min_pg_size>:<max_pg_size>] [-4|-6] [-N] [-M <age>] [-A string]
[-k string] [-S] [-C <age>] [-T <content-type>]
NOTE: One or both of -H and -I must be specified
Options:
-h, --help
Print detailed help screen
-V, --version
Print version information
-H, --hostname=ADDRESS
Host name argument for servers using host headers (virtual host)
Append a port to include it in the header (eg: example.com:5000)
-I, --IP-address=ADDRESS
IP address or name (use numeric address if possible to bypass DNS lookup).
-p, --port=INTEGER
Port number (default: 80)
-4, --use-ipv4
Use IPv4 connection
-6, --use-ipv6
Use IPv6 connection
-S, --ssl
Connect via SSL. Port defaults to 443
-C, --certificate=INTEGER
Minimum number of days a certificate has to be valid. Port defaults to 443
(when this option is used the url is not checked.)
-e, --expect=STRING
String to expect in first (status) line of server response (default:
HTTP/1.)
If specified skips all other status line logic (ex: 3xx, 4xx, 5xx processing)
-s, --string=STRING
String to expect in the content
-u, --url=PATH
URL to GET or POST (default: /)
-P, --post=STRING
URL encoded http POST data
-N, --no-body
Don't wait for document body: stop reading after headers.
(Note that this still does an HTTP GET or POST, not a HEAD.)
-M, --max-age=SECONDS
Warn if document is more than SECONDS old. the number can also be of
the form "10m" for minutes, "10h" for hours, or "10d" for days.
-T, --content-type=STRING
specify Content-Type header media type when POSTing
-l, --linespan
Allow regex to span newlines (must precede -r or -R)
-r, --regex, --ereg=STRING
Search page for regex STRING
-R, --eregi=STRING
Search page for case-insensitive regex STRING
--invert-regex
Return CRITICAL if found, OK if not
-a, --authorization=AUTH_PAIR
Username:password on sites with basic authentication
-A, --useragent=STRING
String to be sent in http header as "User Agent"
-k, --header=STRING
Any other tags to be sent in http header. Use multiple times for additional headers
-L, --link
Wrap output in HTML link (obsoleted by urlize)
-f, --onredirect=<ok|warning|critical|follow>
How to handle redirected pages
-m, --pagesize=INTEGER<:INTEGER>
Minimum page size required (bytes) : Maximum page size required (bytes)
-w, --warning=DOUBLE
Response time to result in warning status (seconds)
-c, --critical=DOUBLE
Response time to result in critical status (seconds)
-t, --timeout=INTEGER
Seconds before connection times out (default: 10)
-v, --verbose
Show details for command-line debugging (Nagios may truncate output)
Notes:
This plugin will attempt to open an HTTP connection with the host.
Successful connects return STATE_OK, refusals and timeouts return STATE_CRITICAL
other errors return STATE_UNKNOWN. Successful connects, but incorrect reponse
messages from the host result in STATE_WARNING return values. If you are
checking a virtual server that uses 'host headers' you must supply the FQDN
(fully qualified domain name) as the [host_name] argument.
This plugin can also check whether an SSL enabled web server is able to
serve content (optionally within a specified time) or whether the X509
certificate is still valid for the specified number of days.
Examples:
CHECK CONTENT: check_http -w 5 -c 10 --ssl -H www.verisign.com
When the 'www.verisign.com' server returns its content within 5 seconds,
a STATE_OK will be returned. When the server returns its content but exceeds
the 5-second threshold, a STATE_WARNING will be returned. When an error occurs,
a STATE_CRITICAL will be returned.
CHECK CERTIFICATE: check_http -H www.verisign.com -C 14
When the certificate of 'www.verisign.com' is valid for more than 14 days,
a STATE_OK is returned. When the certificate is still valid, but for less than
14 days, a STATE_WARNING is returned. A STATE_CRITICAL will be returned when
the certificate is expired.
Send email to nagios-users@lists.sourceforge.net if you have questions
regarding use of this software. To submit patches or suggest improvements,
send email to nagiosplug-devel@lists.sourceforge.net
Warning: This plugin must be either run as root or setuid root.
To run as root, you can use a tool like sudo.
To set the setuid permissions, use the command:
chmod u+s yourpluginfile
Copyright (c) 2005 Andreas Ericsson <ae@op5.se>
Copyright (c) 2005-2008 Nagios Plugin Development Team
<nagiosplug-devel@lists.sourceforge.net>
Usage: check_icmp [options] [-H] host1 host2 hostN
Options:
-h, --help
Print detailed help screen
-V, --version
Print version information
-H
specify a target
-w
warning threshold (currently 200.000ms,0%)
-c
critical threshold (currently 500000.000ms,80%)
-s
specify a source IP address or device name
-n
number of packets to send (currently 5)
-i
max packet interval (currently 80.000ms)
-I
max target interval (currently 0.000ms)
-m
number of alive hosts required for success
-l
TTL on outgoing packets (currently 0) -t
timeout value (seconds, currently 10)
-b
icmp packet size (currenly ignored)
-v
verbose
Notes:
The -H switch is optional. Naming a host (or several) to check is not.
Threshold format for -w and -c is 200.25,60% for 200.25 msec RTA and 60%
packet loss. The default values should work well for most users.
You can specify different RTA factors using the standardized abbreviations
us (microseconds), ms (milliseconds, default) or just plain s for seconds.
The -v switch can be specified several times for increased verbosity.
Send email to nagios-users@lists.sourceforge.net if you have questions
regarding use of this software. To submit patches or suggest improvements,
send email to nagiosplug-devel@lists.sourceforge.net
check_ide_smart v1991 (nagios-plugins 1.4.12)
Nagios feature - 1999 Robert Dale <rdale@digital-mission.com>
(C) 1999 Ragnar Hojland Espinosa <ragnar@lightside.dhis.org>
Copyright (c) 1998-2007 Nagios Plugin Development Team
<nagiosplug-devel@lists.sourceforge.net>
This plugin checks a local hard drive with the (Linux specific) SMART interface [http://smartlinux.sourceforge.net/smart/index.php].
Usage:check_ide_smart [-d <device>] [-i <immediate>] [-q quiet] [-1 <auto-on>] [-O <auto-off>] [-n <nagios>]
Options:
-h, --help
Print detailed help screen
-V, --version
Print version information
-d, --device=DEVICE
Select device DEVICE
Note: if the device is selected with this option, _no_ other options are accepted
-i, --immediate
Perform immediately offline tests
-q, --quiet-check
Returns the number of failed tests
-1, --auto-on
Turn on automatic offline tests
-0, --auto-off
Turn off automatic offline tests
-n, --nagios
Output suitable for Nagios
Send email to nagios-users@lists.sourceforge.net if you have questions
regarding use of this software. To submit patches or suggest improvements,
send email to nagiosplug-devel@lists.sourceforge.net
check_imap v1991 (nagios-plugins 1.4.12)
Copyright (c) 1999 Ethan Galstad <nagios@nagios.org>
Copyright (c) 1999-2008 Nagios Plugin Development Team
<nagiosplug-devel@lists.sourceforge.net>
This plugin tests IMAP connections with the specified host (or unix socket).
Usage:check_imap -H host -p port [-w <warning time>] [-c <critical time>] [-s <send string>]
[-e <expect string>] [-q <quit string>][-m <maximum bytes>] [-d <delay>]
[-t <timeout seconds>] [-r <refuse state>] [-M <mismatch state>] [-v] [-4|-6] [-j]
[-D <days to cert expiry>] [-S <use SSL>] [-E]
Options:
-h, --help
Print detailed help screen
-V, --version
Print version information
-H, --hostname=ADDRESS
Host name, IP Address, or unix socket (must be an absolute path)
-p, --port=INTEGER
Port number (default: none)
-4, --use-ipv4
Use IPv4 connection
-6, --use-ipv6
Use IPv6 connection
-E, --escape
Can use \n, \r, \t or \ in send or quit string. Must come before send or quit option
Default: nothing added to send, \r\n added to end of quit
-s, --send=STRING
String to send to the server
-e, --expect=STRING
String to expect in server response (may be repeated)
-A, --all
All expect strings need to occur in server response. Default is any
-q, --quit=STRING
String to send server to initiate a clean close of the connection
-r, --refuse=ok|warn|crit
Accept tcp refusals with states ok, warn, crit (default: crit)
-M, --mismatch=ok|warn|crit
Accept expected string mismatches with states ok, warn, crit (default: warn)
-j, --jail
Hide output from TCP socket
-m, --maxbytes=INTEGER
Close connection once more than this number of bytes are received
-d, --delay=INTEGER
Seconds to wait between sending string and polling for response
-D, --certificate=INTEGER
Minimum number of days a certificate has to be valid.
-S, --ssl
Use SSL for the connection.
-w, --warning=DOUBLE
Response time to result in warning status (seconds)
-c, --critical=DOUBLE
Response time to result in critical status (seconds)
-t, --timeout=INTEGER
Seconds before connection times out (default: 10)
-v, --verbose
Show details for command-line debugging (Nagios may truncate output)
Send email to nagios-users@lists.sourceforge.net if you have questions
regarding use of this software. To submit patches or suggest improvements,
send email to nagiosplug-devel@lists.sourceforge.net
check_jabber v1991 (nagios-plugins 1.4.12)
Copyright (c) 1999 Ethan Galstad <nagios@nagios.org>
Copyright (c) 1999-2008 Nagios Plugin Development Team
<nagiosplug-devel@lists.sourceforge.net>
This plugin tests JABBER connections with the specified host (or unix socket).
Usage:check_jabber -H host -p port [-w <warning time>] [-c <critical time>] [-s <send string>]
[-e <expect string>] [-q <quit string>][-m <maximum bytes>] [-d <delay>]
[-t <timeout seconds>] [-r <refuse state>] [-M <mismatch state>] [-v] [-4|-6] [-j]
[-D <days to cert expiry>] [-S <use SSL>] [-E]
Options:
-h, --help
Print detailed help screen
-V, --version
Print version information
-H, --hostname=ADDRESS
Host name, IP Address, or unix socket (must be an absolute path)
-p, --port=INTEGER
Port number (default: none)
-4, --use-ipv4
Use IPv4 connection
-6, --use-ipv6
Use IPv6 connection
-E, --escape
Can use \n, \r, \t or \ in send or quit string. Must come before send or quit option
Default: nothing added to send, \r\n added to end of quit
-s, --send=STRING
String to send to the server
-e, --expect=STRING
String to expect in server response (may be repeated)
-A, --all
All expect strings need to occur in server response. Default is any
-q, --quit=STRING
String to send server to initiate a clean close of the connection
-r, --refuse=ok|warn|crit
Accept tcp refusals with states ok, warn, crit (default: crit)
-M, --mismatch=ok|warn|crit
Accept expected string mismatches with states ok, warn, crit (default: warn)
-j, --jail
Hide output from TCP socket
-m, --maxbytes=INTEGER
Close connection once more than this number of bytes are received
-d, --delay=INTEGER
Seconds to wait between sending string and polling for response
-D, --certificate=INTEGER
Minimum number of days a certificate has to be valid.
-S, --ssl
Use SSL for the connection.
-w, --warning=DOUBLE
Response time to result in warning status (seconds)
-c, --critical=DOUBLE
Response time to result in critical status (seconds)
-t, --timeout=INTEGER
Seconds before connection times out (default: 10)
-v, --verbose
Show details for command-line debugging (Nagios may truncate output)
Send email to nagios-users@lists.sourceforge.net if you have questions
regarding use of this software. To submit patches or suggest improvements,
send email to nagiosplug-devel@lists.sourceforge.net
check_ldap v1753 (nagios-plugins 1.4.9) Copyright (c) 1999 Didi Rieder (adrieder@sbox.tu-graz.ac.at) Copyright (c) 2000-2006 Nagios Plugin Development Team <nagiosplug-devel@lists.sourceforge.net> Usage: check_ldap -H <host> -b <base_dn> [-p <port>] [-a <attr>] [-D <binddn>] [-P <password>] [-w <warn_time>] [-c <crit_time>] [-t timeout] [-2|-3] [-4|-6] Options: -h, --help Print detailed help screen -V, --version Print version information -H, --hostname=ADDRESS Host name, IP Address, or unix socket (must be an absolute path) -p, --port=INTEGER Port number (default: 389) -4, --use-ipv4 Use IPv4 connection -6, --use-ipv6 Use IPv6 connection -a [--attr] ldap attribute to search (default: "(objectclass=*)" -b [--base] ldap base (eg. ou=my unit, o=my org, c=at -D [--bind] ldap bind DN (if required) -P [--pass] ldap password (if required) -T [--starttls] use starttls mechanism introduced in protocol version 3 -S [--ssl] use ldaps (ldap v2 ssl method). this also sets the default port to %s -2 [--ver2] use ldap protocol version 2 -3 [--ver3] use ldap protocol version 3 (default protocol version: 2) -w, --warning=DOUBLE Response time to result in warning status (seconds) -c, --critical=DOUBLE Response time to result in critical status (seconds) -t, --timeout=INTEGER Seconds before connection times out (default: 10) -v, --verbose Show details for command-line debugging (Nagios may truncate output) Note: If this plugin is called via 'check_ldaps', method 'STARTTLS' will be implied (using default port 389) unless --port=636 is specified. In that case 'SSL on connect' will be used no matter how the plugin was called. This detection is deprecated, please use 'check_ldap' with the '--starttls' or '--ssl' flags to define the behaviour explicitly instead. Send email to nagios-users@lists.sourceforge.net if you have questions regarding use of this software. To submit patches or suggest improvements, send email to nagiosplug-devel@lists.sourceforge.net
check_load v1991 (nagios-plugins 1.4.12)
Copyright (c) 1999 Felipe Gustavo de Almeida <galmeida@linux.ime.usp.br>
Copyright (c) 1999-2007 Nagios Plugin Development Team
<nagiosplug-devel@lists.sourceforge.net>
This plugin tests the current system load average.
Usage:check_load [-r] -w WLOAD1,WLOAD5,WLOAD15 -c CLOAD1,CLOAD5,CLOAD15
Options:
-h, --help
Print detailed help screen
-V, --version
Print version information
-w, --warning=WLOAD1,WLOAD5,WLOAD15
Exit with WARNING status if load average exceeds WLOADn
-c, --critical=CLOAD1,CLOAD5,CLOAD15
Exit with CRITICAL status if load average exceed CLOADn
the load average format is the same used by "uptime" and "w"
-r, --percpu
Divide the load averages by the number of CPUs (when possible)
Send email to nagios-users@lists.sourceforge.net if you have questions
regarding use of this software. To submit patches or suggest improvements,
send email to nagiosplug-devel@lists.sourceforge.net
check_mrtg v1991 (nagios-plugins 1.4.12)
Copyright (c) 1999 Ethan Galstad <nagios@nagios.org>
Copyright (c) 1999-2007 Nagios Plugin Development Team
<nagiosplug-devel@lists.sourceforge.net>
This plugin will check either the average or maximum value of one of the
two variables recorded in an MRTG log file.
Usage:check_mrtg -F log_file -a <AVG | MAX> -v variable -w warning -c critical
[-l label] [-u units] [-e expire_minutes] [-t timeout] [-v]
Options:
-h, --help
Print detailed help screen
-V, --version
Print version information
-F, --logfile=FILE
The MRTG log file containing the data you want to monitor
-e, --expires=MINUTES Minutes before MRTG data is considered to be too old
-a, --aggregation=AVG|MAX
Should we check average or maximum values?
-v, --variable=INTEGER
Which variable set should we inspect? (1 or 2)
-w, --warning=INTEGER
Threshold value for data to result in WARNING status
-c, --critical=INTEGER
Threshold value for data to result in CRITICAL status
-l, --label=STRING
Type label for data (Examples: Conns, "Processor Load", In, Out)
-u, --units=STRING
Option units label for data (Example: Packets/Sec, Errors/Sec,
"Bytes Per Second", "%% Utilization")
If the value exceeds the <vwl> threshold, a WARNING status is returned. If
the value exceeds the <vcl> threshold, a CRITICAL status is returned. If
the data in the log file is older than <expire_minutes> old, a WARNING
status is returned and a warning message is printed.
This plugin is useful for monitoring MRTG data that does not correspond to
bandwidth usage. (Use the check_mrtgtraf plugin for monitoring bandwidth).
It can be used to monitor any kind of data that MRTG is monitoring - errors,
packets/sec, etc. I use MRTG in conjuction with the Novell NLM that allows
me to track processor utilization, user connections, drive space, etc and
this plugin works well for monitoring that kind of data as well.
Notes:
- This plugin only monitors one of the two variables stored in the MRTG log
file. If you want to monitor both values you will have to define two
commands with different values for the <variable> argument. Of course,
you can always hack the code to make this plugin work for you...
- MRTG stands for the Multi Router Traffic Grapher. It can be downloaded from
http://ee-staff.ethz.ch/~oetiker/webtools/mrtg/mrtg.html
Send email to nagios-users@lists.sourceforge.net if you have questions
regarding use of this software. To submit patches or suggest improvements,
send email to nagiosplug-devel@lists.sourceforge.net
check_mrtgtraf v1991 (nagios-plugins 1.4.12)
Copyright (c) 1999 Ethan Galstad <nagios@nagios.org>
Copyright (c) 1999-2007 Nagios Plugin Development Team
<nagiosplug-devel@lists.sourceforge.net>
This plugin will check the incoming/outgoing transfer rates of a router,
switch, etc recorded in an MRTG log. If the newest log entry is older
than <expire_minutes>, a WARNING status is returned. If either the
incoming or outgoing rates exceed the <icl> or <ocl> thresholds (in
Bytes/sec), a CRITICAL status results. If either of the rates exceed
the <iwl> or <owl> thresholds (in Bytes/sec), a WARNING status results.
Usage check_mrtgtraf -F <log_file> -a <AVG | MAX> -v <variable> -w <warning_pair>-c <critical_pair> [-e expire_minutes] [-t timeout] [-v]
Options:
-h, --help
Print detailed help screen
-V, --version
Print version information
-F, --filename=STRING
File to read log from
-e, --expires=INTEGER
Minutes after which log expires
-a, --aggregation=(AVG|MAX)
Test average or maximum
-w, --warning
Warning threshold pair <incoming>,<outgoing>
-c, --critical
Critical threshold pair <incoming>,<outgoing>
Notes:
- MRTG stands for Multi Router Traffic Grapher. It can be downloaded from
http://ee-staff.ethz.ch/~oetiker/webtools/mrtg/mrtg.html
- While MRTG can monitor things other than traffic rates, this
plugin probably won't work with much else without modification.
- The calculated i/o rates are a little off from what MRTG actually
reports. I'm not sure why this is right now, but will look into it
for future enhancements of this plugin.
Send email to nagios-users@lists.sourceforge.net if you have questions
regarding use of this software. To submit patches or suggest improvements,
send email to nagiosplug-devel@lists.sourceforge.net
check_mysql v1991 (nagios-plugins 1.4.12)
Copyright (c) 1999-2007 Nagios Plugin Development Team
<nagiosplug-devel@lists.sourceforge.net>
This program tests connections to a mysql server
Usage: check_mysql [-d database] [-H host] [-P port] [-s socket]
[-u user] [-p password] [-S]
Options:
-h, --help
Print detailed help screen
-V, --version
Print version information
-H, --hostname=ADDRESS
Host name, IP Address, or unix socket (must be an absolute path)
-P, --port=INTEGER
Port number (default: 3306)
-s, --socket=STRING
Use the specified socket (has no effect if -H is used)
-d, --database=STRING
Check database with indicated name
-u, --username=STRING
Connect using the indicated username
-p, --password=STRING
Use the indicated password to authenticate the connection
==> IMPORTANT: THIS FORM OF AUTHENTICATION IS NOT SECURE!!! <==
Your clear-text password could be visible as a process table entry
-S, --check-slave
Check if the slave thread is running properly.
-w, --warning
Exit with WARNING status if slave server is more than INTEGER seconds
behind master
-c, --critical
Exit with CRITICAL status if slave server is more then INTEGER seconds
behind master
There are no required arguments. By default, the local database is checked
using the default unix socket. You can force TCP on localhost by using an
IP address or FQDN ('localhost' will use the socket as well).
Send email to nagios-users@lists.sourceforge.net if you have questions
regarding use of this software. To submit patches or suggest improvements,
send email to nagiosplug-devel@lists.sourceforge.net
check_mysql_query v1991 (nagios-plugins 1.4.12)
Copyright (c) 1999-2007 Nagios Plugin Development Team
<nagiosplug-devel@lists.sourceforge.net>
This program checks a query result against threshold levels
Usage: check_mysql_query -q SQL_query [-w warn] [-c crit] [-H host] [-P port] [-s socket]
[-d database] [-u user] [-p password]
Options:
-h, --help
Print detailed help screen
-V, --version
Print version information
-q, --query=STRING
SQL query to run. Only first column in first row will be read
-w, --warning=RANGE
Warning range (format: start:end). Alert if outside this range
-c, --critical=RANGE
Critical range
-H, --hostname=ADDRESS
Host name, IP Address, or unix socket (must be an absolute path)
-P, --port=INTEGER
Port number (default: 3306)
-s, --socket=STRING
Use the specified socket (has no effect if -H is used)
-d, --database=STRING
Database to check
-u, --username=STRING
Username to login with
-p, --password=STRING
Password to login with
==> IMPORTANT: THIS FORM OF AUTHENTICATION IS NOT SECURE!!! <==
Your clear-text password could be visible as a process table entry
A query is required. The result from the query should be numeric.
For extra security, create a user with minimal access.
Send email to nagios-users@lists.sourceforge.net if you have questions
regarding use of this software. To submit patches or suggest improvements,
send email to nagiosplug-devel@lists.sourceforge.net
check_nagios v1991 (nagios-plugins 1.4.12)
Copyright (c) 1999-2007 Nagios Plugin Development Team
<nagiosplug-devel@lists.sourceforge.net>
This plugin checks the status of the Nagios process on the local machine
The plugin will check to make sure the Nagios status log is no older than
the number of minutes specified by the expires option.
It also checks the process table for a process matching the command argument.
Usage:check_nagios -F <status log file> -e <expire_minutes> -C <process_string>
Options:
-h, --help
Print detailed help screen
-V, --version
Print version information
-F, --filename=FILE
Name of the log file to check
-e, --expires=INTEGER
Minutes aging after which logfile is considered stale
-C, --command=STRING
Substring to search for in process arguments
-v, --verbose
Show details for command-line debugging (Nagios may truncate output)
Examples:
check_nagios -e 5 -F /usr/local/nagios/var/status.log -C /usr/local/nagios/bin/nagios
Send email to nagios-users@lists.sourceforge.net if you have questions
regarding use of this software. To submit patches or suggest improvements,
send email to nagiosplug-devel@lists.sourceforge.net
check_nntp v1991 (nagios-plugins 1.4.12)
Copyright (c) 1999 Ethan Galstad <nagios@nagios.org>
Copyright (c) 1999-2008 Nagios Plugin Development Team
<nagiosplug-devel@lists.sourceforge.net>
This plugin tests NNTP connections with the specified host (or unix socket).
Usage:check_nntp -H host -p port [-w <warning time>] [-c <critical time>] [-s <send string>]
[-e <expect string>] [-q <quit string>][-m <maximum bytes>] [-d <delay>]
[-t <timeout seconds>] [-r <refuse state>] [-M <mismatch state>] [-v] [-4|-6] [-j]
[-D <days to cert expiry>] [-S <use SSL>] [-E]
Options:
-h, --help
Print detailed help screen
-V, --version
Print version information
-H, --hostname=ADDRESS
Host name, IP Address, or unix socket (must be an absolute path)
-p, --port=INTEGER
Port number (default: none)
-4, --use-ipv4
Use IPv4 connection
-6, --use-ipv6
Use IPv6 connection
-E, --escape
Can use \n, \r, \t or \ in send or quit string. Must come before send or quit option
Default: nothing added to send, \r\n added to end of quit
-s, --send=STRING
String to send to the server
-e, --expect=STRING
String to expect in server response (may be repeated)
-A, --all
All expect strings need to occur in server response. Default is any
-q, --quit=STRING
String to send server to initiate a clean close of the connection
-r, --refuse=ok|warn|crit
Accept tcp refusals with states ok, warn, crit (default: crit)
-M, --mismatch=ok|warn|crit
Accept expected string mismatches with states ok, warn, crit (default: warn)
-j, --jail
Hide output from TCP socket
-m, --maxbytes=INTEGER
Close connection once more than this number of bytes are received
-d, --delay=INTEGER
Seconds to wait between sending string and polling for response
-D, --certificate=INTEGER
Minimum number of days a certificate has to be valid.
-S, --ssl
Use SSL for the connection.
-w, --warning=DOUBLE
Response time to result in warning status (seconds)
-c, --critical=DOUBLE
Response time to result in critical status (seconds)
-t, --timeout=INTEGER
Seconds before connection times out (default: 10)
-v, --verbose
Show details for command-line debugging (Nagios may truncate output)
Send email to nagios-users@lists.sourceforge.net if you have questions
regarding use of this software. To submit patches or suggest improvements,
send email to nagiosplug-devel@lists.sourceforge.net
check_nntps v1991 (nagios-plugins 1.4.12)
Copyright (c) 1999 Ethan Galstad <nagios@nagios.org>
Copyright (c) 1999-2008 Nagios Plugin Development Team
<nagiosplug-devel@lists.sourceforge.net>
This plugin tests NNTPS connections with the specified host (or unix socket).
Usage:check_nntps -H host -p port [-w <warning time>] [-c <critical time>] [-s <send string>]
[-e <expect string>] [-q <quit string>][-m <maximum bytes>] [-d <delay>]
[-t <timeout seconds>] [-r <refuse state>] [-M <mismatch state>] [-v] [-4|-6] [-j]
[-D <days to cert expiry>] [-S <use SSL>] [-E]
Options:
-h, --help
Print detailed help screen
-V, --version
Print version information
-H, --hostname=ADDRESS
Host name, IP Address, or unix socket (must be an absolute path)
-p, --port=INTEGER
Port number (default: none)
-4, --use-ipv4
Use IPv4 connection
-6, --use-ipv6
Use IPv6 connection
-E, --escape
Can use \n, \r, \t or \ in send or quit string. Must come before send or quit option
Default: nothing added to send, \r\n added to end of quit
-s, --send=STRING
String to send to the server
-e, --expect=STRING
String to expect in server response (may be repeated)
-A, --all
All expect strings need to occur in server response. Default is any
-q, --quit=STRING
String to send server to initiate a clean close of the connection
-r, --refuse=ok|warn|crit
Accept tcp refusals with states ok, warn, crit (default: crit)
-M, --mismatch=ok|warn|crit
Accept expected string mismatches with states ok, warn, crit (default: warn)
-j, --jail
Hide output from TCP socket
-m, --maxbytes=INTEGER
Close connection once more than this number of bytes are received
-d, --delay=INTEGER
Seconds to wait between sending string and polling for response
-D, --certificate=INTEGER
Minimum number of days a certificate has to be valid.
-S, --ssl
Use SSL for the connection.
-w, --warning=DOUBLE
Response time to result in warning status (seconds)
-c, --critical=DOUBLE
Response time to result in critical status (seconds)
-t, --timeout=INTEGER
Seconds before connection times out (default: 10)
-v, --verbose
Show details for command-line debugging (Nagios may truncate output)
Send email to nagios-users@lists.sourceforge.net if you have questions
regarding use of this software. To submit patches or suggest improvements,
send email to nagiosplug-devel@lists.sourceforge.net
check_nt v1991 (nagios-plugins 1.4.12) Copyright (c) 2000 Yves Rubin (rubiyz@yahoo.com) Copyright (c) 2000-2007 Nagios Plugin Development Team <nagiosplug-devel@lists.sourceforge.net> This plugin collects data from the NSClient service running on a Windows NT/2000/XP/2003 server. Usage:check_nt -H host -v variable [-p port] [-w warning] [-c critical][-l params] [-d SHOWALL] [-t timeout] Options: -h, --help Print detailed help screen -V, --version Print version information Options: -H, --hostname=HOST Name of the host to check -p, --port=INTEGER Optional port number (default: 1248) -s <password> Password needed for the request -w, --warning=INTEGER Threshold which will result in a warning status -c, --critical=INTEGER Threshold which will result in a critical status -t, --timeout=INTEGER Seconds before connection attempt times out (default: 10) -h, --help Print this help screen -V, --version Print version information -v, --variable=STRING Variable to check Valid variables are: CLIENTVERSION = Get the NSClient version If -l <version> is specified, will return warning if versions differ. CPULOAD = Average CPU load on last x minutes. Request a -l parameter with the following syntax: -l <minutes range>,<warning threshold>,<critical threshold>. <minute range> should be less than 24*60. Thresholds are percentage and up to 10 requests can be done in one shot. ie: -l 60,90,95,120,90,95 UPTIME = Get the uptime of the machine. No specific parameters. No warning or critical threshold USEDDISKSPACE = Size and percentage of disk use. Request a -l parameter containing the drive letter only. Warning and critical thresholds can be specified with -w and -c. MEMUSE = Memory use. Warning and critical thresholds can be specified with -w and -c. SERVICESTATE = Check the state of one or several services. Request a -l parameters with the following syntax: -l <service1>,<service2>,<service3>,... You can specify -d SHOWALL in case you want to see working services in the returned string. PROCSTATE = Check if one or several process are running. Same syntax as SERVICESTATE. COUNTER = Check any performance counter of Windows NT/2000. Request a -l parameters with the following syntax: -l "\\<performance object>\\counter","<description> The <description> parameter is optional and is given to a printf output command which requires a float parameter. If <description> does not include "%%", it is used as a label. Some examples: "Paging file usage is %%.2f %%%%" "%%.f %%%% paging file used." INSTANCES = Check any performance counter object of Windows NT/2000. Syntax: check_nt -H <hostname> -p <port> -v INSTANCES -l <counter object> <counter object> is a Windows Perfmon Counter object (eg. Process), if it is two words, it should be enclosed in quotes The returned results will be a comma-separated list of instances on the selected computer for that object. The purpose of this is to be run from command line to determine what instances are available for monitoring without having to log onto the Windows server to run Perfmon directly. It can also be used in scripts that automatically create Nagios service configuration files. Some examples: check_nt -H 192.168.1.1 -p 1248 -v INSTANCES -l Process Notes: - The NSClient service should be running on the server to get any information (http://nsclient.ready2run.nl). - Critical thresholds should be lower than warning thresholds - Default port 1248 is sometimes in use by other services. The error output when this happens contains "Cannot map xxxxx to protocol number". One fix for this is to change the port to something else on check_nt and on the client service it's connecting to. Send email to nagios-users@lists.sourceforge.net if you have questions regarding use of this software. To submit patches or suggest improvements, send email to nagiosplug-devel@lists.sourceforge.net
check_ntp v1991 (nagios-plugins 1.4.12)
Copyright (c) 2006 Sean Finney
Copyright (c) 2006-2008 Nagios Plugin Development Team
<nagiosplug-devel@lists.sourceforge.net>
This plugin checks the selected ntp server
WARNING: check_ntp is deprecated. Please use check_ntp_peer or
check_ntp_time istead.
Usage: check_ntp -H <host> [-w <warn>] [-c <crit>] [-j <warn>] [-k <crit>] [-v verbose]
Options:
-h, --help
Print detailed help screen
-V, --version
Print version information
-H, --hostname=ADDRESS
Host name, IP Address, or unix socket (must be an absolute path)
-p, --port=INTEGER
Port number (default: 123)
-w, --warning=THRESHOLD
Offset to result in warning status (seconds)
-c, --critical=THRESHOLD
Offset to result in critical status (seconds)
-j, --jwarn=THRESHOLD
Warning threshold for jitter
-k, --jcrit=THRESHOLD
Critical threshold for jitter
-t, --timeout=INTEGER
Seconds before connection times out (default: 10)
-v, --verbose
Show details for command-line debugging (Nagios may truncate output)
Notes:
See:
http://nagiosplug.sourceforge.net/developer-guidelines.html#THRESHOLDFOR...
for THRESHOLD format and examples.
Examples:
Normal offset check:
./check_ntp -H ntpserv -w 0.5 -c 1
Check jitter too, avoiding critical notifications if jitter isn't available
(See Notes above for more details on thresholds formats):
./check_ntp -H ntpserv -w 0.5 -c 1 -j -1:100 -k -1:200
Send email to nagios-users@lists.sourceforge.net if you have questions
regarding use of this software. To submit patches or suggest improvements,
send email to nagiosplug-devel@lists.sourceforge.net
WARNING: check_ntp is deprecated. Please use check_ntp_peer or
check_ntp_time istead.
check_nwstat v1590 (nagios-plugins 1.4.10)
Copyright (c) 1999 Ethan Galstad <nagios@nagios.org>
Copyright (c) 2000-2006 Nagios Plugin Development Team
<nagiosplug-devel@lists.sourceforge.net>
This plugin attempts to contact the MRTGEXT NLM running on a
Novell server to gather the requested system information.
Usage:check_nwstat -H host [-p port] [-v variable] [-w warning] [-c critical] [-t timeout]
Options:
-h, --help
Print detailed help screen
-V, --version
Print version information
-H, --hostname=ADDRESS
Host name, IP Address, or unix socket (must be an absolute path)
-p, --port=INTEGER
Port number (default: 9999)
-v, --variable=STRING
Variable to check. Valid variables include:
LOAD1 = 1 minute average CPU load
LOAD5 = 5 minute average CPU load
LOAD15 = 15 minute average CPU load
CSPROCS = number of current service processes (NW 5.x only)
ABENDS = number of abended threads (NW 5.x only)
UPTIME = server uptime
LTCH = percent long term cache hits
CBUFF = current number of cache buffers
CDBUFF = current number of dirty cache buffers
DCB = dirty cache buffers as a percentage of the total
TCB = dirty cache buffers as a percentage of the original
OFILES = number of open files
VMF<vol> = MB of free space on Volume <vol>
VMU<vol> = MB used space on Volume <vol>
VMP<vol> = MB of purgeable space on Volume <vol>
VPF<vol> = percent free space on volume <vol>
VKF<vol> = KB of free space on volume <vol>
VPP<vol> = percent purgeable space on volume <vol>
VKP<vol> = KB of purgeable space on volume <vol>
VPNP<vol> = percent not yet purgeable space on volume <vol>
VKNP<vol> = KB of not yet purgeable space on volume <vol>
LRUM = LRU sitting time in minutes
LRUS = LRU sitting time in seconds
DSDB = check to see if DS Database is open
DSVER = NDS version
UPRB = used packet receive buffers
PUPRB = percent (of max) used packet receive buffers
SAPENTRIES = number of entries in the SAP table
SAPENTRIES<n> = number of entries in the SAP table for SAP type <n>
TSYNC = timesync status
LOGINS = check to see if logins are enabled
CONNS = number of currently licensed connections
NRMH = NRM Summary Status
NRMP<stat> = Returns the current value for a NRM health item
NRMM<stat> = Returns the current memory stats from NRM
NRMS<stat> = Returns the current Swapfile stats from NRM
NSS1<stat> = Statistics from _Admin:Manage_NSS\GeneralStats.xml
NSS3<stat> = Statistics from _Admin:Manage_NSS\NameCache.xml
NSS4<stat> = Statistics from _Admin:Manage_NSS\FileStats.xml
NSS5<stat> = Statistics from _Admin:Manage_NSS\ObjectCache.xml
NSS6<stat> = Statistics from _Admin:Manage_NSS\Thread.xml
NSS7<stat> = Statistics from _Admin:Manage_NSS\AuthorizationCache.xml
NLM:<nlm> = check if NLM is loaded and report version
(e.g. NLM:TSANDS.NLM)
-w, --warning=INTEGER
Threshold which will result in a warning status
-c, --critical=INTEGER
Threshold which will result in a critical status
-o, --osversion
Include server version string in results
-t, --timeout=INTEGER
Seconds before connection times out (default: 10)
Notes:
- This plugin requres that the MRTGEXT.NLM file from James Drews' MRTG
extension for NetWare be loaded on the Novell servers you wish to check.
(available from http://www.engr.wisc.edu/~drews/mrtg/)
- Values for critical thresholds should be lower than warning thresholds
when the following variables are checked: VPF, VKF, LTCH, CBUFF, DCB,
Send email to nagios-users@lists.sourceforge.net if you have questions
regarding use of this software. To submit patches or suggest improvements,
send email to nagiosplug-devel@lists.sourceforge.net
check_overcr v1611 (nagios-plugins 1.4.10)
Copyright (c) 1999 Ethan Galstad <nagios@nagios.org>
Copyright (c) 2000-2006 Nagios Plugin Development Team
<nagiosplug-devel@lists.sourceforge.net>
This plugin attempts to contact the Over-CR collector daemon running on the
remote UNIX server in order to gather the requested system information.
Usage:check_overcr -H host [-p port] [-v variable] [-w warning] [-c critical] [-t timeout]
Options:
-h, --help
Print detailed help screen
-V, --version
Print version information
-H, --hostname=ADDRESS
Host name, IP Address, or unix socket (must be an absolute path)
-p, --port=INTEGER
Port number (default: 2000)
-w, --warning=INTEGER
Threshold which will result in a warning status
-c, --critical=INTEGER
Threshold which will result in a critical status
-v, --variable=STRING
Variable to check. Valid variables include:
LOAD1 = 1 minute average CPU load
LOAD5 = 5 minute average CPU load
LOAD15 = 15 minute average CPU load
DPU<filesys> = percent used disk space on filesystem <filesys>
PROC<process> = number of running processes with name <process>
NET<port> = number of active connections on TCP port <port>
UPTIME = system uptime in seconds
-t, --timeout=INTEGER
Seconds before connection times out (default: 10)
-v, --verbose
Show details for command-line debugging (Nagios may truncate output)
Notes:
For the available options, the critical threshold value should always be
higher than the warning threshold value, EXCEPT with the uptime variable
This plugin requres that Eric Molitors' Over-CR collector daemon be
running on the remote server.
Over-CR can be downloaded from http://www.molitor.org/overcr
This plugin was tested with version 0.99.53 of the Over-CR collector
Send email to nagios-users@lists.sourceforge.net if you have questions
regarding use of this software. To submit patches or suggest improvements,
send email to nagiosplug-devel@lists.sourceforge.net
check_ping v1699 (nagios-plugins 1.4.10)
Copyright (c) 1999 Ethan Galstad <nagios@nagios.org>Copyright (c) 2000-2006 Nagios Plugin Development Team
<nagiosplug-devel@lists.sourceforge.net>
Use ping to check connection statistics for a remote host.
Usage:check_ping -H <host_address> -w <wrta>,<wpl>% -c <crta>,<cpl>%
[-p packets] [-t timeout] [-4|-6]
Options:
-h, --help
Print detailed help screen
-V, --version
Print version information
-4, --use-ipv4
Use IPv4 connection
-6, --use-ipv6
Use IPv6 connection
-H, --hostname=HOST
host to ping
-w, --warning=THRESHOLD
warning threshold pair
-c, --critical=THRESHOLD
critical threshold pair
-p, --packets=INTEGER
number of ICMP ECHO packets to send (Default: 5)
-L, --link
show HTML in the plugin output (obsoleted by urlize)
-t, --timeout=INTEGER
Seconds before connection times out (default: 10)
THRESHOLD is <rta>,<pl>% where <rta> is the round trip average travel
time (ms) which triggers a WARNING or CRITICAL state, and <pl> is the
percentage of packet loss to trigger an alarm state.
This plugin uses the ping command to probe the specified host for packet loss
(percentage) and round trip average (milliseconds). It can produce HTML output
linking to a traceroute CGI contributed by Ian Cass. The CGI can be found in
the contrib area of the downloads section at http://www.nagios.org/
Send email to nagios-users@lists.sourceforge.net if you have questions
regarding use of this software. To submit patches or suggest improvements,
send email to nagiosplug-devel@lists.sourceforge.net
check_pop v1729 (nagios-plugins 1.4.10)
Copyright (c) 1999 Ethan Galstad <nagios@nagios.org>
Copyright (c) 1999-2006 Nagios Plugin Development Team
<nagiosplug-devel@lists.sourceforge.net>
This plugin tests POP connections with the specified host (or unix socket).
Usage:check_pop -H host -p port [-w <warning time>] [-c <critical time>] [-s <send string>]
[-e <expect string>] [-q <quit string>][-m <maximum bytes>] [-d <delay>]
[-t <timeout seconds>] [-r <refuse state>] [-M <mismatch state>] [-v] [-4|-6] [-j]
[-D <days to cert expiry>] [-S <use SSL>] [-E]
Options:
-h, --help
Print detailed help screen
-V, --version
Print version information
-H, --hostname=ADDRESS
Host name, IP Address, or unix socket (must be an absolute path)
-p, --port=INTEGER
Port number (default: none)
-4, --use-ipv4
Use IPv4 connection
-6, --use-ipv6
Use IPv6 connection
-E, --escape
Can use \n, \r, \t or \ in send or quit string. Must come before send or quit option
Default: nothing added to send, \r\n added to end of quit
-s, --send=STRING
String to send to the server
-e, --expect=STRING
String to expect in server response (may be repeated)
-A, --all
All expect strings need to occur in server response. Default is any
-q, --quit=STRING
String to send server to initiate a clean close of the connection
-r, --refuse=ok|warn|crit
Accept tcp refusals with states ok, warn, crit (default: crit)
-M, --mismatch=ok|warn|crit
Accept expected string mismatches with states ok, warn, crit (default: warn)
-j, --jail
Hide output from TCP socket
-m, --maxbytes=INTEGER
Close connection once more than this number of bytes are received
-d, --delay=INTEGER
Seconds to wait between sending string and polling for response
-D, --certificate=INTEGER
Minimum number of days a certificate has to be valid.
-S, --ssl
Use SSL for the connection.
-w, --warning=DOUBLE
Response time to result in warning status (seconds)
-c, --critical=DOUBLE
Response time to result in critical status (seconds)
-t, --timeout=INTEGER
Seconds before connection times out (default: 10)
-v, --verbose
Show details for command-line debugging (Nagios may truncate output)
Send email to nagios-users@lists.sourceforge.net if you have questions
regarding use of this software. To submit patches or suggest improvements,
send email to nagiosplug-devel@lists.sourceforge.net
check_procs v1758 (nagios-plugins 1.4.10)
Copyright (c) 1999 Ethan Galstad <nagios@nagios.org>Copyright (c) 2000-2006 Nagios Plugin Development Team
<nagiosplug-devel@lists.sourceforge.net>
Checks all processes and generates WARNING or CRITICAL states if the specified
metric is outside the required threshold ranges. The metric defaults to number
of processes. Search filters can be applied to limit the processes to check.
Usage:check_procs -w <range> -c <range> [-m metric] [-s state] [-p ppid]
[-u user] [-r rss] [-z vsz] [-P %cpu] [-a argument-array]
[-C command] [-t timeout] [-v]
Required Arguments:
-w, --warning=RANGE
Generate warning state if metric is outside this range
-c, --critical=RANGE
Generate critical state if metric is outside this range
Optional Arguments:
-m, --metric=TYPE
Check thresholds against metric. Valid types:
PROCS - number of processes (default)
VSZ - virtual memory size
RSS - resident set memory size
CPU - percentage cpu
ELAPSED - time elapsed in seconds
-t, --timeout=INTEGER
Seconds before connection times out (default: 10)
-v, --verbose
Extra information. Up to 3 verbosity levels
Optional Filters:
-s, --state=STATUSFLAGS
Only scan for processes that have, in the output of `ps`, one or
more of the status flags you specify (for example R, Z, S, RS,
RSZDT, plus others based on the output of your 'ps' command).
-p, --ppid=PPID
Only scan for children of the parent process ID indicated.
-z, --vsz=VSZ
Only scan for processes with vsz higher than indicated.
-r, --rss=RSS
Only scan for processes with rss higher than indicated.
-P, --pcpu=PCPU
Only scan for processes with pcpu higher than indicated.
-u, --user=USER
Only scan for processes with user name or ID indicated.
-a, --argument-array=STRING
Only scan for processes with args that contain STRING.
-C, --command=COMMAND
Only scan for exact matches of COMMAND (without path).
RANGEs are specified 'min:max' or 'min:' or ':max' (or 'max'). If
specified 'max:min', a warning status will be generated if the
count is inside the specified range
This plugin checks the number of currently running processes and
generates WARNING or CRITICAL states if the process count is outside
the specified threshold ranges. The process count can be filtered by
process owner, parent process PID, current state (e.g., 'Z'), or may
be the total number of running processes
Examples:
check_procs -w 2:2 -c 2:1024 -C portsentry
Warning if not two processes with command name portsentry.
Critical if < 2 or > 1024 processes
check_procs -w 10 -a '/usr/local/bin/perl' -u root
Warning alert if > 10 processes with command arguments containing
'/usr/local/bin/perl' and owned by root
check_procs -w 50000 -c 100000 --metric=VSZ
Alert if vsz of any processes over 50K or 100K
check_procs -w 10 -c 20 --metric=CPU
Alert if cpu of any processes over 10%% or 20%%
Send email to nagios-users@lists.sourceforge.net if you have questions
regarding use of this software. To submit patches or suggest improvements,
send email to nagiosplug-devel@lists.sourceforge.net
check_radius v1800 (nagios-plugins 1.4.10)
Copyright (c) 1999 Robert August Vincent II
Copyright (c) 2000-2006 Nagios Plugin Development Team
<nagiosplug-devel@lists.sourceforge.net>
Tests to see if a radius server is accepting connections.
Usage:check_radius -H host -F config_file -u username -p password [-n nas-id] [-P port]
[-t timeout] [-r retries] [-e expect]
Options:
-h, --help
Print detailed help screen
-V, --version
Print version information
-H, --hostname=ADDRESS
Host name, IP Address, or unix socket (must be an absolute path)
-P, --port=INTEGER
Port number (default: 1645)
-u, --username=STRING
The user to authenticate
-p, --password=STRING
Password for autentication (SECURITY RISK)
-n, --nas-id=STRING
NAS identifier
-F, --filename=STRING
Configuration file
-e, --expect=STRING
Response string to expect from the server
-r, --retries=INTEGER
Number of times to retry a failed connection
-t, --timeout=INTEGER
Seconds before connection times out (default: 10)
This plugin tests a radius server to see if it is accepting connections.
The server to test must be specified in the invocation, as well as a user
name and password. A configuration file may also be present. The format of
the configuration file is described in the radiusclient library sources.
The password option presents a substantial security issue because the
password can be determined by careful watching of the command line in
a process listing. This risk is exacerbated because nagios will
run the plugin at regular prdictable intervals. Please be sure that
the password used does not allow access to sensitive system resources,
otherwise compormise could occur.
Send email to nagios-users@lists.sourceforge.net if you have questions
regarding use of this software. To submit patches or suggest improvements,
send email to nagiosplug-devel@lists.sourceforge.net
check_real v1590 (nagios-plugins 1.4.10)
Copyright (c) 1999 Pedro Leite <leite@cic.ua.pt>
Copyright (c) 2000-2006 Nagios Plugin Development Team
<nagiosplug-devel@lists.sourceforge.net>
This plugin tests the REAL service on the specified host.
Usage:check_real -H host [-e expect] [-p port] [-w warn] [-c crit] [-t timeout] [-v]
Options:
-h, --help
Print detailed help screen
-V, --version
Print version information
-H, --hostname=ADDRESS
Host name, IP Address, or unix socket (must be an absolute path)
-p, --port=INTEGER
Port number (default: 554)
-u, --url=STRING
Connect to this url
-e, --expect=STRING
String to expect in first line of server response (default: RTSP/1.)
-w, --warning=DOUBLE
Response time to result in warning status (seconds)
-c, --critical=DOUBLE
Response time to result in critical status (seconds)
-t, --timeout=INTEGER
Seconds before connection times out (default: 10)
-v, --verbose
Show details for command-line debugging (Nagios may truncate output)
This plugin will attempt to open an RTSP connection with the host.
Successul connects return STATE_OK, refusals and timeouts return
STATE_CRITICAL, other errors return STATE_UNKNOWN. Successful connects,
but incorrect reponse messages from the host result in STATE_WARNING return
values.
Send email to nagios-users@lists.sourceforge.net if you have questions
regarding use of this software. To submit patches or suggest improvements,
send email to nagiosplug-devel@lists.sourceforge.net
check_simap v1729 (nagios-plugins 1.4.10)
Copyright (c) 1999 Ethan Galstad <nagios@nagios.org>
Copyright (c) 1999-2006 Nagios Plugin Development Team
<nagiosplug-devel@lists.sourceforge.net>
This plugin tests SIMAP connections with the specified host (or unix socket).
Usage:check_simap -H host -p port [-w <warning time>] [-c <critical time>] [-s <send string>]
[-e <expect string>] [-q <quit string>][-m <maximum bytes>] [-d <delay>]
[-t <timeout seconds>] [-r <refuse state>] [-M <mismatch state>] [-v] [-4|-6] [-j]
[-D <days to cert expiry>] [-S <use SSL>] [-E]
Options:
-h, --help
Print detailed help screen
-V, --version
Print version information
-H, --hostname=ADDRESS
Host name, IP Address, or unix socket (must be an absolute path)
-p, --port=INTEGER
Port number (default: none)
-4, --use-ipv4
Use IPv4 connection
-6, --use-ipv6
Use IPv6 connection
-E, --escape
Can use \n, \r, \t or \ in send or quit string. Must come before send or quit option
Default: nothing added to send, \r\n added to end of quit
-s, --send=STRING
String to send to the server
-e, --expect=STRING
String to expect in server response (may be repeated)
-A, --all
All expect strings need to occur in server response. Default is any
-q, --quit=STRING
String to send server to initiate a clean close of the connection
-r, --refuse=ok|warn|crit
Accept tcp refusals with states ok, warn, crit (default: crit)
-M, --mismatch=ok|warn|crit
Accept expected string mismatches with states ok, warn, crit (default: warn)
-j, --jail
Hide output from TCP socket
-m, --maxbytes=INTEGER
Close connection once more than this number of bytes are received
-d, --delay=INTEGER
Seconds to wait between sending string and polling for response
-D, --certificate=INTEGER
Minimum number of days a certificate has to be valid.
-S, --ssl
Use SSL for the connection.
-w, --warning=DOUBLE
Response time to result in warning status (seconds)
-c, --critical=DOUBLE
Response time to result in critical status (seconds)
-t, --timeout=INTEGER
Seconds before connection times out (default: 10)
-v, --verbose
Show details for command-line debugging (Nagios may truncate output)
Send email to nagios-users@lists.sourceforge.net if you have questions
regarding use of this software. To submit patches or suggest improvements,
send email to nagiosplug-devel@lists.sourceforge.net
check_smtp v1780 (nagios-plugins 1.4.10)
Copyright (c) 1999-2001 Ethan Galstad <nagios@nagios.org>
Copyright (c) 2000-2006 Nagios Plugin Development Team
<nagiosplug-devel@lists.sourceforge.net>
This plugin will attempt to open an SMTP connection with the host.
Usage:check_smtp -H host [-p port] [-e expect] [-C command] [-f from addr][-A authtype -U authuser -P authpass] [-w warn] [-c crit] [-t timeout]
[-S] [-D days] [-n] [-v] [-4|-6]
Options:
-h, --help
Print detailed help screen
-V, --version
Print version information
-H, --hostname=ADDRESS
Host name, IP Address, or unix socket (must be an absolute path)
-p, --port=INTEGER
Port number (default: 25)
-4, --use-ipv4
Use IPv4 connection
-6, --use-ipv6
Use IPv6 connection
-e, --expect=STRING
String to expect in first line of server response (default: '220')
-n, nocommand
Suppress SMTP command
-C, --command=STRING
SMTP command (may be used repeatedly)
-R, --command=STRING
Expected response to command (may be used repeatedly)
-f, --from=STRING
FROM-address to include in MAIL command, required by Exchange 2000
-D, --certificate=INTEGER
Minimum number of days a certificate has to be valid.
-S, --starttls
Use STARTTLS for the connection.
-A, --authtype=STRING
SMTP AUTH type to check (default none, only LOGIN supported)
-U, --authuser=STRING
SMTP AUTH username
-P, --authpass=STRING
SMTP AUTH password
-w, --warning=DOUBLE
Response time to result in warning status (seconds)
-c, --critical=DOUBLE
Response time to result in critical status (seconds)
-t, --timeout=INTEGER
Seconds before connection times out (default: 10)
-v, --verbose
Show details for command-line debugging (Nagios may truncate output)
Successul connects return STATE_OK, refusals and timeouts return
STATE_CRITICAL, other errors return STATE_UNKNOWN. Successful
connects, but incorrect reponse messages from the host result in
STATE_WARNING return values.
Send email to nagios-users@lists.sourceforge.net if you have questions
regarding use of this software. To submit patches or suggest improvements,
send email to nagiosplug-devel@lists.sourceforge.net
check_snmp v1721 (nagios-plugins 1.4.9)
Copyright (c) 1999-2007 Nagios Plugin Development Team
<nagiosplug-devel@lists.sourceforge.net>
Check status of remote machines and obtain sustem information via SNMP
Usage:check_snmp -H <ip_address> -o <OID> [-w warn_range] [-c crit_range]
[-C community] [-s string] [-r regex] [-R regexi] [-t timeout] [-e retries]
[-l label] [-u units] [-p port-number] [-d delimiter] [-D output-delimiter]
[-m miblist] [-P snmp version] [-L seclevel] [-U secname] [-a authproto]
[-A authpasswd] [-X privpasswd]
Options:
-h, --help
Print detailed help screen
-V, --version
Print version information
-H, --hostname=ADDRESS
Host name, IP Address, or unix socket (must be an absolute path)
-p, --port=INTEGER
Port number (default: 161)
-n, --next
Use SNMP GETNEXT instead of SNMP GET
-P, --protocol=[1|2c|3]
SNMP protocol version
-L, --seclevel=[noAuthNoPriv|authNoPriv|authPriv]
SNMPv3 securityLevel
-a, --authproto=[MD5|SHA]
SNMPv3 auth proto
-C, --community=STRING
Optional community string for SNMP communication
(default is "public") -U, --secname=USERNAME
SNMPv3 username
-A, --authpassword=PASSWORD
SNMPv3 authentication password
-X, --privpasswd=PASSWORD
SNMPv3 crypt passwd (DES)
-o, --oid=OID(s)
Object identifier(s) or SNMP variables whose value you wish to query
-m, --miblist=STRING
List of MIBS to be loaded (default = none if using numeric oids or 'ALL'
for symbolic oids.)
-d, --delimiter=STRING
Delimiter to use when parsing returned data. Default is "=" Any data on the right hand side of the delimiter is considered
to be the data that should be used in the evaluation.
-w, --warning=INTEGER_RANGE(s)
Range(s) which will not result in a WARNING status
-c, --critical=INTEGER_RANGE(s)
Range(s) which will not result in a CRITICAL status
-s, --string=STRING
Return OK state (for that OID) if STRING is an exact match
-r, --ereg=REGEX
Return OK state (for that OID) if extended regular expression REGEX matches
-R, --eregi=REGEX
Return OK state (for that OID) if case-insensitive extended REGEX matches
-l, --label=STRING
Prefix label for output from plugin (default -s 'SNMP')
-u, --units=STRING
Units label(s) for output data (e.g., 'sec.').
-D, --output-delimiter=STRING
Separates output on multiple OID requests
-t, --timeout=INTEGER
Seconds before connection times out (default: 10)
-v, --verbose
Show details for command-line debugging (Nagios may truncate output)
This plugin uses the 'snmpget' command included with the NET-SNMP package.
if you don't have the package installed, you will need to download it from
http://net-snmp.sourceforge.net before you can use this plugin.
- Multiple OIDs may be indicated by a comma- or space-delimited list (lists with
internal spaces must be quoted) [max 8 OIDs]
- Ranges are inclusive and are indicated with colons. When specified as
'min:max' a STATE_OK will be returned if the result is within the indicated
range or is equal to the upper or lower bound. A non-OK state will be
returned if the result is outside the specified range.
- If specified in the order 'max:min' a non-OK state will be returned if the
result is within the (inclusive) range.
- Upper or lower bounds may be omitted to skip checking the respective limit.
- Bare integers are interpreted as upper limits.
- When checking multiple OIDs, separate ranges by commas like '-w 1:10,1:,:20'
- Note that only one string and one regex may be checked at present
- All evaluation methods other than PR, STR, and SUBSTR expect that the value
returned from the SNMP query is an unsigned integer.
Send email to nagios-users@lists.sourceforge.net if you have questions
regarding use of this software. To submit patches or suggest improvements,
send email to nagiosplug-devel@lists.sourceforge.net
check_spop v1729 (nagios-plugins 1.4.10)
Copyright (c) 1999 Ethan Galstad <nagios@nagios.org>
Copyright (c) 1999-2006 Nagios Plugin Development Team
<nagiosplug-devel@lists.sourceforge.net>
This plugin tests SPOP connections with the specified host (or unix socket).
Usage:check_spop -H host -p port [-w <warning time>] [-c <critical time>] [-s <send string>]
[-e <expect string>] [-q <quit string>][-m <maximum bytes>] [-d <delay>]
[-t <timeout seconds>] [-r <refuse state>] [-M <mismatch state>] [-v] [-4|-6] [-j]
[-D <days to cert expiry>] [-S <use SSL>] [-E]
Options:
-h, --help
Print detailed help screen
-V, --version
Print version information
-H, --hostname=ADDRESS
Host name, IP Address, or unix socket (must be an absolute path)
-p, --port=INTEGER
Port number (default: none)
-4, --use-ipv4
Use IPv4 connection
-6, --use-ipv6
Use IPv6 connection
-E, --escape
Can use \n, \r, \t or \ in send or quit string. Must come before send or quit option
Default: nothing added to send, \r\n added to end of quit
-s, --send=STRING
String to send to the server
-e, --expect=STRING
String to expect in server response (may be repeated)
-A, --all
All expect strings need to occur in server response. Default is any
-q, --quit=STRING
String to send server to initiate a clean close of the connection
-r, --refuse=ok|warn|crit
Accept tcp refusals with states ok, warn, crit (default: crit)
-M, --mismatch=ok|warn|crit
Accept expected string mismatches with states ok, warn, crit (default: warn)
-j, --jail
Hide output from TCP socket
-m, --maxbytes=INTEGER
Close connection once more than this number of bytes are received
-d, --delay=INTEGER
Seconds to wait between sending string and polling for response
-D, --certificate=INTEGER
Minimum number of days a certificate has to be valid.
-S, --ssl
Use SSL for the connection.
-w, --warning=DOUBLE
Response time to result in warning status (seconds)
-c, --critical=DOUBLE
Response time to result in critical status (seconds)
-t, --timeout=INTEGER
Seconds before connection times out (default: 10)
-v, --verbose
Show details for command-line debugging (Nagios may truncate output)
Send email to nagios-users@lists.sourceforge.net if you have questions
regarding use of this software. To submit patches or suggest improvements,
send email to nagiosplug-devel@lists.sourceforge.net
check_ssh v1590 (nagios-plugins 1.4.10)
Copyright (c) 1999 Remi Paulmier <remi@sinfomic.fr>
Copyright (c) 2000-2006 Nagios Plugin Development Team
<nagiosplug-devel@lists.sourceforge.net>
Try to connect to an SSH server at specified server and port
Usage:check_ssh [-46] [-t <timeout>] [-r <remote version>] [-p <port>] <host>
Options:
-h, --help
Print detailed help screen
-V, --version
Print version information
-H, --hostname=ADDRESS
Host name, IP Address, or unix socket (must be an absolute path)
-p, --port=INTEGER
Port number (default: 22)
-4, --use-ipv4
Use IPv4 connection
-6, --use-ipv6
Use IPv6 connection
-t, --timeout=INTEGER
Seconds before connection times out (default: 10)
-r, --remote-version=STRING
Warn if string doesn't match expected server version (ex: OpenSSH_3.9p1)
-v, --verbose
Show details for command-line debugging (Nagios may truncate output)
Send email to nagios-users@lists.sourceforge.net if you have questions
regarding use of this software. To submit patches or suggest improvements,
send email to nagiosplug-devel@lists.sourceforge.net
check_ssmtp v1729 (nagios-plugins 1.4.10)
Copyright (c) 1999 Ethan Galstad <nagios@nagios.org>
Copyright (c) 1999-2006 Nagios Plugin Development Team
<nagiosplug-devel@lists.sourceforge.net>
This plugin tests SSMTP connections with the specified host (or unix socket).
Usage:check_ssmtp -H host -p port [-w <warning time>] [-c <critical time>] [-s <send string>]
[-e <expect string>] [-q <quit string>][-m <maximum bytes>] [-d <delay>]
[-t <timeout seconds>] [-r <refuse state>] [-M <mismatch state>] [-v] [-4|-6] [-j]
[-D <days to cert expiry>] [-S <use SSL>] [-E]
Options:
-h, --help
Print detailed help screen
-V, --version
Print version information
-H, --hostname=ADDRESS
Host name, IP Address, or unix socket (must be an absolute path)
-p, --port=INTEGER
Port number (default: none)
-4, --use-ipv4
Use IPv4 connection
-6, --use-ipv6
Use IPv6 connection
-E, --escape
Can use \n, \r, \t or \ in send or quit string. Must come before send or quit option
Default: nothing added to send, \r\n added to end of quit
-s, --send=STRING
String to send to the server
-e, --expect=STRING
String to expect in server response (may be repeated)
-A, --all
All expect strings need to occur in server response. Default is any
-q, --quit=STRING
String to send server to initiate a clean close of the connection
-r, --refuse=ok|warn|crit
Accept tcp refusals with states ok, warn, crit (default: crit)
-M, --mismatch=ok|warn|crit
Accept expected string mismatches with states ok, warn, crit (default: warn)
-j, --jail
Hide output from TCP socket
-m, --maxbytes=INTEGER
Close connection once more than this number of bytes are received
-d, --delay=INTEGER
Seconds to wait between sending string and polling for response
-D, --certificate=INTEGER
Minimum number of days a certificate has to be valid.
-S, --ssl
Use SSL for the connection.
-w, --warning=DOUBLE
Response time to result in warning status (seconds)
-c, --critical=DOUBLE
Response time to result in critical status (seconds)
-t, --timeout=INTEGER
Seconds before connection times out (default: 10)
-v, --verbose
Show details for command-line debugging (Nagios may truncate output)
Send email to nagios-users@lists.sourceforge.net if you have questions
regarding use of this software. To submit patches or suggest improvements,
send email to nagiosplug-devel@lists.sourceforge.net
check_swap v1613 (nagios-plugins 1.4.10)
Copyright (c) 2000-2006 Nagios Plugin Development Team
<nagiosplug-devel@lists.sourceforge.net>
Check swap space on local machine.
Usage:check_swap [-av] -w <percent_free>% -c <percent_free>%
check_swap [-av] -w <bytes_free> -c <bytes_free>
Options:
-h, --help
Print detailed help screen
-V, --version
Print version information
-w, --warning=INTEGER
Exit with WARNING status if less than INTEGER bytes of swap space are free
-w, --warning=PERCENT%%
Exit with WARNING status if less than PERCENT of swap space is free
-c, --critical=INTEGER
Exit with CRITICAL status if less than INTEGER bytes of swap space are free
-c, --critical=PERCENT%%
Exit with CRITCAL status if less than PERCENT of swap space is free
-a, --allswaps
Conduct comparisons for all swap partitions, one by one
-v, --verbose
Verbose output. Up to 3 levels
Notes:
On AIX, if -a is specified, uses lsps -a, otherwise uses lsps -s.
Send email to nagios-users@lists.sourceforge.net if you have questions
regarding use of this software. To submit patches or suggest improvements,
send email to nagiosplug-devel@lists.sourceforge.net
check_tcp v1729 (nagios-plugins 1.4.10)
Copyright (c) 1999 Ethan Galstad <nagios@nagios.org>
Copyright (c) 1999-2006 Nagios Plugin Development Team
<nagiosplug-devel@lists.sourceforge.net>
This plugin tests TCP connections with the specified host (or unix socket).
Usage:check_tcp -H host -p port [-w <warning time>] [-c <critical time>] [-s <send string>]
[-e <expect string>] [-q <quit string>][-m <maximum bytes>] [-d <delay>]
[-t <timeout seconds>] [-r <refuse state>] [-M <mismatch state>] [-v] [-4|-6] [-j]
[-D <days to cert expiry>] [-S <use SSL>] [-E]
Options:
-h, --help
Print detailed help screen
-V, --version
Print version information
-H, --hostname=ADDRESS
Host name, IP Address, or unix socket (must be an absolute path)
-p, --port=INTEGER
Port number (default: none)
-4, --use-ipv4
Use IPv4 connection
-6, --use-ipv6
Use IPv6 connection
-E, --escape
Can use \n, \r, \t or \ in send or quit string. Must come before send or quit option
Default: nothing added to send, \r\n added to end of quit
-s, --send=STRING
String to send to the server
-e, --expect=STRING
String to expect in server response (may be repeated)
-A, --all
All expect strings need to occur in server response. Default is any
-q, --quit=STRING
String to send server to initiate a clean close of the connection
-r, --refuse=ok|warn|crit
Accept tcp refusals with states ok, warn, crit (default: crit)
-M, --mismatch=ok|warn|crit
Accept expected string mismatches with states ok, warn, crit (default: warn)
-j, --jail
Hide output from TCP socket
-m, --maxbytes=INTEGER
Close connection once more than this number of bytes are received
-d, --delay=INTEGER
Seconds to wait between sending string and polling for response
-D, --certificate=INTEGER
Minimum number of days a certificate has to be valid.
-S, --ssl
Use SSL for the connection.
-w, --warning=DOUBLE
Response time to result in warning status (seconds)
-c, --critical=DOUBLE
Response time to result in critical status (seconds)
-t, --timeout=INTEGER
Seconds before connection times out (default: 10)
-v, --verbose
Show details for command-line debugging (Nagios may truncate output)
Send email to nagios-users@lists.sourceforge.net if you have questions
regarding use of this software. To submit patches or suggest improvements,
send email to nagiosplug-devel@lists.sourceforge.net
check_time v1703 (nagios-plugins 1.4.10)
Copyright (c) 1999 Ethan Galstad
Copyright (c) 1999-2006 Nagios Plugin Development Team
<nagiosplug-devel@lists.sourceforge.net>
This plugin will check the time on the specified host.
Usage:check_time -H <host_address> [-p port] [-u] [-w variance] [-c variance]
[-W connect_time] [-C connect_time] [-t timeout]
Options:
-h, --help
Print detailed help screen
-V, --version
Print version information
-H, --hostname=ADDRESS
Host name, IP Address, or unix socket (must be an absolute path)
-p, --port=INTEGER
Port number (default: 37)
-u, --udp
Use UDP to connect, not TCP
-w, --warning-variance=INTEGER
Time difference (sec.) necessary to result in a warning status
-c, --critical-variance=INTEGER
Time difference (sec.) necessary to result in a critical status
-W, --warning-connect=INTEGER
Response time (sec.) necessary to result in warning status
-C, --critical-connect=INTEGER
Response time (sec.) necessary to result in critical status
-t, --timeout=INTEGER
Seconds before connection times out (default: 10)
Send email to nagios-users@lists.sourceforge.net if you have questions
regarding use of this software. To submit patches or suggest improvements,
send email to nagiosplug-devel@lists.sourceforge.net
check_udp v1729 (nagios-plugins 1.4.10)
Copyright (c) 1999 Ethan Galstad <nagios@nagios.org>
Copyright (c) 1999-2006 Nagios Plugin Development Team
<nagiosplug-devel@lists.sourceforge.net>
This plugin tests UDP connections with the specified host (or unix socket).
Usage:check_udp -H host -p port [-w <warning time>] [-c <critical time>] [-s <send string>]
[-e <expect string>] [-q <quit string>][-m <maximum bytes>] [-d <delay>]
[-t <timeout seconds>] [-r <refuse state>] [-M <mismatch state>] [-v] [-4|-6] [-j]
[-D <days to cert expiry>] [-S <use SSL>] [-E]
Options:
-h, --help
Print detailed help screen
-V, --version
Print version information
-H, --hostname=ADDRESS
Host name, IP Address, or unix socket (must be an absolute path)
-p, --port=INTEGER
Port number (default: none)
-4, --use-ipv4
Use IPv4 connection
-6, --use-ipv6
Use IPv6 connection
-E, --escape
Can use \n, \r, \t or \ in send or quit string. Must come before send or quit option
Default: nothing added to send, \r\n added to end of quit
-s, --send=STRING
String to send to the server
-e, --expect=STRING
String to expect in server response (may be repeated)
-A, --all
All expect strings need to occur in server response. Default is any
-q, --quit=STRING
String to send server to initiate a clean close of the connection
-r, --refuse=ok|warn|crit
Accept tcp refusals with states ok, warn, crit (default: crit)
-M, --mismatch=ok|warn|crit
Accept expected string mismatches with states ok, warn, crit (default: warn)
-j, --jail
Hide output from TCP socket
-m, --maxbytes=INTEGER
Close connection once more than this number of bytes are received
-d, --delay=INTEGER
Seconds to wait between sending string and polling for response
-D, --certificate=INTEGER
Minimum number of days a certificate has to be valid.
-S, --ssl
Use SSL for the connection.
-w, --warning=DOUBLE
Response time to result in warning status (seconds)
-c, --critical=DOUBLE
Response time to result in critical status (seconds)
-t, --timeout=INTEGER
Seconds before connection times out (default: 10)
-v, --verbose
Show details for command-line debugging (Nagios may truncate output)
Send email to nagios-users@lists.sourceforge.net if you have questions
regarding use of this software. To submit patches or suggest improvements,
send email to nagiosplug-devel@lists.sourceforge.net
check_ups v1709 (nagios-plugins 1.4.10) Copyright (c) 2000 Tom ShieldsCopyright (c) 2004 Alain Richard <alain.richard@equation.fr> Copyright (c) 2004 Arnaud Quette <arnaud.quette@mgeups.com> Copyright (c) 2002-2006 Nagios Plugin Development Team <nagiosplug-devel@lists.sourceforge.net> This plugin tests the UPS service on the specified host.Network UPS Tools from www.networkupstools.org must be running for thisplugin to work. Usage:check_ups -H host -u ups [-p port] [-v variable] [-w warn_value] [-c crit_value] [-to to_sec] [-T] Options: -h, --help Print detailed help screen -V, --version Print version information -H, --hostname=ADDRESS Host name, IP Address, or unix socket (must be an absolute path) -p, --port=INTEGER Port number (default: 3493) -u, --ups=STRING Name of UPS -T, --temperature Output of temperatures in Celsius -v, --variable=STRING Valid values for STRING are LINE, TEMP, BATTPCT or LOADPCT -w, --warning=DOUBLE Response time to result in warning status (seconds) -c, --critical=DOUBLE Response time to result in critical status (seconds) -t, --timeout=INTEGER Seconds before connection times out (default: 10) Notes: This plugin attempts to determine the status of a UPS (Uninterruptible Power Supply) on a local or remote host. If the UPS is online or calibrating, the plugin will return an OK state. If the battery is on it will return a WARNING state.If the UPS is off or has a low battery the plugin will return a CRITICAL state. You may also specify a variable to check [such as temperature, utility voltage, battery load, etc.] as well as warning and critical thresholds for the value of that variable. If the remote host has multiple UPS that are being monitored you will have to use the [ups] option to specify which UPS to check. This plugin requires that the UPSD daemon distributed with Russel Kroll's Smart UPS Tools be installed on the remote host. If you do not have the package installed on your system, you can download it from http://www.networkupstools.org Send email to nagios-users@lists.sourceforge.net if you have questions regarding use of this software. To submit patches or suggest improvements, send email to nagiosplug-devel@lists.sourceforge.net
check_users v1590 (nagios-plugins 1.4.10)
Copyright (c) 1999 Ethan Galstad
Copyright (c) 2000-2006 Nagios Plugin Development Team
<nagiosplug-devel@lists.sourceforge.net>
This plugin checks the number of users currently logged in on the local
system and generates an error if the number exceeds the thresholds specified.
Usage:check_users -w <users> -c <users>
Options:
-h, --help
Print detailed help screen
-V, --version
Print version information
-w, --warning=INTEGER
Set WARNING status if more than INTEGER users are logged in
-c, --critical=INTEGER
Set CRITICAL status if more than INTEGER users are logged in
Send email to nagios-users@lists.sourceforge.net if you have questions
regarding use of this software. To submit patches or suggest improvements,
send email to nagiosplug-devel@lists.sourceforge.net
negate v1793 (nagios-plugins 1.4.10)
Copyright (c) 2002-2007 Nagios Plugin Development Team
<nagiosplug-devel@lists.sourceforge.net>
Negates the status of a plugin (returns OK for CRITICAL and vice-versa).
Additional switches can be used to control which state becomes what.
Usage:negate [-t timeout] [-owcu STATE] <definition of wrapped plugin>
Options:
-h, --help
Print detailed help screen
-V, --version
Print version information
-t, --timeout=INTEGER
Seconds before connection times out (default: 9)
Keep timeout lower than the plugin timeout to retain CRITICAL status.
-o,--ok=STATUS
-w,--warning=STATUS
-c,--critical=STATUS
-u,--unknown=STATUS
STATUS can be 'OK', 'WARNING', 'CRITICAL' or 'UNKNOWN' without single
quotes. Numeric values are accepted. If nothing is specified, permutes
OK and CRITICAL.
Examples:
negate /usr/local/nagios/libexec/check_ping -H host
Run check_ping and invert result. Must use full path to plugin
negate -w OK -c UNKNOWN /usr/local/nagios/libexec/check_procs -a 'vi negate.c'
This will return OK instead of WARNING and UNKNOWN instead of CRITICAL
Notes:
This plugin is a wrapper to take the output of another plugin and invert it.
The full path of the plugin must be provided.
If the wrapped plugin returns STATE_OK, the wrapper will return STATE_CRITICAL.
If the wrapped plugin returns STATE_CRITICAL, the wrapper will return STATE_OK.
Otherwise, the output state of the wrapped plugin is unchanged.
Send email to nagios-users@lists.sourceforge.net if you have questions
regarding use of this software. To submit patches or suggest improvements,
send email to nagiosplug-devel@lists.sourceforge.net
urlize v1590 (nagios-plugins 1.4.10)
Copyright (c) 2000 Karl DeBisschop <kdebisschop@users.sourceforge.net>
Copyright (c) 2000-2006 Nagios Plugin Development Team
<nagiosplug-devel@lists.sourceforge.net>
This plugin wraps the text output of another command (plugin)
in HTML <A> tags, thus displaying the plugin output in as a clickable link in
the Nagios status screen. The return status is the same as the invoked plugin.
Usage:urlize <url> <plugin> <arg1> ... <argN>
Options:
-h, --help
Print detailed help screen
-V, --version
Print version information
Examples:
Pay close attention to quoting to ensure that the shell passes the expected
data to the plugin. For example, in:
urlize http://example.com/ check_http -H example.com -r 'two words'
the shell will remove the single quotes and urlize will see:
urlize http://example.com/ check_http -H example.com -r two words
You probably want:
urlize http://example.com/ "check_http -H example.com -r 'two words'"
Send email to nagios-users@lists.sourceforge.net if you have questions
regarding use of this software. To submit patches or suggest improvements,
send email to nagiosplug-devel@lists.sourceforge.net