346 KiB

Raw Blame History

Icinga Template Library

The Icinga Template Library (ITL) implements standard templates and object definitions for commonly used services.

By default the ITL is included in the icinga2.conf configuration file:

include <itl>

Generic Templates

These templates are imported by the provided example configuration.

plugin-check-command

Command template for check plugins executed by Icinga 2.

The plugin-check-command command does not support any vars.

plugin-notification-command

Command template for notification scripts executed by Icinga 2.

The plugin-notification-command command does not support any vars.

plugin-event-command

Command template for event handler scripts executed by Icinga 2.

The plugin-event-command command does not support any vars.

Check Commands

These check commands are embedded into Icinga 2 and do not require any external plugin scripts.

icinga

Check command for the built-in icinga check. This check returns performance data for the current Icinga instance.

The icinga check command does not support any vars.

cluster

Check command for the built-in cluster check. This check returns performance data for the current Icinga instance and connected endpoints.

The cluster check command does not support any vars.

cluster-zone

Check command for the built-in cluster-zone check.

Custom attributes passed as command parameters:

Name	Description
cluster_zone	Required. The zone name.
cluster_lag_warning	Optional. Warning threshold for log lag in seconds. Applies if the log lag is greater than the threshold.
cluster_lag_critical	Optional. Critical threshold for log lag in seconds. Applies if the log lag is greater than the threshold.

ido

Check command for the built-in ido check.

Custom attributes passed as command parameters:

Name	Description
ido_type	Required. The type of the IDO connection object. Can be either "IdoMysqlConnection" or "IdoPgsqlConnection".
ido_name	Required. The name of the IDO connection object.

random

Check command for the built-in random check. This check returns random states and adds the check source to the check output.

For test and demo purposes only. The random check command does not support any vars.

exception

Check command for the built-in exception check. This check throws an exception.

For test and demo purposes only. The exception check command does not support any vars.

Plugin Check Commands

Plugin Check Commands for Monitoring Plugins

The Plugin Check Commands provides example configuration for plugin check commands provided by the Monitoring Plugins project.

By default the Plugin Check Commands are included in the icinga2.conf configuration file:

include <plugins>

The plugin check commands assume that there's a global constant named PluginDir which contains the path of the plugins from the Monitoring Plugins project.

apt

The plugin apt is used to check the aptitude package management system for updates on Debian based systems.

Custom attributes passed as command parameters:

Name	Description
apt_extra_opts	Optional. Read options from an ini file.
apt_upgrade	Optional. [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.
apt_dist_upgrade	Optional. Perform a dist-upgrade instead of normal upgrade. Like with -U OPTS can be provided to override the default options.
apt_include	Optional. Include only packages matching REGEXP. Can be specified multiple times the values will be combined together.
apt_exclude	Optional. Exclude packages matching REGEXP from the list of packages that would otherwise be included. Can be specified multiple times.
apt_critical	Optional. 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.
apt_timeout	Optional. Seconds before plugin times out (default: 10).

breeze

Check command object for the check_breeze plugin.

Custom attributes passed as command parameters:

Name	Description
breeze_hostname	Required. Name or IP address of host to check. Defaults to "`address`" if the host's `address` attribute is set, "`address6`" otherwise.
breeze_community	Optional. SNMPv1 community. Defaults to "public".
breeze_warning	Required. Percentage strength below which a WARNING status will result. Defaults to 50.
breeze_critical	Required. Percentage strength below which a WARNING status will result. Defaults to 20.

by_ssh

Check command object for the check_by_ssh plugin.

Custom attributes passed as command parameters:

Name	Description
by_ssh_address	Optional. The host's address. Defaults to "`address`" if the host's `address` attribute is set, "`address6`" otherwise.
by_ssh_port	Optional. The SSH port. Defaults to 22.
by_ssh_command	Required. The command that should be executed. Can be an array if multiple arguments should be passed to `check_by_ssh`.
by_ssh_arguments	Optional. A dictionary with arguments for the command. This works exactly like the 'arguments' dictionary for ordinary CheckCommands.
by_ssh_logname	Optional. The SSH username.
by_ssh_identity	Optional. The SSH identity.
by_ssh_quiet	Optional. Whether to suppress SSH warnings. Defaults to false.
by_ssh_warn	Optional. The warning threshold.
by_ssh_crit	Optional. The critical threshold.
by_ssh_timeout	Optional. The timeout in seconds.
by_ssh_options	Optional. Call ssh with '-o OPTION' (multiple options may be specified as an array).
by_ssh_ipv4	Optional. Use IPv4 connection. Defaults to false.
by_ssh_ipv6	Optional. Use IPv6 connection. Defaults to false.

clamd

Check command object for the check_clamd plugin.

Custom attributes passed as command parameters:

Name	Description
clamd_address	Required. The host's address or unix socket (must be an absolute path).
clamd_port	Optional. Port number (default: none).
clamd_expect	Optional. String to expect in server response. Multiple strings must be defined as array.
clamd_all	Optional. All expect strings need to occur in server response. Defaults to false.
clamd_escape_send	Optional. Enable usage of \n, \r, \t or \\ in send string.
clamd_send	Optional. String to send to the server.
clamd_escape_quit	Optional. Enable usage of \n, \r, \t or \\ in quit string.
clamd_quit	Optional. String to send server to initiate a clean close of the connection.
clamd_refuse	Optional. Accept TCP refusals with states ok, warn, crit. Defaults to crit.
clamd_mismatch	Optional. Accept expected string mismatches with states ok, warn, crit. Defaults to warn.
clamd_jail	Optional. Hide output from TCP socket.
clamd_maxbytes	Optional. Close connection once more than this number of bytes are received.
clamd_delay	Optional. Seconds to wait between sending string and polling for response.
clamd_certificate	Optional. Minimum number of days a certificate has to be valid. 1st value is number of days for warning, 2nd is critical (if not specified: 0) -- separated by comma.
clamd_ssl	Optional. Use SSL for the connection. Defaults to false.
clamd_wtime	Optional. Response time to result in warning status (seconds).
clamd_ctime	Optional. Response time to result in critical status (seconds).
clamd_timeout	Optional. Seconds before connection times out. Defaults to 10.
clamd_ipv4	Optional. Use IPv4 connection. Defaults to false.
clamd_ipv6	Optional. Use IPv6 connection. Defaults to false.

dhcp

Check command object for the check_dhcp plugin.

Custom attributes passed as command parameters:

Name	Description
dhcp_serverip	Optional. The IP address of the DHCP server which we should get a response from.
dhcp_requestedip	Optional. The IP address which we should be offered by a DHCP server.
dhcp_timeout	Optional. The timeout in seconds.
dhcp_interface	Optional. The interface to use.
dhcp_mac	Optional. The MAC address to use in the DHCP request.
dhcp_unicast	Optional. Whether to use unicast requests. Defaults to false.

dig

Check command object for the check_dig plugin.

Custom attributes passed as command parameters:

Name	Description
dig_server	Optional. The DNS server to query. Defaults to "127.0.0.1".
dig_port	Optional. Port number (default: 53).
dig_lookup	Required. The address that should be looked up.
dig_record_type	Optional. Record type to lookup (default: A).
dig_expected_address	Optional. An address expected to be in the answer section. If not set, uses whatever was in -l.
dig_arguments	Optional. Pass STRING as argument(s) to dig.
dig_retries	Optional. Number of retries passed to dig, timeout is divided by this value (Default: 3).
dig_warning	Optional. Response time to result in warning status (seconds).
dig_critical	Optional. Response time to result in critical status (seconds).
dig_timeout	Optional. Seconds before connection times out (default: 10).
dig_ipv4	Optional. Force dig to only use IPv4 query transport. Defaults to false.
dig_ipv6	Optional. Force dig to only use IPv6 query transport. Defaults to false.

disk

Check command object for the check_disk plugin.

Note

disk_wfree and disk_cfree require the percent sign compared to older versions. If omitted, disk units can be used. This has been changed in 2.3.0.

Custom attributes passed as command parameters:

Name	Description
disk_wfree	Optional. The free space warning threshold. Defaults to "20%". If the percent sign is omitted, units from `disk_units` are used.
disk_cfree	Optional. The free space critical threshold. Defaults to "10%". If the percent sign is omitted, units from `disk_units` are used.
disk_inode_wfree	Optional. The free inode warning threshold.
disk_inode_cfree	Optional. The free inode critical threshold.
disk_partition	Optional. The partition. Deprecated in 2.3.
disk_partition_excluded	Optional. The excluded partition. Deprecated in 2.3.
disk_partitions	Optional. The partition(s). Multiple partitions must be defined as array.
disk_partitions_excluded	Optional. The excluded partition(s). Multiple partitions must be defined as array.
disk_clear	Optional. Clear thresholds.
disk_exact_match	Optional. For paths or partitions specified with -p, only check for exact paths.
disk_errors_only	Optional. Display only devices/mountpoints with errors. May be true or false.
disk_ignore_reserved	Optional. If set, account root-reserved blocks are not accounted for freespace in perfdata.
disk_group	Optional. Group paths. Thresholds apply to (free-)space of all partitions together.
disk_kilobytes	Optional. Same as --units kB. May be true or false.
disk_local	Optional. Only check local filesystems. May be true or false.
disk_stat_remote_fs	Optional. 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). May be true or false.
disk_mountpoint	Optional. Display the mountpoint instead of the partition. May be true or false.
disk_megabytes	Optional. Same as --units MB. May be true or false.
disk_all	Optional. Explicitly select all paths. This is equivalent to -R '.*'. May be true or false.
disk_eregi_path	Optional. Case insensitive regular expression for path/partition. Multiple regular expression strings must be defined as array.
disk_ereg_path	Optional. Regular expression for path or partition. Multiple regular expression strings must be defined as array.
disk_ignore_eregi_path	Optional. Regular expression to ignore selected path/partition (case insensitive). Multiple regular expression strings must be defined as array.
disk_ignore_ereg_path	Optional. Regular expression to ignore selected path or partition. Multiple regular expression strings must be defined as array.
disk_timeout	Optional. Seconds before connection times out (default: 10).
disk_units	Optional. Choose bytes, kB, MB, GB, TB (default: MB).
disk_exclude_type	Optional. Ignore all filesystems of indicated type. Multiple regular expression strings must be defined as array.

disk_smb

Check command object for the check_disk_smb plugin.

Note

disk_smb_wused and disk_smb_cused require the percent sign. If omitted, disk units can be used.

Custom attributes passed as command parameters:

Name	Description
disk_smb_hostname	Required. NetBIOS name of the server.
disk_smb_share	Required. Share name being queried.
disk_smb_workgroup	Optional. Workgroup or Domain used (defaults to 'WORKGROUP' if omitted).
disk_smb_address	Optional. IP address of the host (only necessary if host belongs to another network).
disk_smb_username	Optional. Username for server log-in (defaults to 'guest' if omitted).
disk_smb_password	Optional. Password for server log-in (defaults to an empty password if omitted).
disk_smb_wused	Optional. The used space warning threshold. Defaults to "85%". If the percent sign is omitted, use optional disk units.
disk_smb_cused	Optional. The used space critical threshold. Defaults to "95%". If the percent sign is omitted, use optional disk units.
disk_smb_port	Optional. Connection port, e.g. `139` or `445`. Defaults to `smbclient` default if omitted.

dns

Check command object for the check_dns plugin.

Custom attributes passed as command parameters:

Name	Description
dns_lookup	Optional. The hostname or IP to query the DNS for. Defaults to "`host_name`".
dns_server	Optional. The DNS server to query. Defaults to the server configured in the OS.
dns_expected_answer	Optional. The answer to look for. A hostname must end with a dot. Deprecated in 2.3.
dns_expected_answers	Optional. The answer(s) to look for. A hostname must end with a dot. Multiple answers must be defined as array.
dns_authoritative	Optional. Expect the server to send an authoritative answer.
dns_wtime	Optional. Return warning if elapsed time exceeds value.
dns_ctime	Optional. Return critical if elapsed time exceeds value.
dns_timeout	Optional. Seconds before connection times out. Defaults to 10.

dummy

Check command object for the check_dummy plugin.

Custom attributes passed as command parameters:

Name	Description
dummy_state	Optional. The state. Can be one of 0 (ok), 1 (warning), 2 (critical) and 3 (unknown). Defaults to 0.
dummy_text	Optional. Plugin output. Defaults to "Check was successful.".

file_age

Check command object for the check_file_age plugin.

Custom attributes passed as command parameters:

Name	Description
file_age_file	Required. File to monitor.
file_age_warning_time	Optional. File must be no more than this many seconds old as warning threshold. Defaults to "240s".
file_age_critical_time	Optional. File must be no more than this many seconds old as critical threshold. Defaults to "600s".
file_age_warning_size	Optional. File must be at least this many bytes long as warning threshold. No default given.
file_age_critical_size	Optional. File must be at least this many bytes long as critical threshold. Defaults to "0B".
file_age_ignoremissing	Optional. Return OK if the file does not exist. Defaults to false.

flexlm

Check command object for the check_flexlm plugin. Requires the command lmstat installed.

Custom attributes passed as command parameters:

Name	Description
flexlm_licensefile	Required. Name of license file (usually license.dat).
flexlm_timeout	Optional. Plugin time out in seconds. Defaults to 15.

fping4

Check command object for the check_fping plugin.

Custom attributes passed as command parameters:

Name	Description
fping_address	Optional. The host's IPv4 address. Defaults to "`address`".
fping_wrta	Optional. The RTA warning threshold in milliseconds. Defaults to 100.
fping_wpl	Optional. The packet loss warning threshold in %. Defaults to 5.
fping_crta	Optional. The RTA critical threshold in milliseconds. Defaults to 200.
fping_cpl	Optional. The packet loss critical threshold in %. Defaults to 15.
fping_number	Optional. The number of packets to send. Defaults to 5.
fping_interval	Optional. The interval between packets in milli-seconds. Defaults to 500.
fping_bytes	Optional. The size of ICMP packet.
fping_target_timeout	Optional. The target timeout in milli-seconds.
fping_source_ip	Optional. The name or ip address of the source ip.
fping_source_interface	Optional. The source interface name.

fping6

Check command object for the check_fping plugin.

Custom attributes passed as command parameters:

Name	Description
fping_address	Optional. The host's IPv6 address. Defaults to "`address6`".
fping_wrta	Optional. The RTA warning threshold in milliseconds. Defaults to 100.
fping_wpl	Optional. The packet loss warning threshold in %. Defaults to 5.
fping_crta	Optional. The RTA critical threshold in milliseconds. Defaults to 200.
fping_cpl	Optional. The packet loss critical threshold in %. Defaults to 15.
fping_number	Optional. The number of packets to send. Defaults to 5.
fping_interval	Optional. The interval between packets in milli-seconds. Defaults to 500.
fping_bytes	Optional. The size of ICMP packet.
fping_target_timeout	Optional. The target timeout in milli-seconds.
fping_source_ip	Optional. The name or ip address of the source ip.
fping_source_interface	Optional. The source interface name.

ftp

Check command object for the check_ftp plugin.

Custom attributes passed as command parameters:

Name	Description
ftp_address	Optional. The host's address. Defaults to "`address`" if the host's `address` attribute is set, "`address6`" otherwise.
ftp_port	Optional. The FTP port number.
ftp_expect	Optional. String to expect in server response. Multiple strings must be defined as array.
ftp_all	Optional. All expect strings need to occur in server response. Defaults to false.
ftp_escape_send	Optional. Enable usage of \n, \r, \t or \\ in send string.
ftp_send	Optional. String to send to the server.
ftp_escape_quit	Optional. Enable usage of \n, \r, \t or \\ in quit string.
ftp_quit	Optional. String to send server to initiate a clean close of the connection.
ftp_refuse	Optional. Accept TCP refusals with states ok, warn, crit. Defaults to crit.
ftp_mismatch	Optional. Accept expected string mismatches with states ok, warn, crit. Defaults to warn.
ftp_jail	Optional. Hide output from TCP socket.
ftp_maxbytes	Optional. Close connection once more than this number of bytes are received.
ftp_delay	Optional. Seconds to wait between sending string and polling for response.
ftp_certificate	Optional. Minimum number of days a certificate has to be valid. 1st value is number of days for warning, 2nd is critical (if not specified: 0) -- separated by comma.
ftp_ssl	Optional. Use SSL for the connection. Defaults to false.
ftp_wtime	Optional. Response time to result in warning status (seconds).
ftp_ctime	Optional. Response time to result in critical status (seconds).
ftp_timeout	Optional. Seconds before connection times out. Defaults to 10.
ftp_ipv4	Optional. Use IPv4 connection. Defaults to false.
ftp_ipv6	Optional. Use IPv6 connection. Defaults to false.

game

Check command object for the check_game plugin. Requires the command qstat (if installed from packages typically named quakestat) which also allows to provide some default configuration.

Custom attributes passed as command parameters:

Name	Description
game_game	Required. Name of the game.
game_ipaddress	Required. Ipaddress of the game server to query.
game_timeout	Optional. Seconds before connection times out. Defaults to 10.
game_port	Optional. Port to connect to.
game_gamefield	Optional. Field number in raw qstat output that contains game name.
game_mapfield	Optional. Field number in raw qstat output that contains map name.
game_pingfield	Optional. Field number in raw qstat output that contains ping time.
game_gametime	Optional. Field number in raw qstat output that contains game time.
game_hostname	Optional. Name of the host running the game.

hostalive

Check command object for the check_ping plugin with host check default values. This variant uses the host's address attribute if available and falls back to using the address6 attribute if the address attribute is not set.

Custom attributes passed as command parameters:

Name	Description
ping_address	Optional. The host's address. Defaults to "`address`" if the host's `address` attribute is set, "`address6`" otherwise.
ping_wrta	Optional. The RTA warning threshold in milliseconds. Defaults to 3000.
ping_wpl	Optional. The packet loss warning threshold in %. Defaults to 80.
ping_crta	Optional. The RTA critical threshold in milliseconds. Defaults to 5000.
ping_cpl	Optional. The packet loss critical threshold in %. Defaults to 100.
ping_packets	Optional. The number of packets to send. Defaults to 5.
ping_timeout	Optional. The plugin timeout in seconds. Defaults to 0 (no timeout).

hostalive4

Check command object for the check_ping plugin with host check default values. This variant uses the host's address attribute.

Custom attributes passed as command parameters:

Name	Description
ping_address	Optional. The host's IPv4 address. Defaults to "`address`".
ping_wrta	Optional. The RTA warning threshold in milliseconds. Defaults to 3000.
ping_wpl	Optional. The packet loss warning threshold in %. Defaults to 80.
ping_crta	Optional. The RTA critical threshold in milliseconds. Defaults to 5000.
ping_cpl	Optional. The packet loss critical threshold in %. Defaults to 100.
ping_packets	Optional. The number of packets to send. Defaults to 5.
ping_timeout	Optional. The plugin timeout in seconds. Defaults to 0 (no timeout).

hostalive6

Check command object for the check_ping plugin with host check default values. This variant uses the host's address6 attribute.

Custom attributes passed as command parameters:

Name	Description
ping_address	Optional. The host's IPv6 address. Defaults to "`address6`".
ping_wrta	Optional. The RTA warning threshold in milliseconds. Defaults to 3000.
ping_wpl	Optional. The packet loss warning threshold in %. Defaults to 80.
ping_crta	Optional. The RTA critical threshold in milliseconds. Defaults to 5000.
ping_cpl	Optional. The packet loss critical threshold in %. Defaults to 100.
ping_packets	Optional. The number of packets to send. Defaults to 5.
ping_timeout	Optional. The plugin timeout in seconds. Defaults to 0 (no timeout).

hpjd

Check command object for the check_hpjd plugin.

Custom attributes passed as command parameters:

Name	Description
hpjd_address	Optional. The host's address. Defaults to "`address`" if the host's `address` attribute is set, "`address6`" otherwise.
hpjd_port	Optional. The host's SNMP port. Defaults to 161.
hpjd_community	Optional. The SNMP community. Defaults to "public".

http

Check command object for the check_http plugin.

Custom attributes passed as command parameters:

Name	Description
http_address	Optional. The host's address. Defaults to "`address`" if the host's `address` attribute is set, "`address6`" otherwise.
http_vhost	Optional. The virtual host that should be sent in the "Host" header.
http_uri	Optional. The request URI for GET or POST. Defaults to `/`.
http_port	Optional. The TCP port. Defaults to 80 when not using SSL, 443 otherwise.
http_ssl	Optional. Whether to use SSL. Defaults to false.
http_ssl_force_tlsv1	Optional. Whether to force TLSv1.
http_ssl_force_tlsv1_1	Optional. Whether to force TLSv1.1.
http_ssl_force_tlsv1_2	Optional. Whether to force TLSv1.2.
http_ssl_force_sslv2	Optional. Whether to force SSLv2.
http_ssl_force_sslv3	Optional. Whether to force SSLv3.
http_ssl_force_tlsv1_or_higher	Optional. Whether to force TLSv1 or higher.
http_ssl_force_tlsv1_1_or_higher	Optional. Whether to force TLSv1.1 or higher.
http_ssl_force_tlsv1_2_or_higher	Optional. Whether to force TLSv1.2 or higher.
http_ssl_force_sslv2_or_higher	Optional. Whether to force SSLv2 or higher.
http_ssl_force_sslv3_or_higher	Optional. Whether to force SSLv3 or higher.
http_sni	Optional. Whether to use SNI. Defaults to false.
http_auth_pair	Optional. Add 'username:password' authorization pair.
http_proxy_auth_pair	Optional. Add 'username:password' authorization pair for proxy.
http_ignore_body	Optional. Don't download the body, just the headers.
http_linespan	Optional. Allow regex to span newline.
http_expect_body_regex	Optional. A regular expression which the body must match against. Incompatible with http_ignore_body.
http_expect_body_eregi	Optional. A case-insensitive expression which the body must match against. Incompatible with http_ignore_body.
http_invertregex	Optional. Changes behaviour of http_expect_body_regex and http_expect_body_eregi to return CRITICAL if found, OK if not.
http_warn_time	Optional. The warning threshold.
http_critical_time	Optional. The critical threshold.
http_expect	Optional. Comma-delimited list of strings, at least one of them is expected in the first (status) line of the server response. Default: HTTP/1.
http_certificate	Optional. Minimum number of days a certificate has to be valid. Port defaults to 443.
http_clientcert	Optional. Name of file contains the client certificate (PEM format).
http_privatekey	Optional. Name of file contains the private key (PEM format).
http_headerstring	Optional. String to expect in the response headers.
http_string	Optional. String to expect in the content.
http_post	Optional. URL encoded http POST data.
http_method	Optional. Set http method (for example: HEAD, OPTIONS, TRACE, PUT, DELETE).
http_maxage	Optional. Warn if document is more than seconds old.
http_contenttype	Optional. Specify Content-Type header when POSTing.
http_useragent	Optional. String to be sent in http header as User Agent.
http_header	Optional. Any other tags to be sent in http header.
http_extendedperfdata	Optional. Print additional perfdata. Defaults to false.
http_onredirect	Optional. How to handle redirect pages. Possible values: "ok" (default), "warning", "critical", "follow", "sticky" (like follow but stick to address), "stickyport" (like sticky but also to port)
http_pagesize	Optional. Minimum page size required:Maximum page size required.
http_timeout	Optional. Seconds before connection times out.
http_ipv4	Optional. Use IPv4 connection. Defaults to false.
http_ipv6	Optional. Use IPv6 connection. Defaults to false.

icmp

Check command object for the check_icmp plugin.

Custom attributes passed as command parameters:

Name	Description
icmp_address	Optional. The host's address. This can either be a single address or an array of addresses. Defaults to "`address`".
icmp_wrta	Optional. The RTA warning threshold in milliseconds. Defaults to 100.
icmp_wpl	Optional. The packet loss warning threshold in %. Defaults to 5.
icmp_crta	Optional. The RTA critical threshold in milliseconds. Defaults to 200.
icmp_cpl	Optional. The packet loss critical threshold in %. Defaults to 15.
icmp_source	Optional. The source IP address to send packets from.
icmp_packets	Optional. The number of packets to send. Defaults to 5.
icmp_packet_interval	Optional The maximum packet interval. Defaults to 80 (milliseconds).
icmp_target_interval	Optional. The maximum target interval.
icmp_hosts_alive	Optional. The number of hosts which have to be alive for the check to succeed.
icmp_data_bytes	Optional. Payload size for each ICMP request. Defaults to 8.
icmp_timeout	Optional. The plugin timeout in seconds. Defaults to 10 (seconds).

imap

Check command object for the check_imap plugin.

Custom attributes passed as command parameters:

Name	Description
imap_address	Optional. The host's address. Defaults to "`address`" if the host's `address` attribute is set, "`address6`" otherwise.
imap_port	Optional. The port that should be checked. Defaults to 143.
imap_escape	Optional. 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.
imap_send	Optional. String to send to the server.
imap_expect	Optional. String to expect in server response. Multiple strings must be defined as array.
imap_all	Optional. All expect strings need to occur in server response. Default is any.
imap_quit	Optional. String to send server to initiate a clean close of the connection.
imap_refuse	Optional. Accept TCP refusals with states ok, warn, crit (default: crit).
imap_mismatch	Optional. Accept expected string mismatches with states ok, warn, crit (default: warn).
imap_jail	Optional. Hide output from TCP socket.
imap_maxbytes	Optional. Close connection once more than this number of bytes are received.
imap_delay	Optional. Seconds to wait between sending string and polling for response.
imap_certificate_age	Optional. Minimum number of days a certificate has to be valid.
imap_ssl	Optional. Use SSL for the connection.
imap_warning	Optional. Response time to result in warning status (seconds).
imap_critical	Optional. Response time to result in critical status (seconds).
imap_timeout	Optional. Seconds before connection times out (default: 10).
imap_ipv4	Optional. Use IPv4 connection. Defaults to false.
imap_ipv6	Optional. Use IPv6 connection. Defaults to false.

ldap

Check command object for the check_ldap plugin. Use the plugin also for monitoring ldaps connections instead of the deprecated check_ldaps.

Custom attributes passed as command parameters:

Name	Description
ldap_address	Optional. Host name, IP Address, or unix socket (must be an absolute path). Defaults to "`address`" if the host's `address` attribute is set, "`address6`" otherwise.
ldap_port	Optional. Port number. Defaults to 389.
ldap_attr	Optional. LDAP attribute to search for (default: "(objectclass=*)"
ldap_base	Required. LDAP base (eg. ou=myunit,o=myorg,c=at).
ldap_bind	Optional. LDAP bind DN (if required).
ldap_pass	Optional. LDAP password (if required).
ldap_starttls	Optional. Use STARTSSL mechanism introduced in protocol version 3.
ldap_ssl	Optional. Use LDAPS (LDAP v2 SSL method). This also sets the default port to 636.
ldap_v2	Optional. Use LDAP protocol version 2 (enabled by default).
ldap_v3	Optional. Use LDAP protocol version 3 (disabled by default)
ldap_warning	Optional. Response time to result in warning status (seconds).
ldap_critical	Optional. Response time to result in critical status (seconds).
ldap_timeout	Optional. Seconds before connection times out (default: 10).
ldap_verbose	Optional. Show details for command-line debugging (disabled by default)

load

Check command object for the check_load plugin.

Custom attributes passed as command parameters:

Name	Description
load_wload1	Optional. The 1-minute warning threshold. Defaults to 5.
load_wload5	Optional. The 5-minute warning threshold. Defaults to 4.
load_wload15	Optional. The 15-minute warning threshold. Defaults to 3.
load_cload1	Optional. The 1-minute critical threshold. Defaults to 10.
load_cload5	Optional. The 5-minute critical threshold. Defaults to 6.
load_cload15	Optional. The 15-minute critical threshold. Defaults to 4.
load_percpu	Optional. Divide the load averages by the number of CPUs (when possible). Defaults to false.

mailq

Check command object for the check_mailq plugin.

Custom attributes passed as command parameters:

Name	Description
mailq_warning	Required. Min. number of messages in queue to generate warning.
mailq_critical	Required. Min. number of messages in queue to generate critical alert ( w < c ).
mailq_domain_warning	Optional. Min. number of messages for same domain in queue to generate warning
mailq_domain_critical	Optional. Min. number of messages for same domain in queue to generate critical alert ( W < C ).
mailq_timeout	Optional. Plugin timeout in seconds (default = 15).
mailq_servertype	Optional. [ sendmail \| qmail \| postfix \| exim \| nullmailer ] (default = autodetect).

mysql

Check command object for the check_mysql plugin.

Custom attributes passed as command parameters:

Name	Description
mysql_hostname	Optional. Host name, IP Address, or unix socket (must be an absolute path).
mysql_port	Optional. Port number (default: 3306).
mysql_ignore_auth	Optional. Ignore authentication failure and check for mysql connectivity only.
mysql_database	Optional. Check database with indicated name.
mysql_file	Optional. Read from the specified client options file.
mysql_group	Optional. Use a client options group.
mysql_username	Optional. Connect using the indicated username.
mysql_password	Optional. Use the indicated password to authenticate the connection.
mysql_check_slave	Optional. Check if the slave thread is running properly.
mysql_warning	Optional. Exit with WARNING status if slave server is more than INTEGER seconds behind master.
mysql_critical	Optional. Exit with CRITICAL status if slave server is more then INTEGER seconds behind master.
mysql_ssl	Optional. Use ssl encryptation.
mysql_cacert	Optional. Path to CA signing the cert.
mysql_cert	Optional. Path to SSL certificate.
mysql_key	Optional. Path to private SSL key.
mysql_cadir	Optional. Path to CA directory.
mysql_ciphers	Optional. List of valid SSL ciphers.

mysql_query

Check command object for the check_mysql_query plugin.

Custom attributes passed as command parameters:

Name	Description
mysql_query_hostname	Optional. Host name, IP Address, or unix socket (must be an absolute path).
mysql_query_port	Optional. Port number (default: 3306).
mysql_query_database	Optional. Check database with indicated name.
mysql_query_file	Optional. Read from the specified client options file.
mysql_query_group	Optional. Use a client options group.
mysql_query_username	Optional. Connect using the indicated username.
mysql_query_password	Optional. Use the indicated password to authenticate the connection.
mysql_query_execute	Required. SQL Query to run on the MySQL Server.
mysql_query_warning	Optional. Exit with WARNING status if query is outside of the range (format: start:end).
mysql_query_critical	Optional. Exit with CRITICAL status if query is outside of the range.

negate

Check command object for the negate plugin.

Custom attributes passed as command parameters:

Name	Description
negate_timeout	Optional. Seconds before plugin times out (default: 11).
negate_timeout_result	Optional. Custom result on Negate timeouts, default to UNKNOWN.
negate_ok	Optional. OK, WARNING, CRITICAL or UNKNOWN.
negate_warning	Numeric values are accepted.
negate_critical	If nothing is specified, permutes OK and CRITICAL.
negate_substitute	Optional. Substitute output text as well. Will only substitute text in CAPITALS.
negate_command	Required. Command to be negated.
negate_arguments	Optional. Arguments for the negated command.

nrpe

Check command object for the check_nrpe plugin.

Custom attributes passed as command parameters:

Name	Description
nrpe_address	Optional. The host's address. Defaults to "`address`" if the host's `address` attribute is set, "`address6`" otherwise.
nrpe_port	Optional. The NRPE port. Defaults to 5666.
nrpe_command	Optional. The command that should be executed.
nrpe_no_ssl	Optional. Whether to disable SSL or not. Defaults to `false`.
nrpe_timeout_unknown	Optional. Whether to set timeouts to unknown instead of critical state. Defaults to `false`.
nrpe_timeout	Optional. The timeout in seconds.
nrpe_arguments	Optional. Arguments that should be passed to the command. Multiple arguments must be defined as array.
nrpe_ipv4	Optional. Use IPv4 connection. Defaults to false.
nrpe_ipv6	Optional. Use IPv6 connection. Defaults to false.

nscp

Check command object for the check_nt plugin.

Custom attributes passed as command parameters:

Name	Description
nscp_address	Optional. The host's address. Defaults to "`address`" if the host's `address` attribute is set, "`address6`" otherwise.
nscp_port	Optional. The NSClient++ port. Defaults to 12489.
nscp_password	Optional. The NSClient++ password.
nscp_variable	Required. The variable that should be checked.
nscp_params	Optional. Parameters for the query. Multiple parameters must be defined as array.
nscp_warn	Optional. The warning threshold.
nscp_crit	Optional. The critical threshold.
nscp_timeout	Optional. The query timeout in seconds.
nscp_showall	Optional. Use with SERVICESTATE to see working services or PROCSTATE for running processes. Defaults to false.

ntp_time

Check command object for the check_ntp_time plugin.

Custom attributes passed as command parameters:

Name	Description
ntp_address	Optional. The host's address. Defaults to "`address`" if the host's `address` attribute is set, "`address6`" otherwise.
ntp_port	Optional. Port number (default: 123).
ntp_quit	Optional. Returns UNKNOWN instead of CRITICAL if offset cannot be found.
ntp_warning	Optional. Offset to result in warning status (seconds).
ntp_critical	Optional. Offset to result in critical status (seconds).
ntp_timeoffset	Optional. Expected offset of the ntp server relative to local server (seconds).
ntp_timeout	Optional. Seconds before connection times out (default: 10).
ntp_ipv4	Optional. Use IPv4 connection. Defaults to false.
ntp_ipv6	Optional. Use IPv6 connection. Defaults to false.

ntp_peer

Check command object for the check_ntp_peer plugin.

Custom attributes passed as command parameters:

Name	Description
ntp_address	Optional. The host's address. Defaults to "`address`" if the host's `address` attribute is set, "`address6`" otherwise.
ntp_port	Optional. The port to use. Default to 123.
ntp_warning	Optional. Offset to result in warning status (seconds).
ntp_critical	Optional. Offset to result in critical status (seconds).
ntp_wstratum	Optional. Warning threshold for stratum of server's synchronization peer.
ntp_cstratum	Optional. Critical threshold for stratum of server's synchronization peer.
ntp_wjitter	Optional. Warning threshold for jitter.
ntp_cjitter	Optional. Critical threshold for jitter.
ntp_wsource	Optional. Warning threshold for number of usable time sources.
ntp_csource	Optional. Critical threshold for number of usable time sources.
ntp_timeout	Optional. Seconds before connection times out (default: 10).
ntp_ipv4	Optional. Use IPv4 connection. Defaults to false.
ntp_ipv6	Optional. Use IPv6 connection. Defaults to false.

passive

Specialised check command object for passive checks executing the check_dummy plugin with appropriate default values.

Custom attributes passed as command parameters:

Name	Description
dummy_state	Optional. The state. Can be one of 0 (ok), 1 (warning), 2 (critical) and 3 (unknown). Defaults to 3.
dummy_text	Optional. Plugin output. Defaults to "No Passive Check Result Received.".

pgsql

Check command object for the check_pgsql plugin.

Custom attributes passed as command parameters:

Name	Description
pgsql_hostname	Optional. Host name, IP Address, or unix socket (must be an absolute path).
pgsql_port	Optional. Port number (default: 5432).
pgsql_database	Optional. Database to check (default: template1).
pgsql_username	Optional. Login name of user.
pgsql_password	Optional. Password (BIG SECURITY ISSUE).
pgsql_options	Optional. Connection parameters (keyword = value), see below.
pgsql_warning	Optional. Response time to result in warning status (seconds).
pgsql_critical	Optional. Response time to result in critical status (seconds).
pgsql_timeout	Optional. Seconds before connection times out (default: 10).
pgsql_query	Optional. SQL query to run. Only first column in first row will be read.
pgsql_query_warning	Optional. SQL query value to result in warning status (double).
pgsql_query_critical	Optional. SQL query value to result in critical status (double).

ping

Check command object for the check_ping plugin. This command uses the host's address attribute if available and falls back to using the address6 attribute if the address attribute is not set.

Custom attributes passed as command parameters:

Name	Description
ping_address	Optional. The host's address. Defaults to "`address`" if the host's `address` attribute is set, "`address6`" otherwise.
ping_wrta	Optional. The RTA warning threshold in milliseconds. Defaults to 100.
ping_wpl	Optional. The packet loss warning threshold in %. Defaults to 5.
ping_crta	Optional. The RTA critical threshold in milliseconds. Defaults to 200.
ping_cpl	Optional. The packet loss critical threshold in %. Defaults to 15.
ping_packets	Optional. The number of packets to send. Defaults to 5.
ping_timeout	Optional. The plugin timeout in seconds. Defaults to 0 (no timeout).

ping4

Check command object for the check_ping plugin.

Custom attributes passed as command parameters:

Name	Description
ping_address	Optional. The host's IPv4 address. Defaults to "`address`".
ping_wrta	Optional. The RTA warning threshold in milliseconds. Defaults to 100.
ping_wpl	Optional. The packet loss warning threshold in %. Defaults to 5.
ping_crta	Optional. The RTA critical threshold in milliseconds. Defaults to 200.
ping_cpl	Optional. The packet loss critical threshold in %. Defaults to 15.
ping_packets	Optional. The number of packets to send. Defaults to 5.
ping_timeout	Optional. The plugin timeout in seconds. Defaults to 0 (no timeout).

ping6

Check command object for the check_ping plugin.

Custom attributes passed as command parameters:

Name	Description
ping_address	Optional. The host's IPv6 address. Defaults to "`address6`".
ping_wrta	Optional. The RTA warning threshold in milliseconds. Defaults to 100.
ping_wpl	Optional. The packet loss warning threshold in %. Defaults to 5.
ping_crta	Optional. The RTA critical threshold in milliseconds. Defaults to 200.
ping_cpl	Optional. The packet loss critical threshold in %. Defaults to 15.
ping_packets	Optional. The number of packets to send. Defaults to 5.
ping_timeout	Optional. The plugin timeout in seconds. Defaults to 0 (no timeout).

pop

Check command object for the check_pop plugin.

Custom attributes passed as command parameters:

Name	Description
pop_address	Optional. The host's address. Defaults to "`address`" if the host's `address` attribute is set, "`address6`" otherwise.
pop_port	Optional. The port that should be checked. Defaults to 110.
pop_escape	Optional. 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.
pop_send	Optional. String to send to the server.
pop_expect	Optional. String to expect in server response. Multiple strings must be defined as array.
pop_all	Optional. All expect strings need to occur in server response. Default is any.
pop_quit	Optional. String to send server to initiate a clean close of the connection.
pop_refuse	Optional. Accept TCP refusals with states ok, warn, crit (default: crit).
pop_mismatch	Optional. Accept expected string mismatches with states ok, warn, crit (default: warn).
pop_jail	Optional. Hide output from TCP socket.
pop_maxbytes	Optional. Close connection once more than this number of bytes are received.
pop_delay	Optional. Seconds to wait between sending string and polling for response.
pop_certificate_age	Optional. Minimum number of days a certificate has to be valid.
pop_ssl	Optional. Use SSL for the connection.
pop_warning	Optional. Response time to result in warning status (seconds).
pop_critical	Optional. Response time to result in critical status (seconds).
pop_timeout	Optional. Seconds before connection times out (default: 10).
pop_ipv4	Optional. Use IPv4 connection. Defaults to false.
pop_ipv6	Optional. Use IPv6 connection. Defaults to false.

procs

Check command object for the check_procs plugin.

Custom attributes passed as command parameters:

Name	Description
procs_warning	Optional. The process count warning threshold. Defaults to 250.
procs_critical	Optional. The process count critical threshold. Defaults to 400.
procs_metric	Optional. Check thresholds against metric.
procs_timeout	Optional. Seconds before plugin times out.
procs_traditional	Optional. Filter own process the traditional way by PID instead of /proc/pid/exe. Defaults to false.
procs_state	Optional. Only scan for processes that have one or more of the status flags you specify.
procs_ppid	Optional. Only scan for children of the parent process ID indicated.
procs_vsz	Optional. Only scan for processes with VSZ higher than indicated.
procs_rss	Optional. Only scan for processes with RSS higher than indicated.
procs_pcpu	Optional. Only scan for processes with PCPU higher than indicated.
procs_user	Optional. Only scan for processes with user name or ID indicated.
procs_argument	Optional. Only scan for processes with args that contain STRING.
procs_argument_regex	Optional. Only scan for processes with args that contain the regex STRING.
procs_command	Optional. Only scan for exact matches of COMMAND (without path).
procs_nokthreads	Optional. Only scan for non kernel threads. Defaults to false.

simap

Check command object for the check_simap plugin.

Custom attributes passed as command parameters:

Name	Description
simap_address	Optional. The host's address. Defaults to "`address`" if the host's `address` attribute is set, "`address6`" otherwise.
simap_port	Optional. The port that should be checked. Defaults to 993.
simap_escape	Optional. 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.
simap_send	Optional. String to send to the server.
simap_expect	Optional. String to expect in server response. Multiple strings must be defined as array.
simap_all	Optional. All expect strings need to occur in server response. Default is any.
simap_quit	Optional. String to send server to initiate a clean close of the connection.
simap_refuse	Optional. Accept TCP refusals with states ok, warn, crit (default: crit).
simap_mismatch	Optional. Accept expected string mismatches with states ok, warn, crit (default: warn).
simap_jail	Optional. Hide output from TCP socket.
simap_maxbytes	Optional. Close connection once more than this number of bytes are received.
simap_delay	Optional. Seconds to wait between sending string and polling for response.
simap_certificate_age	Optional. Minimum number of days a certificate has to be valid.
simap_ssl	Optional. Use SSL for the connection.
simap_warning	Optional. Response time to result in warning status (seconds).
simap_critical	Optional. Response time to result in critical status (seconds).
simap_timeout	Optional. Seconds before connection times out (default: 10).
simap_ipv4	Optional. Use IPv4 connection. Defaults to false.
simap_ipv6	Optional. Use IPv6 connection. Defaults to false.

smart

Check command object for the check_ide_smart plugin. Requires installation of smartctl.

Custom attributes passed as command parameters:

Name	Description
smart_device	Required. The name of a local hard drive to monitor.

smtp

Check command object for the check_smtp plugin.

Custom attributes passed as command parameters:

Name	Description
smtp_address	Optional. The host's address. Defaults to "`address`" if the host's `address` attribute is set, "`address6`" otherwise.
smtp_port	Optional. The port that should be checked. Defaults to 25.
smtp_mail_from	Optional. Test a MAIL FROM command with the given email address.
smtp_expect	Optional. String to expect in first line of server response (default: '220').
smtp_command	Optional. SMTP command (may be used repeatedly).
smtp_response	Optional. Expected response to command (may be used repeatedly).
smtp_helo_fqdn	Optional. FQDN used for HELO
smtp_certificate_age	Optional. Minimum number of days a certificate has to be valid.
smtp_starttls	Optional. Use STARTTLS for the connection.
smtp_authtype	Optional. SMTP AUTH type to check (default none, only LOGIN supported).
smtp_authuser	Optional. SMTP AUTH username.
smtp_authpass	Optional. SMTP AUTH password.
smtp_ignore_quit	Optional. Ignore failure when sending QUIT command to server.
smtp_warning	Optional. Response time to result in warning status (seconds).
smtp_critical	Optional. Response time to result in critical status (seconds).
smtp_timeout	Optional. Seconds before connection times out (default: 10).
smtp_ipv4	Optional. Use IPv4 connection. Defaults to false.
smtp_ipv6	Optional. Use IPv6 connection. Defaults to false.

snmp

Check command object for the check_snmp plugin.

Custom attributes passed as command parameters:

Name	Description
snmp_address	Optional. The host's address. Defaults to "`address`" if the host's `address` attribute is set, "`address6`" otherwise.
snmp_oid	Required. The SNMP OID.
snmp_community	Optional. The SNMP community. Defaults to "public".
snmp_port	Optional. The SNMP port. Defaults to "161".
snmp_retries	Optional. Number of retries to be used in the SNMP requests.
snmp_warn	Optional. The warning threshold.
snmp_crit	Optional. The critical threshold.
snmp_string	Optional. Return OK state if the string matches exactly with the output value
snmp_ereg	Optional. Return OK state if extended regular expression REGEX matches with the output value
snmp_eregi	Optional. Return OK state if case-insensitive extended REGEX matches with the output value
snmp_label	Optional. Prefix label for output value
snmp_invert_search	Optional. Invert search result and return CRITICAL state if found
snmp_units	Optional. Units label(s) for output value (e.g., 'sec.').
snmp_version	Optional. Version to use. E.g. 1, 2, 2c or 3.
snmp_miblist	Optional. MIB's to use, comma separated. Defaults to "ALL".
snmp_rate_multiplier	Optional. Converts rate per second. For example, set to 60 to convert to per minute.
snmp_rate	Optional. Boolean. Enable rate calculation.
snmp_getnext	Optional. Boolean. Use SNMP GETNEXT. Defaults to false.
snmp_timeout	Optional. The command timeout in seconds. Defaults to 10 seconds.

snmpv3

Check command object for the check_snmp plugin, using SNMPv3 authentication and encryption options.

Custom attributes passed as command parameters:

Name	Description
snmpv3_address	Optional. The host's address. Defaults to "`address`" if the host's `address` attribute is set, "`address6`" otherwise.
snmpv3_getnext	Optional. Use SNMP GETNEXT instead of SNMP GET.
snmpv3_seclevel	Optional. The security level. Defaults to authPriv.
snmpv3_auth_alg	Optional. The authentication algorithm. Defaults to SHA.
snmpv3_user	Required. The username to log in with.
snmpv3_auth_key	Required, The authentication key. Required if `snmpv3_seclevel` is set to `authPriv` otherwise optional.
snmpv3_priv_key	Required. The encryption key.
snmpv3_oid	Required. The SNMP OID.
snmpv3_priv_alg	Optional. The encryption algorithm. Defaults to AES.
snmpv3_warn	Optional. The warning threshold.
snmpv3_crit	Optional. The critical threshold.
snmpv3_string	Optional. Return OK state (for that OID) if STRING is an exact match.
snmpv3_ereg	Optional. Return OK state (for that OID) if extended regular expression REGEX matches.
snmpv3_eregi	Optional. Return OK state (for that OID) if case-insensitive extended REGEX matches.
snmpv3_invert_search	Optional. Invert search result and return CRITICAL if found
snmpv3_label	Optional. Prefix label for output value.
snmpv3_units	Optional. Units label(s) for output value (e.g., 'sec.').
snmpv3_rate_multiplier	Optional. Converts rate per second. For example, set to 60 to convert to per minute.
snmpv3_rate	Optional. Boolean. Enable rate calculation.
snmpv3_timeout	Optional. The command timeout in seconds. Defaults to 10 seconds.

snmp-uptime

Check command object for the check_snmp plugin.

Custom attributes passed as command parameters:

Name	Description
snmp_address	Optional. The host's address. Defaults to "`address`" if the host's `address` attribute is set, "`address6`" otherwise.
snmp_oid	Optional. The SNMP OID. Defaults to "1.3.6.1.2.1.1.3.0".
snmp_community	Optional. The SNMP community. Defaults to "public".

spop

Check command object for the check_spop plugin.

Custom attributes passed as command parameters:

Name	Description
spop_address	Optional. The host's address. Defaults to "`address`" if the host's `address` attribute is set, "`address6`" otherwise.
spop_port	Optional. The port that should be checked. Defaults to 995.
spop_escape	Optional. 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.
spop_send	Optional. String to send to the server.
spop_expect	Optional. String to expect in server response. Multiple strings must be defined as array.
spop_all	Optional. All expect strings need to occur in server response. Default is any.
spop_quit	Optional. String to send server to initiate a clean close of the connection.
spop_refuse	Optional. Accept TCP refusals with states ok, warn, crit (default: crit).
spop_mismatch	Optional. Accept expected string mismatches with states ok, warn, crit (default: warn).
spop_jail	Optional. Hide output from TCP socket.
spop_maxbytes	Optional. Close connection once more than this number of bytes are received.
spop_delay	Optional. Seconds to wait between sending string and polling for response.
spop_certificate_age	Optional. Minimum number of days a certificate has to be valid.
spop_ssl	Optional. Use SSL for the connection.
spop_warning	Optional. Response time to result in warning status (seconds).
spop_critical	Optional. Response time to result in critical status (seconds).
spop_timeout	Optional. Seconds before connection times out (default: 10).
spop_ipv4	Optional. Use IPv4 connection. Defaults to false.
spop_ipv6	Optional. Use IPv6 connection. Defaults to false.

ssh

Check command object for the check_ssh plugin.

Custom attributes passed as command parameters:

Name	Description
ssh_address	Optional. The host's address. Defaults to "`address`" if the host's `address` attribute is set, "`address6`" otherwise.
ssh_port	Optional. The port that should be checked. Defaults to 22.
ssh_timeout	Optional. Seconds before connection times out. Defaults to 10.
ssh_ipv4	Optional. Use IPv4 connection. Defaults to false.
ssh_ipv6	Optional. Use IPv6 connection. Defaults to false.

ssl

Check command object for the check_tcp plugin, using ssl-related options.

Custom attributes passed as command parameters:

Name	Description
ssl_address	Optional. The host's address. Defaults to "`address`" if the host's `address` attribute is set, "`address6`" otherwise.
ssl_port	Required. The port that should be checked.
ssl_timeout	Optional. Timeout in seconds for the connect and handshake. The plugin default is 10 seconds.
ssl_cert_valid_days_warn	Optional. Warning threshold for days before the certificate will expire. When used, ssl_cert_valid_days_critical must also be set.
ssl_cert_valid_days_critical	Optional. Critical threshold for days before the certificate will expire. When used, ssl_cert_valid_days_warn must also be set.

ssmtp

Check command object for the check_ssmtp plugin.

Custom attributes passed as command parameters:

Name	Description
ssmtp_address	Optional. The host's address. Defaults to "`address`" if the host's `address` attribute is set, "`address6`" otherwise.
ssmtp_port	Optional. The port that should be checked. Defaults to 465.
ssmtp_escape	Optional. 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.
ssmtp_send	Optional. String to send to the server.
ssmtp_expect	Optional. String to expect in server response. Multiple strings must be defined as array.
ssmtp_all	Optional. All expect strings need to occur in server response. Default is any.
ssmtp_quit	Optional. String to send server to initiate a clean close of the connection.
ssmtp_refuse	Optional. Accept TCP refusals with states ok, warn, crit (default: crit).
ssmtp_mismatch	Optional. Accept expected string mismatches with states ok, warn, crit (default: warn).
ssmtp_jail	Optional. Hide output from TCP socket.
ssmtp_maxbytes	Optional. Close connection once more than this number of bytes are received.
ssmtp_delay	Optional. Seconds to wait between sending string and polling for response.
ssmtp_certificate_age	Optional. Minimum number of days a certificate has to be valid.
ssmtp_ssl	Optional. Use SSL for the connection.
ssmtp_warning	Optional. Response time to result in warning status (seconds).
ssmtp_critical	Optional. Response time to result in critical status (seconds).
ssmtp_timeout	Optional. Seconds before connection times out (default: 10).
ssmtp_ipv4	Optional. Use IPv4 connection. Defaults to false.
ssmtp_ipv6	Optional. Use IPv6 connection. Defaults to false.

swap

Check command object for the check_swap plugin.

Custom attributes passed as command parameters:

Name	Description
swap_wfree	Optional. The free swap space warning threshold in %. Defaults to 50.
swap_cfree	Optional. The free swap space critical threshold in %. Defaults to 25.

tcp

Check command object for the check_tcp plugin.

Custom attributes passed as command parameters:

Name	Description
tcp_address	Optional. The host's address. Defaults to "`address`" if the host's `address` attribute is set, "`address6`" otherwise.
tcp_port	Required. The port that should be checked.
tcp_expect	Optional. String to expect in server response. Multiple strings must be defined as array.
tcp_all	Optional. All expect strings need to occur in server response. Defaults to false.
tcp_escape_send	Optional. Enable usage of \n, \r, \t or \\ in send string.
tcp_send	Optional. String to send to the server.
tcp_escape_quit	Optional. Enable usage of \n, \r, \t or \\ in quit string.
tcp_quit	Optional. String to send server to initiate a clean close of the connection.
tcp_refuse	Optional. Accept TCP refusals with states ok, warn, crit. Defaults to crit.
tcp_mismatch	Optional. Accept expected string mismatches with states ok, warn, crit. Defaults to warn.
tcp_jail	Optional. Hide output from TCP socket.
tcp_maxbytes	Optional. Close connection once more than this number of bytes are received.
tcp_delay	Optional. Seconds to wait between sending string and polling for response.
tcp_certificate	Optional. Minimum number of days a certificate has to be valid. 1st value is number of days for warning, 2nd is critical (if not specified: 0) -- separated by comma.
tcp_ssl	Optional. Use SSL for the connection. Defaults to false.
tcp_wtime	Optional. Response time to result in warning status (seconds).
tcp_ctime	Optional. Response time to result in critical status (seconds).
tcp_timeout	Optional. Seconds before connection times out. Defaults to 10.
tcp_ipv4	Optional. Use IPv4 connection. Defaults to false.
tcp_ipv6	Optional. Use IPv6 connection. Defaults to false.

udp

Check command object for the check_udp plugin.

Custom attributes passed as command parameters:

Name	Description
udp_address	Optional. The host's address. Defaults to "`address`" if the host's `address` attribute is set, "`address6`" otherwise.
udp_port	Required. The port that should be checked.
udp_send	Required. The payload to send in the UDP datagram.
udp_expect	Required. The payload to expect in the response datagram.
udp_quit	Optional. The payload to send to 'close' the session.
udp_ipv4	Optional. Use IPv4 connection. Defaults to false.
udp_ipv6	Optional. Use IPv6 connection. Defaults to false.

ups

Check command object for the check_ups plugin.

Custom attributes passed as command parameters:

Name	Description
ups_address	Required. The address of the host running upsd. Defaults to "`address`" if the host's `address` attribute is set, "`address6`" otherwise.
ups_name	Required. The UPS name. Defaults to `ups`.
ups_port	Optional. The port to which to connect. Defaults to 3493.
ups_variable	Optional. The variable to monitor. Must be one of LINE, TEMP, BATTPCT or LOADPCT. If this is not set, the check only relies on the value of `ups.status`.
ups_warning	Optional. The warning threshold for the selected variable.
ups_critical	Optional. The critical threshold for the selected variable.
ups_celsius	Optional. Display the temperature in degrees Celsius instead of Fahrenheit. Defaults to `false`.
ups_timeout	Optional. The number of seconds before the connection times out. Defaults to 10.

users

Check command object for the check_users plugin.

Custom attributes passed as command parameters:

Name	Description
users_wgreater	Optional. The user count warning threshold. Defaults to 20.
users_cgreater	Optional. The user count critical threshold. Defaults to 50.

Windows Plugins for Icinga 2

To allow a basic monitoring of Windows clients Icinga 2 comes with a set of Windows only plugins. While trying to mirror the functionalities of their linux cousins from the monitoring-plugins package, the differences between Windows and Linux are too big to be able use the same CheckCommands for both systems.

A check-commands-windows.conf comes with Icinga 2, it asumes that the Windows Plugins are installed in the PluginDir set in your constants.conf. To enable them the following include directive is needed in you icinga2.conf:

include <windows-plugins>

One of the differences between the Windows plugins and their linux counterparts is that they consistently do not require thresholds to run, functioning like dummies without.

Threshold syntax

So not specified differently the thresholds for the plugins all follow the same pattern

Threshold	Meaning
"29"	The threshold is 29.
"!29"	The threshold is 29, but the negative of the result is returned.
"[10-40]"	The threshold is a range from (including) 20 to 40, a value inside means the threshold has been exceeded.
"![10-40]"	Same as above, but the result is inverted.

disk-windows

Check command object for the check_disk.exe plugin. Aggregates the free disk space of all volumes and mount points it can find, or the ones defined in disk_win_path. Ignores removable storage like fash drives and discs (CD, DVD etc.).

Custom attributes:

Name	Description
disk_win_warn	Optional. The warning threshold.
disk_win_crit	Optional. The critical threshold.
disk_win_path	Optional. Check only these paths, default checks all.
disk_win_unit	Optional. Use this unit to display disk space, thresholds are interpreted in this unit. Defaults to "mb", possible values are: b, kb, mb, gb and tb.
disk_win_exclude	Optional. Exclude these drives from check.

load-windows

Check command object for the check_load.exe plugin. This plugin collects the inverse of the performance counter \Processor(_Total)\% Idle Time two times, with a wait time of one second between the collection. To change this wait time use perfmon-windows.

Custom attributes:

Name	Description
load_win_warn	Optional. The warning threshold.
load_win_crit	Optional. The critical threshold.

memory-windows

Check command object for the check_memory.exe plugin. The memory collection is instant.

Note

Percentage based thresholds can be used by adding a '%' to the threshold value. Keep in mind that memory_win_unit is applied before the value is calculated.

Custom attributes:

Name	Description
memory_win_warn	Optional. The warning threshold.
memory_win_crit	Optional. The critical threshold.
memory_win_unit	Optional. The unit to display the received value in, thresholds are interpreted in this unit. Defaults to "mb" (megabye), possible values are: b, kb, mb, gb and tb.

network-windows

Check command object for the check_network.exe plugin. Collects the total Bytes inbount and outbound for all interfaces in one second, to itemise interfaces or use a different collection interval use perfmon-windows.

Custom attributes:

Name	Description
network_win_warn	Optional. The warning threshold.
network_win_crit	Optional. The critical threshold.

perfmon-windows

Check command object for the check_perfmon.exe plugin. This plugins allows to collect data from a Performance Counter. After the first data collection a second one is done after perfmon_win_wait milliseconds. When you know perfmon_win_counter only requires one set of data to provide valid data you can set perfmon_win_wait to 0.

To recieve a list of possible Performance Counter Objects run check_perfmon.exe --print-objects and to view an objects instances and counters run check_perfmon.exe --print-object-info -P "name of object"

Custom attributes:

Name	Description
perfmon_win_warn	Optional. The warning threshold.
perfmon_win_crit	Optional. The critical threshold.
perfmon_win_counter	Required. The Performance Counter to use. Ex. `\Processor(_Total)\% Idle Time`.
perfmon_win_wait	Optional. Time in milliseconds to wait between data collection (default: 1000).
perfmon_win_type	Optional. Format in which to expect perfomance values. Possible are: long, int64 and double (default).

ping-windows

Check command object for the check_ping.exe plugin. ping-windows should automaticly detect whether ping_win_address is an IPv4 or IPv6 address. If not, use ping4-windows and ping6-windows. Also note that check_ping.exe waits at least ping_win_timeout milliseconds between the pings.

Custom attributes:

Name	Description
ping_win_warn	Optional. The warning threshold. RTA and package loss separated by comma.
ping_win_crit	Optional. The critical threshold. RTA and package loss separated by comma.
ping_win_address	Required. An IPv4 or IPv6 address
ping_win_packets	Optional. Number of packages to send. Default: 5.
ping_win_timeout	Optional. The timeout in milliseconds. Default: 1000

procs-windows

Check command object for check_procs.exe plugin. When useing procs_win_user this plugins needs adminstratice privileges to access the processes of other users, to just enumerate them no additional privileges are required.

Custom attributes:

Name	Description
procs_win_warn	Optional. The warning threshold.
procs_win_crit	Optional. The critical threshold.
procs_win_user	Optional. Count this useres processes.

service-windows

Check command object for check_service.exe plugin. This checks thresholds work different since the binary decision whether a service is running or not does not allow for three states. As a default check_service.exe will return CRITICAL when service_win_service is not running, the service_win_warn flag changes this to WARNING.

Custom attributes:

Name	Description
service_win_warn	Optional. Warn when service is not running.
service_win_service	Required. The critical threshold.

swap-windows

Check command object for check_swap.exe plugin. The data collection is instant.

Custom attributes:

Name	Description
swap_win_warn	Optional. The warning threshold.
swap_win_crit	Optional. The critical threshold.
swap_win_unit	Optional. The unit to display the received value in, thresholds are interpreted in this unit. Defaults to "mb" (megabyte).

update-windows

Check command object for check_update.exe plugin. Querying Microsoft for Windows updates can take multiple seconds to minutes. An update is treated as important when it has the WSUS flag for SecurityUpdates or CriticalUpdates.

Note

The Network Services Account which runs Icinga 2 by default does not have the required permissions to run this check.

Custom attributes:

Name	Description
update_win_warn	If set, returns warning when important updates are available
update_win_crit	If set, return critical when important updates that require a reboot are available.
update_win_reboot	Set to treat 'may need update' as 'definitely needs update'

uptime-windows

Check command opject for check_uptime.exe plugin. Uses GetTickCount64 to get the uptime, so boot time is not included.

Custom attributes:

Name	Description
uptime_win_warn	Optional. The warning threshold.
uptime_win_crit	Optional. The critical threshold.
uptime_win_unit	Optional. The unit to display the received value in, thresholds are interpreted in this unit. Defaults to "s"(seconds), possible values are ms (milliseconds), s, m (minutes), h (hours).

users-windows

Check command object for check_users.exe plugin.

Custom attributes:

Name	Description
users_win_warn	Optional. The warning threshold.
users_win_crit	Optional. The critical threshold.

Plugin Check Commands for NSClient++

Icinga 2 can use the nscp client command to run arbitrary NSClient++ checks.

You can enable these check commands by adding the following the include directive in your icinga2.conf configuration file:

include <nscp>

You can also optionally specify an alternative installation directory for NSClient++ by adding the NscpPath constant in your constants.conf configuration file:

const NscpPath = "C:\\Program Files (x86)\\NSClient++"

By default Icinga 2 uses the Microsoft Installer API to determine where NSClient++ is installed. It should not be necessary to manually set this constant.

Note that it is not necessary to run NSClient++ as a Windows service for these commands to work.

nscp-local

Check command object for NSClient++

Custom attributes passed as command parameters:

Name	Description
nscp_log_level	Optional. The log level. Defaults to "critical".
nscp_load_all	Optional. Whether to load all modules. Defaults to true.
nscp_boot	Optional. Whether to use the --boot option. Defaults to true.
nscp_query	Required. The NSClient++ query. Try `nscp client -q x` for a list.
nscp_arguments	Optional. An array of query arguments.
nscp_showall	Optional. Shows more details in plugin output, default to false.

nscp-local-cpu

Check command object for the check_cpu NSClient++ plugin.

Name	Description
nscp_cpu_time	Optional. Calculate avarage usage for the given time intervals. Value has to be an array, default to [ "1m", "5m", "15m" ].
nscp_cpu_warning	Optional. Threshold for WARNING state in percent, default to 80.
nscp_cpu_critical	Optional. Threshold for CRITICAL state in percent, default to 90.
nscp_cpu_arguments	Optional. Additional arguments.
nscp_cpu_showall	Optional. Shows more details in plugin output, default to false.

nscp-local-memory

Check command object for the check_memory NSClient++ plugin.

Name	Description
nscp_memory_committed	Optional. Check for committed memory, default to false.
nscp_memory_physical	Optional. Check for physical memory, default to true.
nscp_memory_free	Optional. Switch between checking free (true) or used memory (false), default to false.
nscp_memory_warning	Optional. Threshold for WARNING state in percent or absolut (use MB, GB, ...), default to 80 (free=false) or 20 (free=true).
nscp_memory_critical	Optional. Threshold for CRITICAL state in percent or absolut (use MB, GB, ...), default to 90 (free=false) or 10 (free=true).
nscp_memory_arguments	Optional. Additional arguments.
nscp_memory_showall	Optional. Shows more details in plugin output, default to false.