icinga2/doc/10-icinga-template-library.md

Icinga Template Library

The Icinga Template Library (ITL) implements standard templates and object definitions.

There is a subset of templates and object definitions available:

• Generic ITL templates
• CheckCommand definitions for Icinga 2 (this includes icinga, cluster, cluster-zone, ido, etc.)
• CheckCommand definitions for Monitoring Plugins
• CheckCommand definitions for Icinga 2 Windows Plugins
• CheckCommand definitions for NSClient++
• CheckCommand definitions for Manubulon SNMP
• Contributed CheckCommand definitions

The ITL content is updated with new releases. Please do not modify templates and/or objects as changes will be overridden without further notice.

You are advised to create your own CheckCommand definitions in /etc/icinga2.

Generic Templates

By default the generic templates are included in the icinga2.conf configuration file:

include <itl>

These templates are imported by the provided example configuration.

Note:

These templates are built into the binaries. By convention all command and timeperiod objects should import these templates.

plugin-check-command

Command template for check plugins executed by Icinga 2.

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

By default this template is automatically imported into all CheckCommand definitions.

plugin-notification-command

Command template for notification scripts executed by Icinga 2.

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

By default this template is automatically imported into all NotificationCommand definitions.

plugin-event-command

Command template for event handler scripts executed by Icinga 2.

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

By default this template is automatically imported into all EventCommand definitions.

legacy-timeperiod

Timeperiod template for TimePeriod objects.

The legacy-timeperiod timeperiod does not support any vars.

By default this template is automatically imported into all TimePeriod definitions.

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, reports as warning if the last reload failed and optionally allows for minimum version checks.

Custom variables passed as command parameters:

Name	Description
icinga_min_version	Optional. Required minimum Icinga 2 version, e.g. 2.8.0. If not satisfied, the state changes to Critical. Release packages only.

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 variables passed as command parameters:

Name	Description
cluster_zone	Required. The zone name. Defaults to $host.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.

icingadb

Check command for the built-in icingadb check.

Custom variables passed as command parameters:

Name	Description
icingadb_name	Required. The name of the Icinga DB connection object. Defaults to icingadb.
icingadb_full_dump_duration_warning	Optional. Warning threshold for ongoing Redis dump duration. Applies if the value is higher than the threshold. Defaults to 5 minutes.
icingadb_full_dump_duration_critical	Optional. Critical threshold for ongoing Redis dump duration. Applies if the value is higher than the threshold. Defaults to 10 minutes.
icingadb_full_sync_duration_warning	Optional. Warning threshold for ongoing database sync duration. Applies if the value is higher than the threshold. Defaults to 5 minutes.
icingadb_full_sync_duration_critical	Optional. Critical threshold for ongoing database sync duration. Applies if the value is higher than the threshold. Defaults to 10 minutes.
icingadb_redis_backlog_warning	Optional. Warning threshold for Redis write backlog. Applies if the value is higher than the threshold. Defaults to 5 minutes.
icingadb_redis_backlog_critical	Optional. Critical threshold for Redis write backlog. Applies if the value is higher than the threshold. Defaults to 15 minutes.
icingadb_database_backlog_warning	Optional. Warning threshold for database sync backlog. Applies if the value is higher than the threshold. Defaults to 5 minutes.
icingadb_database_backlog_critical	Optional. Critical threshold for database sync backlog. Applies if the value is higher than the threshold. Defaults to 15 minutes.

ido

Check command for the built-in ido check.

Custom variables 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.
ido_queries_warning	Optional. Warning threshold for queries/s. Applies if the rate is lower than the threshold.
ido_queries_critical	Optional. Critical threshold for queries/s. Applies if the rate is lower than the threshold.
ido_pending_queries_warning	Optional. Warning threshold for pending queries. Applies if pending queries are higher than the threshold. Supersedes the ido_queries thresholds above.
ido_pending_queries_critical	Optional. Critical threshold for pending queries. Applies if pending queries are higher than the threshold. Supersedes the ido_queries thresholds above.

dummy

Check command for the built-in dummy check. This allows to set a check result state and output and can be used in freshness checks or runtime object checks. In contrast to the check_dummy plugin, Icinga 2 implements a light-weight in memory check with 2.9+.

Custom variables 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.".

passive

Specialised check command object for passive checks which uses the functionality of the "dummy" check command with appropriate default values.

Custom variables 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.".

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.

sleep

Check command for the built-in sleep check. This allows to use sleep for testing and debugging only.

Name	Description
sleep_time	Optional. The duration of the sleep in seconds. Defaults to 1s.

ifw-api

Built-in check command for executing arbitrary PowerShell check commands via the Icinga for Windows REST API. Consult that documentation for why and how to optimally use the ifw-api command as an addon for existing Icinga clusters with Icinga for Windows.

In short, that feature lets the PowerShell processes spawned by Icinga just talk to the pre-loaded IfW API instead of loading all PowerShell check commands by itself on every check. In contrast, the ifw-api command doesn't even spawn any process, but communicates directly with the IfW API.

It may be also used like e.g. check_by_ssh. Its custom variables provide high flexibility. From using a custom CA to controlling the IfW API directly from a Linux satellite.

Optional custom variables passed as command parameters:

Name	Default	Description
ifw_api_command	$command.name$	Command to run.
ifw_api_arguments	{} (none)	Arguments for the command, similar to CheckCommand#arguments.
ifw_api_host	null (localhost)	IfW API host.
ifw_api_port	5668	IfW API port.
ifw_api_expected_san	$ifw_api_host$	Peer TLS certificate SAN (and SNI). null means agent NodeName.
ifw_api_cert	null (Icinga PKI)	TLS client certificate path.
ifw_api_key	null (Icinga PKI)	TLS client private key path.
ifw_api_ca	null (Icinga PKI)	Peer TLS CA certificate path.
ifw_api_crl	null (none)	Path to TLS CRL to check peer against.
ifw_api_username	null (none)	Basic auth username.
ifw_api_password	null (none)	Basic auth password.

!!! info

Due to how Icinga 2 resolves macros and serializes the resolved values for
sending to a command endpoint (if any), ifw\_api\_arguments may not directly
contain functions for the case `ifw-api` is used with command endpoints. Only
macro strings referring to custom variables which are set to functions work.

Remarks

• $command.name$ is resolved at runtime to the name of the specific check command being run and not any of the templates it imports, i.e. it becomes e.g. "Invoke-IcingaCheckCPU" if "ifw-api" is imported there
• ifw-api connects to localhost (if ifw_api_host is null), but expects the peer to identify itself via TLS with the NodeName of the endpoint actually running the command (if ifw_api_expected_san is null)
• The actual values of ifw_api_cert, ifw_api_key, ifw_api_ca and ifw_api_crl are also resolved to the Icinga PKI on the command endpoint if null

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.

Note:

Please be aware that the CheckCommand definitions are based on the Monitoring Plugins, other Plugin collections might not support all parameters. If there are command parameters missing for the provided CheckCommand definitions please kindly send a patch upstream. This should include an update for the ITL CheckCommand itself and this documentation section.

apt

The plugin apt checks for software updates on systems that use package management systems based on the apt-get(8) command found in Debian based systems.

Custom variables 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).
apt_only_critical	Optional. Only warn about critical upgrades.
apt_list	Optional. List packages available for upgrade.

breeze

The check_breeze plugin reports the signal strength of a Breezecom wireless equipment.

Custom variables 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

The check_by_ssh plugin uses SSH to execute commands on a remote host.

Custom variables 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.
by_ssh_skip_stderr	Optional. Ignore all or (if specified) first n lines on STDERR.

clamd

The check_clamd plugin tests CLAMD connections with the specified host (or unix socket).

Custom variables 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

The check_dhcp plugin tests the availability of DHCP servers on a network.

Custom variables 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

The check_dig plugin test the DNS service on the specified host using dig.

Custom variables 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

The check_disk 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.

Custom variables 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. May be true or false.
disk_exact_match	Optional. For paths or partitions specified with -p, only check for exact paths. May be true or false.
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. May be true or false.
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.
disk_exclude_type	Optional. Ignore all filesystems of indicated type. Multiple regular expression strings must be defined as array. Defaults to "none", "tmpfs", "sysfs", "proc", "configfs", "devtmpfs", "devfs", "mtmfs", "tracefs", "cgroup", "fuse.gvfsd-fuse", "fuse.gvfs-fuse-daemon", "fdescfs", "overlay", "nsfs", "squashfs".
disk_include_type	Optional. Check only filesystems of indicated type. Multiple regular expression strings must be defined as array.
disk_inode_perfdata	Optional. Display inode usage in perfdata

disk_smb

The check_disk_smb plugin uses the smbclient binary to check SMB shares.

Custom variables 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

The check_dns 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.

Custom variables 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_query_type	Optional. The DNS record query type where TYPE =(A, AAAA, SRV, TXT, MX, ANY). The default query type is 'A' (IPv4 host entry). Only supported by the Nagios plugins version of check_dns, not by the monitoring plugins one.
dns_expected_answers	Optional. The answer(s) to look for. A hostname must end with a dot. Format depends on the monitoring-plugins version: In version 2.2 and before, a single string with the values alphabetically ordered and joined by commas. In version 2.3 and later, multiple answers must be defined as array.
dns_all_expected	Optional. Denotes whether to require all values passed in dns_expected_answers to pass, or at least one. Only supported in newer versions of monitoring-plugins (2.3 and later), and is needed in such versions to replicate behaviour of previous versions of the plugins.
dns_authoritative	Optional. Expect the server to send an authoritative answer.
dns_accept_cname	Optional. Accept cname responses as a valid result to a query.
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.

file_age

The check_file_age plugin checks a file's size and modification time to make sure it's not empty and that it's sufficiently recent.

Custom variables 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

The check_flexlm plugin checks available flexlm license managers. Requires the lmstat command.

Custom variables 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

The check_fping plugin uses the fping command to ping the specified host for a fast check. Note that it is necessary to set the suid flag on fping.

This CheckCommand expects an IPv4 address.

Custom variables 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

The check_fping plugin will use the fping command to ping the specified host for a fast check. Note that it is necessary to set the suid flag on fping.

This CheckCommand expects an IPv6 address.

Custom variables 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

The check_ftp plugin tests FTP connections with the specified host (or unix socket).

Custom variables 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

The check_game plugin tests game server connections with the specified host. This plugin uses the 'qstat' command, the popular game server status query tool. If you don't have the package installed, you will need to download or install the package quakestat before you can use this plugin.

Custom variables 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 variables 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 variables 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 variables 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

The check_hpjd plugin tests the state of an HP printer with a JetDirect card. Net-snmp must be installed on the computer running the plugin.

Custom variables 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

The check_http 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.

The plugin can either test the HTTP response of a server, or if http_certificate is set to a non-empty value, the TLS certificate age for a HTTPS host.

Custom variables 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 behavior 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. When this option is used the URL is not checked. The first parameter defines the warning threshold (in days), the second parameter the critical threshold (in days). (Example http_certificate = "30,20").
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. Can be an array if multiple headers should be passed to check_http.
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.
http_link	Optional. Wrap output in HTML link. Defaults to false.
http_verbose	Optional. Show details for command-line debugging. Defaults to false.
http_verify_host	Optional. Verify SSL certificate is for the -H hostname (with --sni and -S). Defaults to false. Only supported by the Nagios plugins version of check_http, not by the monitoring plugins one.

icmp

The check_icmp plugin check_icmp allows for checking multiple hosts at once compared to check_ping. The main difference is that check_ping executes the system's ping(1) command and parses its output while check_icmp talks ICMP itself. check_icmp must be installed with setuid root.

Custom variables 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 10.
icmp_crta	Optional. The RTA critical threshold in milliseconds. Defaults to 200.
icmp_cpl	Optional. The packet loss critical threshold in %. Defaults to 30.
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).
icmp_ttl	Optional. The TTL on outgoing packets.

imap

The check_imap plugin tests IMAP connections with the specified host (or unix socket).

Custom variables 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

The check_ldap plugin can be used to check LDAP servers.

The plugin can also be used for monitoring ldaps connections instead of the deprecated check_ldaps. This can be ensured by enabling ldap_starttls or ldap_ssl.

Custom variables 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_warning_entries	Optional. Number of found entries to result in warning status.
ldap_critical_entries	Optional. Number of found entries to result in critical status.
ldap_timeout	Optional. Seconds before connection times out (default: 10).
ldap_verbose	Optional. Show details for command-line debugging (disabled by default)

load

The check_load plugin tests the current system load average.

Custom variables 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

The check_mailq plugin checks the number of messages in the mail queue (supports multiple sendmail queues, qmail).

Custom variables 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).
mailq_sudo	Optional. Use sudo to execute the mailq command.

mysql

The check_mysql plugin tests connections to a MySQL server.

Custom variables passed as command parameters:

Name	Description
mysql_extra_opts	Optional. Read options from an ini file.
mysql_hostname	Optional. Host name, IP Address, or unix socket (must be an absolute path).
mysql_port	Optional. Port number (default: 3306).
mysql_socket	Optional. Use the specified socket (has no effect if mysql_hostname is used).
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 encryption.
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

The check_mysql_query plugin checks a query result against threshold levels. The result from the query should be numeric. For extra security, create a user with minimal access.

Note: You must specify mysql_query_password with an empty string to force an empty password, overriding any my.cnf settings.

Custom variables 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

The negate plugin negates the status of a plugin (returns OK for CRITICAL and vice-versa). Additional switches can be used to control which state becomes what.

Custom variables 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,
negate_unknown	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

The check_nrpe plugin can be used to query an NRPE server or NSClient++. Note: This plugin is considered insecure/deprecated.

Custom variables 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.
nrpe_version_2	Optional. Use this if you want to connect using NRPE v2 protocol (needed for NSClient++). Defaults to false.
nrpe_version_3	Optional. Use this if you want to connect using NRPE v3 protocol. Defaults to false.
nrpe_payload_size	Optional. Specify non-default payload size for NSClient++. Default is 1024.
nrpe_ca	Optional. The CA file to use for PKI. Defaults to none.
nrpe_cert	Optional. The client cert file to use for PKI. Defaults to none.
nrpe_key	Optional. The client key file to use for PKI. Defaults to none.
nrpe_ssl_version	Optional. The SSL/TLS version to use. Defaults to TLSv1+.
nrpe_cipher_list	Optional. The list of SSL ciphers to use. Default depends on check_nrpe version.
nrpe_dh_opt	Optional. Anonymous Diffie Hellman use: 0 = deny, 1 = allow, 2 = force. Default depends on check_nrpe version.
nrpe_no_logging	Optional. Disable logging of check_nrpe to syslog facilities (requires check_nrpe >= 4.0).

nscp

The check_nt plugin collects data from the NSClient++ service.

Custom variables 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

The check_ntp_time plugin checks the clock offset between the local host and a remote NTP server.

Note: If you want to monitor an NTP server, please use ntp_peer.

Custom variables 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_quiet	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

The check_ntp_peer plugin checks the health of an NTP server. It supports checking the offset with the sync peer, the jitter and stratum. This plugin will not check the clock offset between the local host and NTP server; please use ntp_time for that purpose.

Custom variables 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_quiet	Optional. Returns UNKNOWN instead of CRITICAL or WARNING if server isn't synchronized.
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.

pgsql

The check_pgsql plugin tests a PostgreSQL DBMS to determine whether it is active and accepting queries. If a query is specified using the pgsql_query attribute, it will be executed after connecting to the server. The result from the query has to be numeric in order to compare it against the query thresholds if set.

Custom variables passed as command parameters:

Name	Description
pgsql_extra_opts	Optional. Read options from an ini file.
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

The check_ping plugin uses the ping command to probe the specified host for packet loss (percentage) and round trip average (milliseconds).

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 variables 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

The check_ping plugin uses the ping command to probe the specified host for packet loss (percentage) and round trip average (milliseconds).

This command uses the host's address attribute if not explicitly specified using the ping_address attribute.

Custom variables 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

The check_ping plugin uses the ping command to probe the specified host for packet loss (percentage) and round trip average (milliseconds).

This command uses the host's address6 attribute if not explicitly specified using the ping_address attribute.

Custom variables 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

The check_pop plugin tests POP connections with the specified host (or unix socket).

Custom variables 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

The check_procs plugin 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.

Custom variables 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.

radius

The check_radius plugin checks 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 possibly be determined by careful watching of the command line in a process listing. This risk is exacerbated because the plugin will typically be executed at regular predictable intervals. Please be sure that the password used does not allow access to sensitive system resources.

Custom variables passed as command parameters:

Name	Description
radius_address	Optional. The radius server's address. Defaults to "address" if the host's address attribute is set, "address6" otherwise.
radius_config_file	Required. The radius configuration file.
radius_username	Required. The radius username to test.
radius_password	Required. The radius password to test.
radius_port	Optional. The radius port number (default 1645).
radius_nas_id	Optional. The NAS identifier.
radius_nas_address	Optional. The NAS IP address.
radius_expect	Optional. The response string to expect from the server.
radius_retries	Optional. The number of times to retry a failed connection.
radius_timeout	Optional. The number of seconds before connection times out (default: 10).

rpc

The check_rpc plugin tests if a service is registered and running using rpcinfo -H host -C rpc_command.

Custom variables passed as command parameters:

Name	Description
rpc_address	Optional. The rpc host address. Defaults to "address if the host address attribute is set, "address6" otherwise.
rpc_command	Required. The programm name (or number).
rpc_port	Optional. The port that should be checked.
rpc_version	Optional. The version you want to check for (one or more).
rpc_udp	Optional. Use UDP test. Defaults to false.
rpc_tcp	Optional. Use TCP test. Defaults to false.
rpc_verbose	Optional. Show verbose output. Defaults to false.

simap

The check_simap plugin tests SIMAP connections with the specified host (or unix socket).

Custom variables 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

The check_ide_smart plugin checks a local hard drive with the (Linux specific) SMART interface. Requires installation of smartctl.

Custom variables passed as command parameters:

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

smtp

The check_smtp plugin will attempt to open an SMTP connection with the host.

Custom variables 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

The check_snmp plugin checks the status of remote machines and obtains system information via SNMP.

Note: This plugin uses the snmpget command included with the NET-SNMP package.

Custom variables 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.
snmp_offset	Optional. Add/subtract the specified OFFSET to numeric sensor data.
snmp_output_delimiter	Optional. Separates output on multiple OID requests.
snmp_perf_oids	Optional. Label performance data with OIDs instead of --label's.

snmpv3

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

Custom variables 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_context	Optional. The SNMPv3 context.
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, using the uptime OID by default.

Custom variables 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

The check_spop plugin tests SPOP connections with the specified host (or unix socket).

Custom variables 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

The check_ssh plugin connects to an SSH server at a specified host and port.

Custom variables 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 variables 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	Optional. The port that should be checked. Defaults to 443.
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, the default for ssl_cert_valid_days_critical is 0.
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.
ssl_sni	Optional. The server_name that is sent to select the SSL certificate to check. Important if SNI is used.

ssmtp

The check_ssmtp plugin tests SSMTP connections with the specified host (or unix socket).

Custom variables 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

The check_swap plugin checks the swap space on a local machine.

Custom variables passed as command parameters:

Name	Description
swap_wfree	Optional. The free swap space warning threshold in % (enable swap_integer for number values). Defaults to 50%.
swap_cfree	Optional. The free swap space critical threshold in % (enable swap_integer for number values). Defaults to 25%.
swap_integer	Optional. Specifies whether the thresholds are passed as number or percent value. Defaults to false (percent values).
swap_allswaps	Optional. Conduct comparisons for all swap partitions, one by one. Defaults to false.
swap_noswap	Optional. Resulting state when there is no swap regardless of thresholds. Possible values are "ok", "warning", "critical", "unknown". Defaults to "critical".

tcp

The check_tcp plugin tests TCP connections with the specified host (or unix socket).

Custom variables 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_sni	Optional. Hostname to send in the server_name (SNI) SSL/TLS extension.
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

The check_udp plugin tests UDP connections with the specified host (or unix socket).

Custom variables 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

The check_ups plugin tests the UPS service on the specified host. Network UPS Tools must be running for this plugin to work.

Custom variables 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

The check_users plugin checks the number of users currently logged in on the local system and generates an error if the number exceeds the thresholds specified.

Custom variables 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.

uptime

The check_uptime plugin checks the uptime of the system using /proc/uptime.

Custom variables passed as command parameters:

Name	Description
uptime_warning	Required. Min. number of uptime to generate warning (-w 30m). Defaults to 30m.
uptime_critical	Required. Min. number of uptime to generate critical alert (-c 15m). Defaults to 15m.
uptime_for	Optional. Show uptime in a pretty format (Running for x weeks, x days, ...). Defaults to false.
uptime_since	Optional. Show last boot in yyyy-mm-dd HH:MM:SS format (output from 'uptime -s'). Defaults to false.

Windows Plugins for Icinga 2

Note

These plugins are DEPRECATED in favor of our PowerShell Plugins and may be removed in a future release. Check the roadmap.

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 assumes 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) 10 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 disk space of all volumes and mount points it can find, or the ones defined in disk_win_path. Ignores removable storage like flash drives and discs (CD, DVD etc.). The data collection is instant and free disk space (default, see disk_win_show_used) is used for threshold computation.

Note

Percentage based thresholds can be used by adding a '%' to the threshold value.

Custom variables:

Name	Description
disk_win_warn	Optional. The warning threshold. Defaults to "20%".
disk_win_crit	Optional. The critical threshold. Defaults to "10%".
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.
disk_win_show_used	Optional. Use used instead of free space.

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 variables:

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 and free memory is used for threshold computation.

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 variables:

Name	Description
memory_win_warn	Optional. The warning threshold. Defaults to "10%".
memory_win_crit	Optional. The critical threshold. Defaults to "5%".
memory_win_unit	Optional. The unit to display the received value in, thresholds are interpreted in this unit. Defaults to "mb" (megabyte), possible values are: b, kb, mb, gb and tb.
memory_win_show_used	Optional. Show used memory instead of the free memory.

network-windows

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

Custom variables:

Name	Description
network_win_warn	Optional. The warning threshold.
network_win_crit	Optional. The critical threshold.
network_no_isatap	Optional. Do not print ISATAP interfaces.

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 receive 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 variables:

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 performance values. Possible are: long, int64 and double (default).
perfmon_win_syntax	Optional. Use this in the performance output instead of perfmon\_win\_counter. Exists for graphics compatibility reasons.

ping-windows

Check command object for the check_ping.exe plugin. ping-windows should automatically 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 variables:

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 using procs_win_user this plugins needs administrative privileges to access the processes of other users, to just enumerate them no additional privileges are required.

Custom variables:

Name	Description
procs_win_warn	Optional. The warning threshold.
procs_win_crit	Optional. The critical threshold.
procs_win_user	Optional. Count this users 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 variables:

Name	Description
service_win_warn	Optional. Warn when service is not running.
service_win_description	Optional. If this is set, service\_win\_service looks at the service description.
service_win_service	Required. Name of the service to check.

swap-windows

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

Custom variables:

Name	Description
swap_win_warn	Optional. The warning threshold. Defaults to "10%".
swap_win_crit	Optional. The critical threshold. Defaults to "5%".
swap_win_unit	Optional. The unit to display the received value in, thresholds are interpreted in this unit. Defaults to "mb" (megabyte).
swap_win_show_used	Optional. Show used swap instead of the free swap.

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 variables:

Name	Description
update_win_warn	Optional. The warning threshold.
update_win_crit	Optional. The critical threshold.
update_win_reboot	Optional. Set to treat 'may need update' as 'definitely needs update'. Please Note that this is true for almost every update and is therefore not recommended.
ignore_reboot	Optional. Set to disable behavior of returning critical if any updates require a reboot.

If a warning threshold is set but not a critical threshold, the critical threshold will be set to one greater than the set warning threshold. Unless the ignore_reboot flag is set, if any updates require a reboot the plugin will return critical.

Note

If they are enabled, performance data will be shown in the web interface. If run without the optional parameters, the plugin will output critical if any important updates are available.

uptime-windows

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

Custom variables:

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 variables:

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

file-age-windows

Check command object for check_file_age.cmd command file and check_file_age.cmd.ps1 plugin.

Custom variables:

Name	Description
file_age_win_file	Required. File name and location
file_age_win_warning	Required. The warning threshold of file age in seconds.
file_age_win_critical	Required. The critical threshold of file age in seconds.

All variables are required and all variables are positional. The variable order is: file warning critical.

The check_file_age.cmd and the check_file_age.cmd.ps1 files are available for download.

Plugin Check Commands for NSClient++

There are two methods available for querying NSClient++:

• Query the HTTP API locally from an Icinga 2 client (requires a running NSClient++ service)
• Run a local CLI check (does not require NSClient++ as a service)

Both methods have their advantages and disadvantages. One thing to note: If you rely on performance counter delta calculations such as CPU utilization, please use the HTTP API instead of the CLI sample call.

For security reasons, it is advised to enable the NSClient++ HTTP API for local connection from the Icinga 2 client only. Remote connections to the HTTP API are not recommended with using the legacy HTTP API.

nscp_api

check_nscp_api is part of the Icinga 2 plugins. This plugin is available for both, Windows and Linux/Unix.

Verify that the ITL CheckCommand is included in the icinga2.conf configuration file:

vim /etc/icinga2/icinga2.conf

include <plugins>

check_nscp_api runs queries against the NSClient++ API. Therefore NSClient++ needs to have the webserver module enabled, configured and loaded.

You can install the webserver using the following CLI commands:

./nscp.exe web install
./nscp.exe web password — –set icinga

Now you can define specific queries and integrate them into Icinga 2.

The check plugin check_nscp_api can be integrated with the nscp_api CheckCommand object:

Custom variables:

Name	Description
nscp_api_host	Required. NSCP API host address. Defaults to "address" if the host's address attribute is set, "address6" otherwise.
nscp_api_port	Optional. NSCP API port. Defaults to 8443.
nscp_api_password	Required. NSCP API password. Please check the NSCP documentation for setup details.
nscp_api_query	Required. NSCP API query endpoint. Refer to the NSCP documentation for possible values.
nscp_api_arguments	Optional. NSCP API arguments dictionary either as single strings or key-value pairs using =. Refer to the NSCP documentation.

nscp_api_arguments can be used to pass required thresholds to the executed check. The example below checks the CPU utilization and specifies warning and critical thresholds.

check_nscp_api --host 10.0.10.148 --password icinga --query check_cpu --arguments show-all warning='load>40' critical='load>30'
check_cpu CRITICAL: critical(5m: 48%, 1m: 36%), 5s: 0% | 'total 5m'=48%;40;30 'total 1m'=36%;40;30 'total 5s'=0%;40;30

nscp-local

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

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.

The check command object for NSClient++ is available as nscp-local.

Custom variables 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 false.
nscp_modules	Optional. An array of NSClient++ modules to load. Defaults to [ "CheckSystem" ].
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.

Tip

In order to measure CPU load, you'll need a running NSClient++ service. Therefore it is advised to use a local nscp-api check against its REST API.

nscp-local-cpu

Check command object for the check_cpu NSClient++ plugin.

Name	Description
nscp_cpu_time	Optional. Calculate average 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 absolute (use MB, GB, ...), default to 80 (free=false) or 20 (free=true).
nscp_memory_critical	Optional. Threshold for CRITICAL state in percent or absolute (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.

nscp-local-os-version

Check command object for the check_os_version NSClient++ plugin.

This command has the same custom variables like the nscp-local check command.

nscp-local-pagefile

Check command object for the check_pagefile NSClient++ plugin.

This command has the same custom variables like the nscp-local check command.

nscp-local-process

Check command object for the check_process NSClient++ plugin.

This command has the same custom variables like the nscp-local check command.

nscp-local-service

Check command object for the check_service NSClient++ plugin.

Name	Description
nscp_service_name	Required. Name of service to check.
nscp_service_type	Optional. Type to check, default to state.
nscp_service_ok	Optional. State for return an OK, i.e. for type=state running, stopped, ...
nscp_service_otype	Optional. Dedicate type for nscp_service_ok, default to nscp_service_state.
nscp_service_warning	Optional. State for return an WARNING.
nscp_service_wtype	Optional. Dedicate type for nscp_service_warning, default to nscp_service_state.
nscp_service_critical	Optional. State for return an CRITICAL.
nscp_service_ctype	Optional. Dedicate type for nscp_service_critical, default to nscp_service_state.
nscp_service_arguments	Optional. Additional arguments.
nscp_service_showall	Optional. Shows more details in plugin output, default to true.

nscp-local-uptime

Check command object for the check_uptime NSClient++ plugin.

This command has the same custom variables like the nscp-local check command.

nscp-local-version

Check command object for the check_version NSClient++ plugin.

This command has the same custom variables like the nscp-local check command. In addition to that the default value for nscp_modules is set to [ "CheckHelpers" ].

nscp-local-disk

Check command object for the check_drivesize NSClient++ plugin.

Name	Description
nscp_disk_drive	Optional. Drive character, default to all drives. Can be an array if multiple drives should be monitored.
nscp_disk_exclude	Optional. Drive character, default to none. Can be an array of drive characters if multiple drives should be excluded.
nscp_disk_free	Optional. Switch between checking free space (free=true) or used space (free=false), default to false.
nscp_disk_warning	Optional. Threshold for WARNING in percent or absolute (use MB, GB, ...), default to 80 (used) or 20 percent (free).
nscp_disk_critical	Optional. Threshold for CRITICAL in percent or absolute (use MB, GB, ...), default to 90 (used) or 10 percent (free).
nscp_disk_arguments	Optional. Additional arguments.
nscp_disk_showall	Optional. Shows more details in plugin output, default to true.
nscp_modules	Optional. An array of NSClient++ modules to load. Defaults to [ "CheckDisk" ].

nscp-local-counter

Check command object for the check_pdh NSClient++ plugin.

Name	Description
nscp_counter_name	Required. Performance counter name.
nscp_counter_warning	Optional. WARNING Threshold.
nscp_counter_critical	Optional. CRITICAL Threshold.
nscp_counter_arguments	Optional. Additional arguments.
nscp_counter_showall	Optional. Shows more details in plugin output, default to false.
nscp_counter_perfsyntax	Optional. Apply performance data label, e.g. Total Processor Time to avoid special character problems. Defaults to nscp_counter_name.

nscp-local-tasksched

Check Command object for the check_tasksched NSClient++ plugin. You can check for a single task or for a complete folder (and sub folders) of tasks.

Name	Description
nscp_tasksched_name	Optional. Name of the task to check.
nscp_tasksched_folder	Optional. The folder in which the tasks to check reside.
nscp_tasksched_recursive	Optional. Recurse sub folder, defaults to true.
nscp_tasksched_hidden	Optional. Look for hidden tasks, defaults to false.
nscp_tasksched_warning	Optional. Filter which marks items which generates a warning state, defaults to exit_code != 0.
nscp_tasksched_critical	Optional. Filter which marks items which generates a critical state, defaults to exit_code < 0.
nscp_tasksched_emptystate	Optional. Return status to use when nothing matched filter, defaults to warning.
nscp_tasksched_perfsyntax	Optional. Performance alias syntax., defaults to %(title)
nscp_tasksched_detailsyntax	Optional. Detail level syntax, defaults to %(folder)/%(title): %(exit_code) != 0
nscp_tasksched_arguments	Optional. Additional arguments.
nscp_tasksched_showall	Optional. Shows more details in plugin output, default to false.
nscp_modules	Optional. An array of NSClient++ modules to load. Defaults to [ "CheckTaskSched" ].

Plugin Check Commands for Manubulon SNMP

The SNMP Manubulon Plugin Check Commands provide configuration for plugin check commands provided by the SNMP Manubulon project.

Note: Some plugin parameters are only available in Debian packages or in a forked repository with patches applied.

The SNMP manubulon plugin check commands assume that the global constant named ManubulonPluginDir is set to the path where the Manubublon SNMP plugins are installed.

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

include <manubulon>

Checks by Host Type

N/A : Not available for this type.

SNMP : Available for simple SNMP query.

?? : Untested.

Specific : Script name for platform specific checks.

Host type	Interface	storage	load/cpu	mem	process	env	specific
Linux	Yes	Yes	Yes	Yes	Yes	No
Windows	Yes	Yes	Yes	Yes	Yes	No	check_snmp_win.pl
Cisco router/switch	Yes	N/A	Yes	Yes	N/A	Yes
HP router/switch	Yes	N/A	Yes	Yes	N/A	No
Bluecoat proxy	Yes	SNMP	Yes	SNMP	No	Yes
CheckPoint on SPLAT	Yes	Yes	Yes	Yes	Yes	No	check_snmp_cpfw.pl
CheckPoint on Nokia IP	Yes	Yes	Yes	No	??	No	check_snmp_vrrp.pl
Boostedge	Yes	Yes	Yes	Yes	??	No	check_snmp_boostedge.pl
AS400	Yes	Yes	Yes	Yes	No	No
NetsecureOne Netbox	Yes	Yes	Yes	??	Yes	No
Radware Linkproof	Yes	N/A	SNMP	SNMP	No	No	check_snmp_linkproof_nhr check_snmp_vrrp.pl
IronPort	Yes	SNMP	SNMP	SNMP	No	Yes
Cisco CSS	Yes	??	Yes	Yes	No	??	check_snmp_css.pl

snmp-env

Check command object for the check_snmp_env.pl plugin.

Custom variables 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_nocrypt	Optional. Define SNMP encryption. If set to false, snmp_v3 needs to be enabled. Defaults to true (no encryption).
snmp_community	Optional. The SNMP community. Defaults to "public".
snmp_port	Optional. The SNMP port connection.
snmp_v2	Optional. SNMP version to 2c. Defaults to false.
snmp_v3	Optional. SNMP version to 3. Defaults to false.
snmp_login	Optional. SNMP version 3 username. Defaults to "snmpuser".
snmp_password	Required. SNMP version 3 password. No value defined as default.
snmp_v3_use_privpass	Optional. Define to use SNMP version 3 priv password. Defaults to false.
snmp_v3_use_authprotocol	Optional. Define to use SNMP version 3 authentication protocol. Defaults to false.
snmp_authprotocol	Optional. SNMP version 3 authentication protocol. Defaults to "md5,des".
snmp_privpass	Required. SNMP version 3 priv password. No value defined as default.
snmp_env_type	Optional. Environment Type [cisco
snmp_env_fan	Optional. Minimum fan rpm value (only needed for 'iron' & 'linux')
snmp_env_celsius	Optional. Maximum temp in degrees celsius (only needed for 'iron' & 'linux')
snmp_perf	Optional. Enable perfdata values. Defaults to true.
snmp_timeout	Optional. The command timeout in seconds. Defaults to 5 seconds.

snmp-load

Check command object for the check_snmp_load.pl plugin.

Custom variables 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_nocrypt	Optional. Define SNMP encryption. If set to false, snmp_v3 needs to be enabled. Defaults to true (no encryption).
snmp_community	Optional. The SNMP community. Defaults to "public".
snmp_port	Optional. The SNMP port connection.
snmp_v2	Optional. SNMP version to 2c. Defaults to false.
snmp_v3	Optional. SNMP version to 3. Defaults to false.
snmp_login	Optional. SNMP version 3 username. Defaults to "snmpuser".
snmp_password	Required. SNMP version 3 password. No value defined as default.
snmp_v3_use_privpass	Optional. Define to use SNMP version 3 priv password. Defaults to false.
snmp_v3_use_authprotocol	Optional. Define to use SNMP version 3 authentication protocol. Defaults to false.
snmp_authprotocol	Optional. SNMP version 3 authentication protocol. Defaults to "md5,des".
snmp_privpass	Required. SNMP version 3 priv password. No value defined as default.
snmp_warn	Optional. The warning threshold. Change the snmp_load_type var to "netsl" for using 3 values.
snmp_crit	Optional. The critical threshold. Change the snmp_load_type var to "netsl" for using 3 values.
snmp_load_type	Optional. Load type. Defaults to "stand". Check all available types in the snmp load documentation.
snmp_perf	Optional. Enable perfdata values. Defaults to true.
snmp_timeout	Optional. The command timeout in seconds. Defaults to 5 seconds.

snmp-memory

Check command object for the check_snmp_mem.pl plugin.

Custom variables 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_nocrypt	Optional. Define SNMP encryption. If set to false, snmp_v3 needs to be enabled. Defaults to true (no encryption).
snmp_community	Optional. The SNMP community. Defaults to "public".
snmp_port	Optional. The SNMP port connection.
snmp_v2	Optional. SNMP version to 2c. Defaults to false.
snmp_v3	Optional. SNMP version to 3. Defaults to false.
snmp_login	Optional. SNMP version 3 username. Defaults to "snmpuser".
snmp_password	Required. SNMP version 3 password. No value defined as default.
snmp_v3_use_privpass	Optional. Define to use SNMP version 3 priv password. Defaults to false.
snmp_v3_use_authprotocol	Optional. Define to use SNMP version 3 authentication protocol. Defaults to false.
snmp_authprotocol	Optional. SNMP version 3 authentication protocol. Defaults to "md5,des".
snmp_privpass	Required. SNMP version 3 priv password. No value defined as default.
snmp_warn	Optional. The warning threshold.
snmp_crit	Optional. The critical threshold.
snmp_is_cisco	Optional. Change OIDs for Cisco switches. Defaults to false.
snmp_is_hp	Optional. Change OIDs for HP/Procurve switches. Defaults to false.
snmp_perf	Optional. Enable perfdata values. Defaults to true.
snmp_memcached	Optional. Include cached memory in used memory, Defaults to false.
snmp_membuffer	Optional. Exclude buffered memory in used memory, Defaults to false.
snmp_timeout	Optional. The command timeout in seconds. Defaults to 5 seconds.

snmp-storage

Check command object for the check_snmp_storage.pl plugin.

Custom variables 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_nocrypt	Optional. Define SNMP encryption. If set to false, snmp_v3 needs to be enabled. Defaults to true (no encryption).
snmp_community	Optional. The SNMP community. Defaults to "public".
snmp_port	Optional. The SNMP port connection.
snmp_v2	Optional. SNMP version to 2c. Defaults to false.
snmp_v3	Optional. SNMP version to 3. Defaults to false.
snmp_login	Optional. SNMP version 3 username. Defaults to "snmpuser".
snmp_password	Required. SNMP version 3 password. No value defined as default.
snmp_v3_use_privpass	Optional. Define to use SNMP version 3 priv password. Defaults to false.
snmp_v3_use_authprotocol	Optional. Define to use SNMP version 3 authentication protocol. Defaults to false.
snmp_authprotocol	Optional. SNMP version 3 authentication protocol. Defaults to "md5,des".
snmp_privpass	Required. SNMP version 3 priv password. No value defined as default.
snmp_warn	Optional. The warning threshold.
snmp_crit	Optional. The critical threshold.
snmp_storage_name	Optional. Storage name. Default to regex "^/". More options available in the snmp storage documentation.
snmp_storage_type	Optional. Filter by storage type. Valid options are Other, Ram, VirtualMemory, FixedDisk, RemovableDisk, FloppyDisk, CompactDisk, RamDisk, FlashMemory, or NetworkDisk. No value defined as default.
snmp_perf	Optional. Enable perfdata values. Defaults to true.
snmp_exclude	Optional. Select all storages except the one(s) selected by -m. No action on storage type selection.
snmp_timeout	Optional. The command timeout in seconds. Defaults to 5 seconds.
snmp_storage_olength	Optional. Max-size of the SNMP message, usefull in case of Too Long responses.

snmp-interface

Check command object for the check_snmp_int.pl plugin.

Custom variables 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_nocrypt	Optional. Define SNMP encryption. If set to false, snmp_v3 needs to be enabled. Defaults to true (no encryption).
snmp_community	Optional. The SNMP community. Defaults to "public".
snmp_port	Optional. The SNMP port connection.
snmp_v2	Optional. SNMP version to 2c. Defaults to false.
snmp_v3	Optional. SNMP version to 3. Defaults to false.
snmp_login	Optional. SNMP version 3 username. Defaults to "snmpuser".
snmp_password	Required. SNMP version 3 password. No value defined as default.
snmp_v3_use_privpass	Optional. Define to use SNMP version 3 priv password. Defaults to false.
snmp_v3_use_authprotocol	Optional. Define to use SNMP version 3 authentication protocol. Defaults to false.
snmp_authprotocol	Optional. SNMP version 3 authentication protocol. Defaults to "md5,des".
snmp_privpass	Required. SNMP version 3 priv password. No value defined as default.
snmp_warn	Optional. The warning threshold.
snmp_crit	Optional. The critical threshold.
snmp_interface	Optional. Network interface name. Default to regex "eth0".
snmp_interface_inverse	Optional. Inverse Interface check, down is ok. Defaults to false as it is missing.
snmp_interface_perf	Optional. Check the input/output bandwidth of the interface. Defaults to true.
snmp_interface_label	Optional. Add label before speed in output: in=, out=, errors-out=, etc.
snmp_interface_bits_bytes	Optional. Output performance data in bits/s or Bytes/s. Depends on snmp_interface_kbits set to true. Defaults to true.
snmp_interface_percent	Optional. Output performance data in % of max speed. Defaults to false.
snmp_interface_kbits	Optional. Make the warning and critical levels in KBits/s. Defaults to true.
snmp_interface_megabytes	Optional. Make the warning and critical levels in Mbps or MBps. Depends on snmp_interface_kbits set to true. Defaults to true.
snmp_interface_64bit	Optional. Use 64 bits counters instead of the standard counters when checking bandwidth & performance data for interface >= 1Gbps. Defaults to false.
snmp_interface_errors	Optional. Add error & discard to Perfparse output. Defaults to true.
snmp_interface_extended_checks	Optional. Also check the error and discard input/output. When enabled format of snmp_warn and snmp_crit changes to ,,,,,. More options available in the snmp interface documentation. Defaults to false.
snmp_interface_noregexp	Optional. Do not use regexp to match interface name in description OID. Defaults to false.
snmp_interface_delta	Optional. Delta time of perfcheck. Defaults to "300" (5 min).
snmp_interface_warncrit_percent	Optional. Make the warning and critical levels in % of reported interface speed. If set, snmp_interface_megabytes needs to be set to false. Defaults to false.
snmp_interface_ifname	Optional. Switch from IF-MIB::ifDescr to IF-MIB::ifName when looking up the interface's name.
snmp_interface_ifalias	Optional. Switch from IF-MIB::ifDescr to IF-MIB::ifAlias when looking up the interface's name.
snmp_interface_weathermap	Optional. Output data for "weathermap" lines in NagVis. Depends on snmp_interface_perf set to true. Defaults to false. Note: Available in check_snmp_int.pl v2.1.0.
snmp_perf	Optional. Enable perfdata values. Defaults to true.
snmp_timeout	Optional. The command timeout in seconds. Defaults to 5 seconds.
snmp_interface_admin	Optional. Use administrative status instead of operational. Defaults to false.

snmp-process

Check command object for the check_snmp_process.pl plugin.

Custom variables 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_nocrypt	Optional. Define SNMP encryption. If set to false, snmp_v3 needs to be enabled. Defaults to true (no encryption).
snmp_community	Optional. The SNMP community. Defaults to "public".
snmp_port	Optional. The SNMP port connection.
snmp_v2	Optional. SNMP version to 2c. Defaults to false.
snmp_v3	Optional. SNMP version to 3. Defaults to false.
snmp_login	Optional. SNMP version 3 username. Defaults to "snmpuser".
snmp_password	Required. SNMP version 3 password. No value defined as default.
snmp_v3_use_privpass	Optional. Define to use SNMP version 3 priv password. Defaults to false.
snmp_v3_use_authprotocol	Optional. Define to use SNMP version 3 authentication protocol. Defaults to false.
snmp_authprotocol	Optional. SNMP version 3 authentication protocol. Defaults to "md5,des".
snmp_privpass	Required. SNMP version 3 priv password. No value defined as default..
snmp_warn	Optional. The warning threshold.
snmp_crit	Optional. The critical threshold.
snmp_process_name	Optional. Name of the process (regexp). No trailing slash!. Defaults to ".*".
snmp_perf	Optional. Enable perfdata values. Defaults to true.
snmp_timeout	Optional. The command timeout in seconds. Defaults to 5 seconds.
snmp_process_use_params	Optional. Add process parameters to process name for regexp matching. Example: "named.*-t /var/named/chroot" will only select named process with this parameter. Defaults to false.
snmp_process_use_fullpath	Optional. Use full path name instead of process name to select processes. Example: "/opt/app1/app1bin" will only select named process with this full path. Defaults to false.
snmp_process_mem_usage	Optional. Define to check memory usage for the process. Defaults to false.
snmp_process_mem_threshold	Optional. Defines the warning and critical thresholds in Mb when snmp_process_mem_usage set to true. Example "512,1024". Defaults to "0,0".
snmp_process_cpu_usage	Optional. Define to check CPU usage for the process. Defaults to false.
snmp_process_cpu_threshold	Optional. Defines the warning and critical thresholds in % when snmp_process_cpu_usage set to true. If more than one CPU, value can be > 100% : 100%=1 CPU. Example "15,50". Defaults to "0,0".

snmp-service

Check command object for the check_snmp_win.pl plugin.

Custom variables 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_nocrypt	Optional. Define SNMP encryption. If set to false, snmp_v3 needs to be enabled. Defaults to true (no encryption).
snmp_community	Optional. The SNMP community. Defaults to "public".
snmp_port	Optional. The SNMP port connection.
snmp_v2	Optional. SNMP version to 2c. Defaults to false.
snmp_v3	Optional. SNMP version to 3. Defaults to false.
snmp_login	Optional. SNMP version 3 username. Defaults to "snmpuser".
snmp_password	Required. SNMP version 3 password. No value defined as default.
snmp_v3_use_privpass	Optional. Define to use SNMP version 3 priv password. Defaults to false.
snmp_v3_use_authprotocol	Optional. Define to use SNMP version 3 authentication protocol. Defaults to false.
snmp_authprotocol	Optional. SNMP version 3 authentication protocol. Defaults to "md5,des".
snmp_privpass	Required. SNMP version 3 priv password. No value defined as default.
snmp_timeout	Optional. The command timeout in seconds. Defaults to 5 seconds.
snmp_service_name	Optional. Comma separated names of services (perl regular expressions can be used for every one). By default, it is not case sensitive. eg. ^dns$. Defaults to ".*".
snmp_service_count	Optional. Compare matching services with a specified number instead of the number of names provided.
snmp_service_showall	Optional. Show all services in the output, instead of only the non-active ones. Defaults to false.
snmp_service_noregexp	Optional. Do not use regexp to match NAME in service description. Defaults to false.

Contributed Plugin Check Commands

The contributed Plugin Check Commands provides various additional command definitions contributed by community members.

These check commands assume that the global constant named PluginContribDir is set to the path where the user installs custom plugins and can be enabled by uncommenting the corresponding line in icinga2.conf:

vim /etc/icinga2/icinga2.conf

include <plugin-contrib>

This is enabled by default since Icinga 2 2.5.0.

Big Data

This category contains plugins for various Big Data systems.

cloudera_service_status

The cloudera_service_status plugin uses Cloudera Manager API to monitor cluster services

Custom variables passed as command parameters:

Name	Description
cloudera_host	Required. Hostname of cloudera server.
cloudera_port	Optional. Port where cloudera is listening. Defaults to 443.
cloudera_user	Required. The username for the API connection.
cloudera_pass	Required. The password for the API connection.
cloudera_api_version	Required. API version of cloudera.
cloudera_cluster	Required. The cluster name in cloudera manager.
cloudera_service	Required. Name of cluster service to be checked.
cloudera_verify_ssl	Optional. Verify SSL. Defaults to true.

cloudera_hdfs_space

The cloudera_hdfs_space plugin connects to Hadoop Namenode and gets used capacity of selected disk

Custom variables passed as command parameters:

Name	Description
cloudera_hdfs_space_host	Required. Namenode host to connect to.
cloudera_hdfs_space_port	Optional. Namenode port (default 50070).
cloudera_hdfs_space_disk	Required. HDFS disk to check.
cloudera_hdfs_space_warn	Required. Warning threshold in percent.
cloudera_hdfs_space_crit	Required. Critical threshold in percent.

cloudera_hdfs_files

The cloudera_hdfs_files plugin connects to Hadoop Namenode and gets total number of files on HDFS

Custom variables passed as command parameters:

Name	Description
cloudera_hdfs_files_host	Required. Namenode host to connect to.
cloudera_hdfs_files_port	Optional. Namenode port (default 50070).
cloudera_hdfs_files_warn	Required. Warning threshold.
cloudera_hdfs_files_crit	Required. Critical threshold.
cloudera_hdfs_files_max	Required. Max files count that causes problems (default 140,000,000).

Databases

This category contains plugins for various database servers.

db2_health

The check_db2_health plugin uses the DBD::DB2 Perl library to monitor a DB2 database.

The Git repository is located on GitHub.

Custom variables passed as command parameters:

Name	Description
db2_health_database	Required. The name of the database. (If it was catalogued locally, this parameter and db2_health_not_catalogued = false are the only you need. Otherwise you must specify database, hostname and port)
db2_health_username	Optional. The username for the database connection.
db2_health_password	Optional. The password for the database connection.
db2_health_port	Optional. The port where DB2 is listening.
db2_health_warning	Optional. The warning threshold depending on the mode.
db2_health_critical	Optional. The critical threshold depending on the mode.
db2_health_mode	Required. The mode uses predefined keywords for the different checks. For example "connection-time", "database-usage" or "sql".
db2_health_method	Optional. This tells the plugin how to connect to the database. The only method implemented yet is “dbi” which is the default. (It means, the plugin uses the perl module DBD::DB2).
db2_health_name	Optional. The tablespace, datafile, wait event, latch, enqueue depending on the mode or SQL statement to be executed with "db2_health_mode" sql.
db2_health_name2	Optional. If "db2_health_name" is a sql statement, "db2_health_name2" can be used to appear in the output and the performance data.
db2_health_regexp	Optional. If set to true, "db2_health_name" will be interpreted as a regular expression. Defaults to false.
db2_health_units	Optional. This is used for a better output of mode=sql and for specifying thresholds for mode=tablespace-free. Possible values are "%", "KB", "MB" and "GB".
db2_health_maxinactivity	Optional. Used for the maximum amount of time a certain event has not happened.
db2_health_mitigation	Optional. Classifies the severity of an offline tablespace.
db2_health_lookback	Optional. How many days in the past db2_health check should look back to calculate exitcode.
db2_health_report	Optional. Report can be used to output only the bad news. Possible values are "short", "long", "html". Defaults to short.
db2_health_not_catalogued	Optional. Set this variable to false if you want to use a catalogued locally database. Defaults to true.
db2_health_env_db2_home	Required. Specifies the location of the db2 client libraries as environment variable DB2_HOME. Defaults to "/opt/ibm/db2/V10.5".
db2_health_env_db2_version	Optional. Specifies the DB2 version as environment variable DB2_VERSION.

mssql_health

The check_mssql_health plugin uses the DBD::Sybase Perl library based on FreeTDS to monitor a MS SQL server.

The Git repository is located on GitHub.

Custom variables passed as command parameters:

Name	Description
mssql_health_hostname	Optional. Specifies the database hostname or address. No default because you typically use "mssql_health_server".
mssql_health_username	Optional. The username for the database connection.
mssql_health_password	Optional. The password for the database connection.
mssql_health_port	Optional. Specifies the database port. No default because you typically use "mssql_health_server".
mssql_health_server	Optional. The name of a predefined connection (in freetds.conf).
mssql_health_currentdb	Optional. The name of a database which is used as the current database for the connection.
mssql_health_offlineok	Optional. Set this to true if offline databases are perfectly ok for you. Defaults to false.
mssql_health_nooffline	Optional. Set this to true to ignore offline databases. Defaults to false.
mssql_health_dbthresholds	Optional. With this parameter thresholds are read from the database table check_mssql_health_thresholds.
mssql_health_notemp	Optional. Set this to true to ignore temporary databases/tablespaces. Defaults to false.
mssql_health_commit	Optional. Set this to true to turn on autocommit for the dbd::sybase module. Defaults to false.
mssql_health_method	Optional. How the plugin should connect to the database (dbi for the perl module DBD::Sybase (default) and sqlrelay for the SQLRelay proxy).
mssql_health_mode	Required. The mode uses predefined keywords for the different checks. For example "connection-time", "database-free" or "sql".
mssql_health_regexp	Optional. If set to true, "mssql_health_name" will be interpreted as a regular expression. Defaults to false.
mssql_health_warning	Optional. The warning threshold depending on the mode.
mssql_health_critical	Optional. The critical threshold depending on the mode.
mssql_health_warningx	Optional. A possible override for the warning threshold.
mssql_health_criticalx	Optional. A possible override for the critical threshold.
mssql_health_units	Optional. This is used for a better output of mode=sql and for specifying thresholds for mode=tablespace-free. Possible values are "%", "KB", "MB" and "GB".
mssql_health_name	Optional. Depending on the mode this could be the database name or a SQL statement.
mssql_health_name2	Optional. If "mssql_health_name" is a sql statement, "mssql_health_name2" can be used to appear in the output and the performance data.
mssql_health_name3	Optional. Additional argument used for 'database-file-free' mode for example.
mssql_health_extraopts	Optional. Read command line arguments from an external file.
mssql_health_blacklist	Optional. Blacklist some (missing/failed) components
mssql_health_mitigation	Optional. The parameter allows you to change a critical error to a warning.
mssql_health_lookback	Optional. The amount of time you want to look back when calculating average rates.
mssql_health_environment	Optional. Add a variable to the plugin's environment.
mssql_health_negate	Optional. Emulate the negate plugin. --negate warning=critical --negate unknown=critical.
mssql_health_morphmessage	Optional. Modify the final output message.
mssql_health_morphperfdata	Optional. The parameter allows you to change performance data labels.
mssql_health_selectedperfdata	Optional. The parameter allows you to limit the list of performance data.
mssql_health_report	Optional. Report can be used to output only the bad news. Possible values are "short", "long", "html". Defaults to short.
mssql_health_multiline	Optional. Multiline output.
mssql_health_withmymodulesdyndir	Optional. Add-on modules for the my-modes will be searched in this directory.
mssql_health_statefilesdir	Optional. An alternate directory where the plugin can save files.
mssql_health_isvalidtime	Optional. Signals the plugin to return OK if now is not a valid check time.
mssql_health_timeout	Optional. Plugin timeout. Defaults to 15s.

mysql_health

The check_mysql_health plugin uses the DBD::MySQL Perl library to monitor a MySQL or MariaDB database.

The Git repository is located on GitHub.

Custom variables passed as command parameters:

Name	Description
mysql_health_hostname	Required. Specifies the database hostname or address. Defaults to "address" or "address6" if the address attribute is not set.
mysql_health_port	Optional. Specifies the database port. Defaults to 3306 (or 1186 for "mysql_health_mode" cluster).
mysql_health_socket	Optional. Specifies the database unix socket. No default.
mysql_health_username	Optional. The username for the database connection.
mysql_health_password	Optional. The password for the database connection.
mysql_health_database	Optional. The database to connect to. Defaults to information_schema.
mysql_health_warning	Optional. The warning threshold depending on the mode.
mysql_health_critical	Optional. The critical threshold depending on the mode.
mysql_health_warningx	Optional. The extended warning thresholds depending on the mode.
mysql_health_criticalx	Optional. The extended critical thresholds depending on the mode.
mysql_health_mode	Required. The mode uses predefined keywords for the different checks. For example "connection-time", "slave-lag" or "sql".
mysql_health_method	Optional. How the plugin should connect to the database (dbi for using DBD::Mysql (default), mysql for using the mysql-Tool).
mysql_health_commit	Optional. Turns on autocommit for the dbd::* module.
mysql_health_notemp	Optional. Ignore temporary databases/tablespaces.
mysql_health_nooffline	Optional. Skip the offline databases.
mysql_health_regexp	Optional. Parameter name/name2/name3 will be interpreted as (perl) regular expression.
mysql_health_name	Optional. The name of a specific component to check.
mysql_health_name2	Optional. The secondary name of a component.
mysql_health_name3	Optional. The tertiary name of a component.
mysql_health_units	Optional. This is used for a better output of mode=sql and for specifying thresholds for mode=tablespace-free. Possible values are "%", "KB", "MB" and "GB".
mysql_health_labelformat	Optional. One of those formats pnp4nagios or groundwork. Defaults to pnp4nagios.
mysql_health_extraopts	Optional. Read command line arguments from an external file.
mysql_health_blacklist	Optional. Blacklist some (missing/failed) components
mysql_health_mitigation	Optional. The parameter allows you to change a critical error to a warning.
mysql_health_lookback	Optional. The amount of time you want to look back when calculating average rates.
mysql_health_environment	Optional. Add a variable to the plugin's environment.
mysql_health_morphmessage	Optional. Modify the final output message.
mysql_health_morphperfdata	Optional. The parameter allows you to change performance data labels.
mysql_health_selectedperfdata	Optional. The parameter allows you to limit the list of performance data.
mysql_health_report	Optional. Can be used to shorten the output.
mysql_health_multiline	Optional. Multiline output.
mysql_health_negate	Optional. Emulate the negate plugin. --negate warning=critical --negate unknown=critical.
mysql_health_withmymodulesdyndir	Optional. Add-on modules for the my-modes will be searched in this directory.
mysql_health_statefilesdir	Optional. An alternate directory where the plugin can save files.
mysql_health_isvalidtime	Optional. Signals the plugin to return OK if now is not a valid check time.
mysql_health_timeout	Optional. Plugin timeout. Defaults to 60s.

oracle_health

The check_oracle_health plugin uses the DBD::Oracle Perl library to monitor an Oracle database.

The Git repository is located on GitHub.

Custom variables passed as command parameters:

Name	Description
oracle_health_connect	Required. Specifies the database connection string (from tnsnames.ora).
oracle_health_username	Optional. The username for the database connection.
oracle_health_password	Optional. The password for the database connection.
oracle_health_warning	Optional. The warning threshold depending on the mode.
oracle_health_critical	Optional. The critical threshold depending on the mode.
oracle_health_mode	Required. The mode uses predefined keywords for the different checks. For example "connection-time", "flash-recovery-area-usage" or "sql".
oracle_health_method	Optional. How the plugin should connect to the database (dbi for using DBD::Oracle (default), sqlplus for using the sqlplus-Tool).
oracle_health_name	Optional. The tablespace, datafile, wait event, latch, enqueue depending on the mode or SQL statement to be executed with "oracle_health_mode" sql.
oracle_health_name2	Optional. If "oracle_health_name" is a sql statement, "oracle_health_name2" can be used to appear in the output and the performance data.
oracle_health_regexp	Optional. If set to true, "oracle_health_name" will be interpreted as a regular expression. Defaults to false.
oracle_health_units	Optional. This is used for a better output of mode=sql and for specifying thresholds for mode=tablespace-free. Possible values are "%", "KB", "MB" and "GB".
oracle_health_ident	Optional. If set to true, outputs instance and database names. Defaults to false.
oracle_health_commit	Optional. Set this to true to turn on autocommit for the dbd::oracle module. Defaults to false.
oracle_health_noperfdata	Optional. Set this to true if you want to disable perfdata. Defaults to false.
oracle_health_timeout	Optional. Plugin timeout. Defaults to 60s.
oracle_health_report	Optional. Select the plugin output format. Can be short or long. Defaults to long.
oracle_health_notemp	Optional. Set this to true to hide temporary and system tablespaces. Defaults to false.

Environment Macros:

Name	Description
ORACLE_HOME	Required. Specifies the location of the oracle instant client libraries. Defaults to "/usr/lib/oracle/11.2/client64/lib". Can be overridden by setting the custom variable oracle_home.
LD_LIBRARY_PATH	Required. Specifies the location of the oracle instant client libraries for the run-time shared library loader. Defaults to "/usr/lib/oracle/11.2/client64/lib". Can be overridden by setting the custom variable oracle_ld_library_path.
TNS_ADMIN	Required. Specifies the location of the tnsnames.ora including the database connection strings. Defaults to "/etc/icinga2/plugin-configs". Can be overridden by setting the custom variable oracle_tns_admin.

postgres

The check_postgres plugin uses the psql binary to monitor a PostgreSQL database.

The Git repository is located on GitHub.

Custom variables passed as command parameters:

Name	Description
postgres_host	Optional. Specifies the database hostname or address. Defaults to "address" or "address6" if the address attribute is not set. If "postgres_unixsocket" is set to true, falls back to unix socket.
postgres_port	Optional. Specifies the database port. Defaults to 5432.
postgres_dbname	Optional. Specifies the database name to connect to. Defaults to "postgres" or "template1".
postgres_dbuser	Optional. The username for the database connection. Defaults to "postgres".
postgres_dbpass	Optional. The password for the database connection. You can use a .pgpass file instead.
postgres_dbservice	Optional. Specifies the service name to use inside of pg_service.conf.
postgres_warning	Optional. Specifies the warning threshold, range depends on the action.
postgres_critical	Optional. Specifies the critical threshold, range depends on the action.
postgres_include	Optional. Specifies name(s) items to specifically include (e.g. tables), depends on the action.
postgres_exclude	Optional. Specifies name(s) items to specifically exclude (e.g. tables), depends on the action.
postgres_includeuser	Optional. Include objects owned by certain users.
postgres_excludeuser	Optional. Exclude objects owned by certain users.
postgres_standby	Optional. Assume that the server is in continuous WAL recovery mode if set to true. Defaults to false.
postgres_production	Optional. Assume that the server is in production mode if set to true. Defaults to false.
postgres_action	Required. Determines the test executed.
postgres_unixsocket	Optional. If "postgres_unixsocket" is set to true, the unix socket is used instead of an address. Defaults to false.
postgres_query	Optional. Query for "custom_query" action.
postgres_valtype	Optional. Value type of query result for "custom_query".
postgres_reverse	Optional. If "postgres_reverse" is set, warning and critical values are reversed for "custom_query" action.
postgres_tempdir	Optional. Specify directory for temporary files. The default directory is dependent on the OS. More details here.
postgres_datadir	Optional. Specifies the database directory (PGDATA). This information is required for some actions, such as "bloat", "locks" and "prepared_txns".
postgres_language	Optional. Specifies the language for messages issued by the plugin. The default language depends on the system configuration.
postgres_perflimit	Optional. Specifies the maximum number of performance data values returned by the plugin. The default is to return all performance data.
postgres_pgcontroldata	Optional. Full path to the pg_controldata command line utility, e.g. "/usr/pgsql-12/bin/pg_controldata".

mongodb

The check_mongodb.py plugin uses the pymongo Python library to monitor a MongoDB instance.

Custom variables passed as command parameters:

Name	Description
mongodb_host	Required. Specifies the hostname or address. Defaults to "address" if the host's address attribute is set, "address6" otherwise.
mongodb_port	Required. The port mongodb is running on.
mongodb_user	Optional. The username you want to login as.
mongodb_passwd	Optional. The password you want to use for that user.
mongodb_authdb	Optional. The database you want to authenticate against.
mongodb_warning	Optional. The warning threshold we want to set.
mongodb_critical	Optional. The critical threshold we want to set.
mongodb_action	Required. The action you want to take.
mongodb_maxlag	Optional. Get max replication lag (for replication_lag action only).
mongodb_mappedmemory	Optional. Get mapped memory instead of resident (if resident memory can not be read).
mongodb_perfdata	Optional. Enable output of Nagios performance data.
mongodb_database	Optional. Specify the database to check.
mongodb_alldatabases	Optional. Check all databases (action database_size).
mongodb_ssl	Optional. Connect using SSL.
mongodb_ssl_ca_cert_file	Optional. Path to certificate authority file for SSL.
mongodb_replicaset	Optional. Connect to replicaset.
mongodb_replcheck	Optional. If set to true, will enable the mongodb_replicaset value needed for "replica_primary" check.
mongodb_querytype	Optional. The query type to check [query|insert|update|delete|getmore|command] from queries_per_second.
mongodb_collection	Optional. Specify the collection to check.
mongodb_sampletime	Optional. Time used to sample number of pages faults.
mongodb_disableretrywrites	Optional. If set to true, will disable Retry Writes, to allow counting the QPS.

elasticsearch

The check_elasticsearch plugin uses the HTTP API to monitor an Elasticsearch node.

Custom variables passed as command parameters:

Name	Description
elasticsearch_host	Optional. Hostname or network address to probe. Defaults to "address" if the host's address attribute is set, "address6" otherwise.
elasticsearch_failuredomain	Optional. A comma-separated list of ElasticSearch attributes that make up your cluster's failure domain.
elasticsearch_masternodes	Optional. Issue a warning if the number of master-eligible nodes in the cluster drops below this number. By default, do not monitor the number of nodes in the cluster.
elasticsearch_port	Optional. TCP port to probe. The ElasticSearch API should be listening here. Defaults to 9200.
elasticsearch_prefix	Optional. Optional prefix (e.g. 'es') for the ElasticSearch API. Defaults to ''.
elasticsearch_yellowcritical	Optional. Instead of issuing a 'warning' for a yellow cluster state, issue a 'critical' alert. Defaults to false.

redis

The check_redis.pl plugin uses the Redis Perl library to monitor a Redis instance. The plugin can measure response time, hitrate, memory utilization, check replication synchronization, etc. It is also possible to test data in a specified key and calculate averages or summaries on ranges.

Custom variables passed as command parameters:

Name	Description
redis_hostname	Required. Hostname or IP Address to check. Defaults to "address" if the host's address attribute is set, "address6" otherwise.
redis_port	Optional. Port number to query. Default to "6379".
redis_database	Optional. Database name (usually a number) to query, needed for redis_query.
redis_password	Optional. Password for Redis authentication. Safer alternative is to put them in a file and use redis_credentials.
redis_credentials	Optional. Credentials file to read for Redis authentication.
redis_timeout	Optional. Allows to set timeout for execution of this plugin.
redis_variables	Optional. List of variables from info data to do threshold checks on.
redis_warn	Optional. This option can only be used if redis_variables is used and the number of values listed here must exactly match number of variables specified.
redis_crit	Optional. This option can only be used if redis_variables is used and the number of values listed here must exactly match number of variables specified.
redis_perfparse	Optional. This should only be used with variables and causes variable data not only to be printed as part of main status line but also as perfparse compatible output. Defaults to false.
redis_perfvars	Optional. This allows to list variables which values will go only into perfparse output (and not for threshold checking).
redis_prev_perfdata	Optional. If set to true, previous performance data are used to calculate rate of change for counter statistics variables and for proper calculation of hitrate. Defaults to false.
redis_rate_label	Optional. Prefix or Suffix label used to create a new variable which has rate of change of another base variable. You can specify PREFIX or SUFFIX or both as one string separated by ",". Default if not specified is suffix "_rate".
redis_query	Optional. Option specifies key to query and optional variable name to assign the results to after.
redis_option	Optional. Specifiers are separated by "," and must include NAME or PATTERN.
redis_response_time	Optional. If this is used, plugin will measure and output connection response time in seconds. With redis_perfparse this would also be provided on perf variables.
redis_hitrate	Optional. Calculates Hitrate and specify values are interpreted as WARNING and CRITICAL thresholds.
redis_memory_utilization	Optional. This calculates percent of total memory on system used by redis. Total_memory on server must be specified with redis_total_memory. If you specify by itself, the plugin will just output this info. Parameter values are interpreted as WARNING and CRITICAL thresholds.
redis_total_memory	Optional. Amount of memory on a system for memory utilization calculation. Use system memory or max_memory setting of redis.
redis_replication_delay	Optional. Allows to set threshold on replication delay info.

proxysql

The check_proxysql plugin, uses the proxysql binary to monitor proxysql.

Custom variables passed as command parameters:

Name	Description
proxysql_user	Optional. ProxySQL admin username (default=admin)
proxysql_password	Optional. ProxySQL admin password (default=admin)
proxysql_host	Optional. ProxySQL hostname / IP (default=127.0.0.1)
proxysql_port	Optional. ProxySQL admin port (default=6032)
proxysql_defaultfile	Optional. ProxySQL defaults file
proxysql_type	Required. ProxySQL check type (one of conns,hg,rules,status,var)
proxysql_name	Optional. ProxySQL variable name to check
proxysql_lower	Optional. Alert if ProxySQL value are LOWER than defined WARN / CRIT thresholds (only applies to 'var' check type)
proxysql_runtime	Optional. Force ProxySQL Nagios check to query the runtime_mysql_XXX tables rather than the mysql_XXX tables
proxysql_warning	Optional. Warning threshold
proxysql_critical	Optional. Critical threshold
proxysql_include_hostgroup	Optional. ProxySQL hostgroup(s) to include (only applies to '--type hg' checks, accepts comma-separated list)
proxysql_ignore_hostgroup	Optional. ProxySQL hostgroup(s) to ignore (only applies to '--type hg' checks, accepts comma-separated list)

memcached

The check_memcached plugin checks the health of a running memcached service.

On Debian/Ubuntu, it is provided with the nagios-plugin-contrib package.

Custom variables passed as command parameters:

Name	Description
memcached_hostname	Required. Hostname or IP address (required) optional ':port' overrides -p
memcached_port	Optional. Port number (default: 11211)
memcached_verbose	Optional. verbose messages
memcached_keep	Optional. Keep up to this many items in the history object in memcached (default: 30)
memcached_minimum_stat_interval	Optional. Minimum time interval (in minutes) to use to analyse stats. (default: 30)
memcached_warning_hits_misses	Optional. Generate warning if quotient of hits/misses falls below this value (default: 2.0)
memcached_warning_evictions	Optional. Generate warning if number of evictions exceeds this threshold. 0=disable. (default: 10)
memcached_timeout	Optional. timeout in seconds (default: 1.0)
memcached_key	Optional. key name for history object (default: check_memcached)
memcached_expiry	Optional. expiry time in seconds for history object (default: 7200)
memcached_performance_output	Optional. output performance statistics as rate-per-minute figures (better suited to pnp4nagios)

Hardware

This category includes all plugin check commands for various hardware checks.

hpasm

The check_hpasm plugin monitors the hardware health of HP Proliant Servers, provided that the hpasm (HP Advanced Server Management) software is installed. It is also able to monitor the system health of HP Bladesystems and storage systems.

The plugin can run in two different ways:

1. Local execution using the hpasmcli command line tool.
2. Remote SNMP query which invokes the HP Insight Tools on the remote node.

You can either set or omit hpasm_hostname custom variable and select the corresponding node.

The hpasm_remote attribute enables the plugin to execute remote SNMP queries if set to true. For compatibility reasons this attribute uses true as default value, and ensures that specifying the hpasm_hostname always enables remote checks.

Custom variables passed as command parameters:

Name	Description
hpasm_hostname	Optional. The host's address. Defaults to "address" if the host's address attribute is set, "address6" otherwise.
hpasm_community	Optional. SNMP community of the server (SNMP v1/2 only).
hpasm_protocol	Optional. The SNMP protocol to use (default: 2c, other possibilities: 1,3).
hpasm_port	Optional. The SNMP port to use (default: 161).
hpasm_blacklist	Optional. Blacklist some (missing/failed) components.
hpasm_ignore-dimms	Optional. Ignore "N/A"-DIMM status on misc. servers (e.g. older DL320).
hpasm_ignore-fan-redundancy	Optional. Ignore missing redundancy partners.
hpasm_customthresholds	Optional. Use custom thresholds for certain temperatures.
hpasm_eventrange	Optional. Period of time before critical IML events respectively become warnings or vanish. A range is described as a number and a unit (s, m, h, d), e.g. --eventrange 1h/20m.
hpasm_perfdata	Optional. Output performance data. If your performance data string becomes too long and is truncated by Nagios, then you can use --perfdata=short instead. This will output temperature tags without location information.
hpasm_username	Optional. The securityName for the USM security model (SNMPv3 only).
hpasm_authpassword	Optional. The authentication password for SNMPv3.
hpasm_authprotocol	Optional. The authentication protocol for SNMPv3 (md5|sha).
hpasm_privpassword	Optional. The password for authPriv security level.
hpasm_privprotocol	Optional. The private protocol for SNMPv3 (des|aes|aes128|3des|3desde).
hpasm_servertype	Optional. The type of the server: proliant (default) or bladesystem.
hpasm_eval-nics	Optional. Check network interfaces (and groups). Try it and report me whyt you think about it. I need to build up some know how on this subject. If you get an error and think, it is not justified for your configuration, please tell me about it. (always send the output of "snmpwalk -On .... 1.3.6.1.4.1.232" and a description how you setup your nics and why it is correct opposed to the plugins error message.
hpasm_remote	Optional. Run remote SNMP checks if enabled. Otherwise checks are executed locally using the hpasmcli binary. Defaults to true.

openmanage

The check_openmanage plugin checks the hardware health of Dell PowerEdge (and some PowerVault) servers. It uses the Dell OpenManage Server Administrator (OMSA) software, which must be running on the monitored system. check_openmanage can be used remotely with SNMP or locally with icinga2 agent, check_by_ssh or similar, whichever suits your needs and particular taste.

The plugin checks the health of the storage subsystem, power supplies, memory modules, temperature probes etc., and gives an alert if any of the components are faulty or operate outside normal parameters.

Custom variables passed as command parameters:

Name	Description
openmanage_all	Optional. Check everything, even log content
openmanage_blacklist	Optional. Blacklist missing and/or failed components
openmanage_check	Optional. Fine-tune which components are checked
openmanage_community	Optional. SNMP community string [default=public]
openmanage_config	Optional. Specify configuration file
openmanage_critical	Optional. Custom temperature critical limits
openmanage_extinfo	Optional. Append system info to alerts
openmanage_fahrenheit	Optional. Use Fahrenheit as temperature unit
openmanage_hostname	Optional. Hostname or IP (required for SNMP)
openmanage_htmlinfo	Optional. HTML output with clickable links
openmanage_info	Optional. Prefix any alerts with the service tag
openmanage_ipv6	Optional. Use IPv6 instead of IPv4 [default=no]
openmanage_legacy_perfdata	Optional. Legacy performance data output
openmanage_no_storage	Optional. Don't check storage
openmanage_only	Optional. Only check a certain component or alert type
openmanage_perfdata	Optional. Output performance data [default=no]
openmanage_port	Optional. SNMP port number [default=161]
openmanage_protocol	Optional. SNMP protocol version [default=2c]
openmanage_short_state	Optional. Prefix alerts with alert state abbreviated
openmanage_show_blacklist	Optional. Show blacklistings in OK output
openmanage_state	Optional. Prefix alerts with alert state
openmanage_tcp	Optional. Use TCP instead of UDP [default=no]
openmanage_timeout	Optional. Plugin timeout in seconds [default=30]
openmanage_vdisk_critical	Optional. Make any alerts on virtual disks critical
openmanage_warning	Optional. Custom temperature warning limits

lmsensors

The check_lmsensors plugin, uses the lm-sensors binary to monitor temperature sensors.

Custom variables passed as command parameters:

Name	Description
lmsensors_warning	Required. Exit with WARNING status if above INTEGER degrees
lmsensors_critical	Required. Exit with CRITICAL status if above INTEGER degrees
lmsensors_sensor	Optional. Set what to monitor, for example CPU or MB (or M/B). Check sensors for the correct word. Default is CPU.

hddtemp

The check_hddtemp plugin, uses the hddtemp binary to monitor hard drive temperature.

Custom variables passed as command parameters:

Name	Description
hddtemp_server	Required. server name or address
hddtemp_port	Optional. port number
hddtemp_devices	Optional. comma separated devices list, or empty for all devices in hddtemp response
hddtemp_separator	Optional. hddtemp separator
hddtemp_warning	Required. warning temperature
hddtemp_critical	Required. critical temperature
hddtemp_timeout	Optional. receiving data from hddtemp operation network timeout
hddtemp_performance	Optional. If set, return performance data
hddtemp_quiet	Optional. If set, be quiet

The following sane default value are specified:

vars.hddtemp_server = "127.0.0.1"
vars.hddtemp_warning = 55
vars.hddtemp_critical = 60
vars.hddtemp_performance = true
vars.hddtemp_timeout = 5

adaptec-raid

The check_adaptec_raid plugin uses the arcconf binary to monitor Adaptec RAID controllers.

Custom variables passed as command parameters:

Name	Description
adaptec_controller_number	Required. Controller number to monitor.
arcconf_path	Required. Path to the arcconf binary, e.g. "/sbin/arcconf".

lsi-raid

The check_lsi_raid plugin uses the storcli binary to monitor MegaRAID RAID controllers.

Custom variables passed as command parameters:

Name	Description
lsi_controller_number	Optional. Controller number to monitor.
storcli_path	Optional. Path to the storcli binary, e.g. "/usr/sbin/storcli".
lsi_enclosure_id	Optional. Enclosure numbers to be checked, comma-separated.
lsi_ld_id	Optional. Logical devices to be checked, comma-separated.
lsi_pd_id	Optional. Physical devices to be checked, comma-separated.
lsi_temp_warning	Optional. RAID controller warning temperature.
lsi_temp_critical	Optional. RAID controller critical temperature.
lsi_pd_temp_warning	Optional. Disk warning temperature.
lsi_pd_temp_critical	Optional. Disk critical temperature.
lsi_bbu_temp_warning	Optional. Battery warning temperature.
lsi_bbu_temp_critical	Optional. Battery critical temperature.
lsi_cv_temp_warning	Optional. CacheVault warning temperature.
lsi_cv_temp_critical	Optional. CacheVault critical temperature.
lsi_ignored_media_errors	Optional. Warning threshold for media errors.
lsi_ignored_other_errors	Optional. Warning threshold for other errors.
lsi_ignored_predictive_fails	Optional. Warning threshold for predictive failures.
lsi_ignored_shield_counters	Optional. Warning threshold for shield counter.
lsi_ignored_bbm_counters	Optional. Warning threshold for BBM counter.
lsi_bbu	Optional. Define if BBU is present and it's state should be checked.
lsi_noenclosures	Optional. If set to true, does not check enclosures.
lsi_nosudo	Optional. If set to true, does not use sudo when running storcli.
lsi_nocleanlogs	Optional. If set to true, does not clean up the log files after executing storcli checks.

smart-attributes

The check_smart_attributes plugin uses the smartctl binary to monitor SMART values of SSDs and HDDs.

Custom variables passed as command parameters:

Name	Description
smart_attributes_config_path	Required. Path to the smart attributes config file (e.g. check_smartdb.json).
smart_attributes_device	Required. Device name (e.g. /dev/sda) to monitor.

IcingaCLI

This category includes all plugins using the icingacli provided by Icinga Web 2.

The user running Icinga 2 needs sufficient permissions to read the Icinga Web 2 configuration directory. e.g. usermod -a -G icingaweb2 icinga. You need to restart, not reload Icinga 2 for the new group membership to work.

Business Process

This subcommand is provided by the business process module and executed as icingacli businessprocess CLI command.

Custom variables passed as command parameters:

Name	Description
icingacli_businessprocess_process	Required. Business process to monitor.
icingacli_businessprocess_config	Optional. Configuration file containing your business process without file extension.
icingacli_businessprocess_details	Optional. Get details for root cause analysis. Defaults to false.
icingacli_businessprocess_statetype	Optional. Define which state type to look at, soft or hard. Overrides the default value inside the businessprocess module, if configured.
icingacli_businessprocess_ackisok	Optional. Treat acknowledged hosts/services always as UP/OK.
icingacli_businessprocess_blame	Optional. Show problem details as a tree reduced to the nodes which have the same state as the business process.
icingacli_businessprocess_colors	Optional. Show colored output.
icingacli_businessprocess_downtimeisok	Optional. Treat hosts/services in downtime always as UP/OK.
icingacli_businessprocess_rootcause	Optional. Used in combination with icingacli_businessprocess_blame. Only shows the paths of the nodes which are responsible for the state of the business process.

Director

This subcommand is provided by the director module > 1.4.2 and executed as icingacli director health check. Please refer to the documentation for all available sub-checks.

Custom variables passed as command parameters:

Name	Description
icingacli_director_check	Optional. Run only a specific test suite.
icingacli_director_db	Optional. Use a specific Icinga Web DB resource.

Elasticsearch

This subcommand is provided by the elasticsearch_module and executed as icingacli elasticsearch check.

• The value of icingacli_elasticsearch_instance is the same like in the configuration of the module.
• The value of icingacli_elasticsearch_filter are filters for events in Icinga Web 2 syntax. e.g. "beat.hostname=www.example.com" AND severity=critical
• The thresholds are just numerical values. They get checked against how many events match the filter within the given timeframe.
• The value of icingacli_elasticsearch_index is an index pattern. e.g. logstash*

Name	Description
icingacli_elasticsearch_instance	Required. The Elasticsearch to connect to
icingacli_elasticsearch_index	Required. Index pattern to use when searching
icingacli_elasticsearch_critical	Required. Critical threshold
icingacli_elasticsearch_warning	Required. Warning threshold
icingacli_elasticsearch_filter	Required. Filter for events
icingacli_elasticsearch_from	Optional. Negative value of time to search from now (Default: -5m)

x509

This subcommand is provided by the x509 module and executed as icingacli x509 check host. Please refer to the documentation for more information.

Custom variables passed as command parameters:

Name	Description
icingacli_x509_ip	Required. A hosts IP address [or]
icingacli_x509_host	Required. A hosts name
icingacli_x509_port	Optional. The port to check in particular
icingacli_x509_warning	Optional. Less remaining time results in state WARNING (Default: 25%)
icingacli_x509_critical	Optional. Less remaining time results in state CRITICAL (Default: 10%)
icingacli_x509_allow_self_signed	Optional. Ignore if a certificate or its issuer has been self-signed (Default: false)

IPMI Devices

This category includes all plugins for IPMI devices.

ipmi-sensor

The check_ipmi_sensor plugin uses the ipmimonitoring binary to monitor sensor data for IPMI devices. Please read the documentation for installation and configuration details.

Custom variables passed as command parameters:

Name	Description
ipmi_address	Required. Specifies the remote host (IPMI device) to check. Defaults to "address".
ipmi_config_file	Optional. Path to the FreeIPMI configuration file. It should contain IPMI username, IPMI password, and IPMI privilege-level.
ipmi_username	Optional. The IPMI username.
ipmi_password	Optional. The IPMI password.
ipmi_privilege_level	Optional. The IPMI privilege level of the IPMI user.
ipmi_backward_compatibility_mode	Optional. Enable backward compatibility mode, useful for FreeIPMI 0.5.* (this omits FreeIPMI options "--quiet-cache" and "--sdr-cache-recreate").
ipmi_sensor_type	Optional. Limit sensors to query based on IPMI sensor type. Examples for IPMI sensor types are 'Fan', 'Temperature' and 'Voltage'.
ipmi_sel_type	Optional. Limit SEL entries to specific types, run 'ipmi-sel -L' for a list of types. All sensors are populated to the SEL and per default all sensor types are monitored.
ipmi_exclude_sensor_id	Optional. Exclude sensor matching ipmi_sensor_id.
ipmi_exclude_sensor	Optional. Exclude sensor based on IPMI sensor type. (Comma-separated)
ipmi_exclude_sel	Optional. Exclude SEL entries of specific sensor types. (comma-separated list).
ipmi_sensor_id	Optional. Include sensor matching ipmi_sensor_id.
ipmi_protocol_lan_version	Optional. Change the protocol LAN version. Defaults to "LAN_2_0".
ipmi_number_of_active_fans	Optional. Number of fans that should be active. Otherwise a WARNING state is returned.
ipmi_show_fru	Optional. Print the product serial number if it is available in the IPMI FRU data.
ipmi_show_assettag	Optional. Print the assettag if it is available in the IPMI FRU data. (--fru is mandatory)
ipmi_show_board	Optional. Print additional motherboard informations if it is available in the IPMI FRU data. (--fru is mandatory)
ipmi_no_sel_checking	Optional. Turn off system event log checking via ipmi-sel.
ipmi_no_thresholds	Optional. Turn off performance data thresholds from output-sensor-thresholds.
ipmi_verbose	Optional. Be Verbose multi line output, also with additional details for warnings.
ipmi_debug	Optional. Be Verbose debugging output, followed by normal multi line output.
ipmi_unify_file	Optional. Path to the unify file to unify sensor names.

ipmi-alive

The ipmi-alive check commands allows you to create a ping check for the IPMI Interface.

Custom variables passed as command parameters:

Name	Description
ping_address	Optional. The address of the IPMI interface. Defaults to "address" if the IPMI interface's address attribute is set, "address6" otherwise.
ping_wrta	Optional. The RTA warning threshold in milliseconds. Defaults to 5000.
ping_wpl	Optional. The packet loss warning threshold in %. Defaults to 100.
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 1.
ping_timeout	Optional. The plugin timeout in seconds. Defaults to 0 (no timeout).

Log Management

This category includes all plugins for log management, for example Logstash.

logstash

The logstash plugin connects to the Node API of Logstash. This plugin requires at least Logstash version 5.0.x.

The Node API is not activated by default. You have to configure your Logstash installation in order to allow plugin connections.

Name	Description
logstash_hostname	Optional. Hostname where Logstash is running. Defaults to check_address
logstash_port	Optional. Port where Logstash is listening for API requests. Defaults to 9600
logstash_filedesc_warn	Optional. Warning threshold of file descriptor usage in percent. Defaults to 85 (percent).
logstash_filedesc_crit	Optional. Critical threshold of file descriptor usage in percent. Defaults to 95 (percent).
logstash_heap_warn	Optional. Warning threshold of heap usage in percent. Defaults to 70 (percent).
logstash_heap_crit	Optional. Critical threshold of heap usage in percent Defaults to 80 (percent).
logstash_inflight_warn	Optional. Warning threshold of inflight events.
logstash_inflight_crit	Optional. Critical threshold of inflight events.
logstash_cpu_warn	Optional. Warning threshold for cpu usage in percent.
logstash_cpu_crit	Optional. Critical threshold for cpu usage in percent.

logfiles

The logfiles plugin finds specified patterns in log files.

Name	Description
logfiles_tag	Optional. A short unique descriptor for this search. It will appear in the output of the plugin and is used to separare the different services.
logfiles_logfile	Optional. This is the name of the log file you want to scan.
logfiles_rotation	Optional. This is the method how log files are rotated. One of the predefined methods or a regular expression, which helps identify the rotated archives. If this key is missing, check_logfiles assumes that the log file will be simply overwritten instead of rotated.
logfiles_critical_pattern	Optional. A regular expression which will trigger a critical error.
logfiles_warning_pattern	Optional. A regular expression which will trigger a warning error.
logfiles_critical_exception	Optional. A regular expression, the exceptions which are not counted as critical errors.
logfiles_warning_exception	Optional. A regular expression, the exceptions which are not counted as warning errors.
logfiles_ok_pattern	Optional. A regular expression which resets the error counters.
logfiles_no_protocol	Optional. Normally all the matched lines are written into a protocol file with this file’s name appearing in the plugin’s output. This option switches this off.
logfiles_syslog_server	Optional. With this option you limit the pattern matching to lines originating from the host check_logfiles is running on.
logfiles_syslog_client	Optional. With this option you limit the pattern matching to lines originating from the host named in this option.
logfiles_sticky	Optional. Errors are propagated through successive runs.
logfiles_unstick	Optional. Resets sticky errors.
logfiles_config	Optional. The name of a configuration file.
logfiles_configdir	Optional. The name of a configuration directory. Configfiles ending in .cfg or .conf are (recursively) imported.
logfiles_searches	Optional. A list of tags of those searches which are to be run. Using this parameter, not all searches listed in the config file are run, but only those selected.
logfiles_selectedsearches	Optional. A list of tags of those searches which are to be run. Using this parameter, not all searches listed in the config file are run, but only those selected.
logfiles_report	Optional. This option turns on multiline output (Default: off). The setting html generates a table which display the last hits in the service details view. Possible values are: short, long, html or off.
logfiles_max_length	Optional. With this parameter long lines are truncated (Default: off). Some programs (e.g. TrueScan) generate entries in the eventlog of such a length, that the output of the plugin becomes longer than 1024 characters. NSClient++ discards these.
logfiles_winwarncrit	Optional. With this parameter messages in the eventlog are classified by the type WARNING/ERROR (Default: off). Replaces or complements warning/criticalpattern.
logfiles_run_unique	Optional. This parameter prevents check_logfiles from starting when there’s already another instance using the same config file. (exits with UNKNOWN).
logfiles_timeout	Optional. This parameter causes an abort of a running search after a defined number of seconds. It is an aborted in a controlled manner, so that the lines which have been read so far, are used for the computation of the final result.
logfiles_warning	Optional. Complex handler-scripts can be provided with a warning-parameter this way. Inside the scripts the value is accessible as the macro CL_WARNING.
logfiles_critical	Optional. Complex handler-scripts can be provided with a critical-parameter this way. Inside the scripts the value is accessible as the macro CL_CRITICAL.

Metrics

This category includes all plugins for metric-based checks.

graphite

The check_graphite plugin uses the rest-client Ruby library to monitor a Graphite instance.

Custom variables passed as command parameters:

Name	Description
graphite_url	Required. Target url.
graphite_metric	Required. Metric path string.
graphite_shortname	Optional. Metric short name (used for performance data).
graphite_duration	Optional. Length, in minute of data to parse (default: 5).
graphite_function	Optional. Function applied to metrics for thresholds (default: average).
graphite_warning	Required. Warning threshold.
graphite_critical	Required. Critical threshold.
graphite_units	Optional. Adds a text tag to the metric count in the plugin output. Useful to identify the metric units. Doesn't affect data queries.
graphite_message	Optional. Text message to output (default: "metric count:").
graphite_zero_on_error	Optional. Return 0 on a graphite 500 error.
graphite_link_graph	Optional. Add a link in the plugin output, showing a 24h graph for this metric in graphite.

Network Components

This category includes all plugins for various network components like routers, switches and firewalls.

interfacetable

The check_interfacetable_v3t plugin generates a html page containing information about the monitored node and all of its interfaces.

The Git repository is located on GitHub.

Custom variables passed as command parameters:

Name	Description
interfacetable_hostquery	Required. Specifies the remote host to poll. Defaults to "address".
interfacetable_hostdisplay	Optional. Specifies the hostname to display in the HTML link. Defaults to "host.display_name".
interfacetable_regex	Optional. Interface names and property names for some other options will be interpreted as regular expressions. Defaults to false.
interfacetable_outputshort	Optional. Reduce the verbosity of the plugin output. Defaults to false.
interfacetable_exclude	Optional. Comma separated list of interfaces globally excluded from the monitoring.
interfacetable_include	Optional. Comma separated list of interfaces globally included in the monitoring.
interfacetable_aliasmatching	Optional. Allow you to specify alias in addition to interface names. Defaults to false.
interfacetable_excludetraffic	Optional. Comma separated list of interfaces excluded from traffic checks.
interfacetable_includetraffic	Optional. Comma separated list of interfaces included for traffic checks.
interfacetable_warningtraffic	Optional. Interface traffic load percentage leading to a warning alert.
interfacetable_criticaltraffic	Optional. Interface traffic load percentage leading to a critical alert.
interfacetable_pkt	Optional. Add unicast/non-unicast pkt stats for each interface.
interfacetable_trafficwithpkt	Optional. Enable traffic calculation using pkt counters instead of octet counters. Useful when using 32-bit counters to track the load on > 1GbE interfaces. Defaults to false.
interfacetable_trackproperty	Optional. List of tracked properties.
interfacetable_excludeproperty	Optional. Comma separated list of interfaces excluded from the property tracking.
interfacetable_includeproperty	Optional. Comma separated list of interfaces included in the property tracking.
interfacetable_community	Optional. Specifies the snmp v1/v2c community string. Defaults to "public" if using snmp v1/v2c, ignored using v3.
interfacetable_snmpv2	Optional. Use snmp v2c. Defaults to false.
interfacetable_login	Optional. Login for snmpv3 authentication.
interfacetable_passwd	Optional. Auth password for snmpv3 authentication.
interfacetable_privpass	Optional. Priv password for snmpv3 authentication.
interfacetable_protocols	Optional. Authentication protocol,Priv protocol for snmpv3 authentication.
interfacetable_domain	Optional. SNMP transport domain.
interfacetable_contextname	Optional. Context name for the snmp requests.
interfacetable_port	Optional. SNMP port. Defaults to standard port.
interfacetable_64bits	Optional. Use SNMP 64-bits counters. Defaults to false.
interfacetable_maxrepetitions	Optional. Increasing this value may enhance snmp query performances by gathering more results at one time.
interfacetable_snmptimeout	Optional. Define the Transport Layer timeout for the snmp queries.
interfacetable_snmpretries	Optional. Define the number of times to retry sending a SNMP message.
interfacetable_snmpmaxmsgsize	Optional. Size of the SNMP message in octets, useful in case of too long responses. Be careful with network filters. Range 484 - 65535. Apply only to netsnmp perl bindings. The default is 1472 octets for UDP/IPv4, 1452 octets for UDP/IPv6, 1460 octets for TCP/IPv4, and 1440 octets for TCP/IPv6.
interfacetable_unixsnmp	Optional. Use unix snmp utilities for snmp requests. Defaults to false, which means use the perl bindings.
interfacetable_enableperfdata	Optional. Enable port performance data. Defaults to false.
interfacetable_perfdataformat	Optional. Define which performance data will be generated. Possible values are "full" (default), "loadonly", "globalonly".
interfacetable_perfdatathreshold	Optional. Define which thresholds are printed in the generated performance data. Possible values are "full" (default), "loadonly", "globalonly".
interfacetable_perfdatadir	Optional. When specified, the performance data are also written directly to a file, in the specified location.
interfacetable_perfdataservicedesc	Optional. Specify additional parameters for output performance data to PNP. Defaults to "service.name", only affects interfacetable_perfdatadir.
interfacetable_grapher	Optional. Specify the used graphing solution. Possible values are "pnp4nagios" (default), "nagiosgrapher", "netwaysgrapherv2" and "ingraph".
interfacetable_grapherurl	Optional. Graphing system url. Default depends on interfacetable_grapher.
interfacetable_portperfunit	Optional. Traffic could be reported in bits (counters) or in bps (calculated value).
interfacetable_nodetype	Optional. Specify the node type, for specific information to be printed / specific oids to be used. Possible values: "standard" (default), "cisco", "hp", "netscreen", "netapp", "bigip", "bluecoat", "brocade", "brocade-nos", "nortel", "hpux".
interfacetable_duplex	Optional. Add the duplex mode property for each interface in the interface table. Defaults to false.
interfacetable_stp	Optional. Add the stp state property for each interface in the interface table. Defaults to false.
interfacetable_vlan	Optional. Add the vlan attribution property for each interface in the interface table. Defaults to false. This option is available only for the following nodetypes: "cisco", "hp", "nortel"
interfacetable_noipinfo	Optional. Remove the ip information for each interface from the interface table. Defaults to false.
interfacetable_alias	Optional. Add the alias information for each interface in the interface table. Defaults to false.
interfacetable_accessmethod	Optional. Access method for a shortcut to the host in the HTML page. Format is : [:] Where method can be: ssh, telnet, http or https.
interfacetable_htmltablelinktarget	Optional. Specifies the windows or the frame where the [details] link will load the generated html page. Possible values are: "_blank", "_self" (default), "_parent", "_top", or a frame name.
interfacetable_delta	Optional. Set the delta used for interface throughput calculation in seconds.
interfacetable_ifs	Optional. Input field separator. Defaults to ",".
interfacetable_cache	Optional. Define the retention time of the cached data in seconds.
interfacetable_noifloadgradient	Optional. Disable color gradient from green over yellow to red for the load percentage. Defaults to false.
interfacetable_nohuman	Optional. Do not translate bandwidth usage in human readable format. Defaults to false.
interfacetable_snapshot	Optional. Force the plugin to run like if it was the first launch. Defaults to false.
interfacetable_timeout	Optional. Define the global timeout limit of the plugin in seconds. Defaults to "15s".
interfacetable_css	Optional. Define the css stylesheet used by the generated html files. Possible values are "classic", "icinga" or "icinga-alternate1".
interfacetable_config	Optional. Specify a config file to load.
interfacetable_noconfigtable	Optional. Disable configuration table on the generated HTML page. Defaults to false.
interfacetable_notips	Optional. Disable the tips in the generated html tables. Defaults to false.
interfacetable_defaulttablesorting	Optional. Default table sorting can be "index" (default) or "name".
interfacetable_tablesplit	Optional. Generate multiple interface tables, one per interface type. Defaults to false.
interfacetable_notype	Optional. Remove the interface type for each interface. Defaults to false.

iftraffic

The check_iftraffic plugin checks the utilization of a given interface name using the SNMP protocol.

Custom variables passed as command parameters:

Name	Description
iftraffic_address	Required. Specifies the remote host. Defaults to "address".
iftraffic_community	Optional. SNMP community. Defaults to "public'" if omitted.
iftraffic_version	Optional. SNMP version to use. Defaults to "1" if omitted. Requires v1.0.2+.
iftraffic_interface	Required. Queried interface name.
iftraffic_bandwidth	Required. Interface maximum speed in kilo/mega/giga/bits per second.
iftraffic_units	Optional. Interface units can be one of these values: g (gigabits/s),m (megabits/s), k (kilobits/s),b (bits/s)
iftraffic_warn	Optional. Percent of bandwidth usage necessary to result in warning status (defaults to 85).
iftraffic_crit	Optional. Percent of bandwidth usage necessary to result in critical status (defaults to 98).
iftraffic_max_counter	Optional. Maximum counter value of net devices in kilo/mega/giga/bytes.

iftraffic64

The check_iftraffic64 plugin checks the utilization of a given interface name using the SNMP protocol.

Custom variables passed as command parameters:

Name	Description
iftraffic64_address	Required. Specifies the remote host. Defaults to "address".
iftraffic64_community	Optional. SNMP community. Defaults to "public'" if omitted.
iftraffic64_interface	Required. Queried interface name.
iftraffic64_bandwidth	Required. Interface maximum speed in kilo/mega/giga/bits per second.
iftraffic64_units	Optional. Interface units can be one of these values: g (gigabits/s),m (megabits/s), k (kilobits/s),b (bits/s)
iftraffic64_warn	Optional. Percent of bandwidth usage necessary to result in warning status (defaults to 85).
iftraffic64_crit	Optional. Percent of bandwidth usage necessary to result in critical status (defaults to 98).
iftraffic64_max_counter	Optional. Maximum counter value of net devices in kilo/mega/giga/bytes.

interfaces

The check_interfaces plugin uses SNMP to monitor network interfaces and their utilization.

Custom variables passed as command parameters:

Name	Description
interfaces_address	Optional. The host's address. Defaults to "address" if the host's address attribute is set, "address6" otherwise.
interfaces_regex	Optional. Interface list regexp.
interfaces_exclude_regex	Optional. Interface list negative regexp.
interfaces_errors	Optional. Number of in errors (CRC errors for cisco) to consider a warning (default 50).
interface_out_errors	Optional. Number of out errors (collisions for cisco) to consider a warning (default same as in errors).
interfaces_perfdata	Optional. perfdata from last check result.
interfaces_prefix	Optional. Prefix interface names with this label.
interfaces_lastcheck	Optional. Last checktime (unixtime).
interfaces_bandwidth	Optional. Bandwidth warn level in percent.
interfaces_speed	Optional. Override speed detection with this value (bits per sec).
interfaces_trim	Optional. Cut this number of characters from the start of interface descriptions.
interfaces_mode	Optional. Special operating mode (default,cisco,nonbulk,bintec).
interfaces_auth_proto	Optional. SNMPv3 Auth Protocol (SHA|MD5)
interfaces_auth_phrase	Optional. SNMPv3 Auth Phrase
interfaces_priv_proto	Optional. SNMPv3 Privacy Protocol (AES|DES)
interfaces_priv_phrase	Optional. SNMPv3 Privacy Phrase
interfaces_user	Optional. SNMPv3 User
interfaces_down_is_ok	Optional. Disables critical alerts for down interfaces.
interfaces_aliases	Optional. Retrieves the interface description.
interfaces_match_aliases	Optional. Also match against aliases (Option --aliases automatically enabled).
interfaces_timeout	Optional. Sets the SNMP timeout (in ms).
interfaces_sleep	Optional. Sleep between every SNMP query (in ms).
interfaces_names	Optional. If set to true, use ifName instead of ifDescr.

linux_netdev

The check_linux_netdev plugin monitors a Linux system's network device statistics via /proc/net/dev.

Custom variables passed as command parameters:

Name	Description
linux_netdev_duration	Optional. For how long to run. E.g. "10s" or "2m". Default: "1m"
linux_netdev_exclude	Optional. Which NICs to exclude. E.g. eth0 or eth?*, may be an array. Default: none
linux_netdev_thresholds	Optional. Warning and critical thresholds. E.g. eth?*:tx:bytes:persec:w=1000000000 (see plugin documentation), may be an array. Default: none

nwc_health

The check_nwc_health plugin uses SNMP to monitor network components. The plugin is able to generate interface statistics, check hardware (CPU, memory, fan, power, etc.), monitor firewall policies, HRSP, load-balancer pools, processor and memory usage.

Currently the following network components are supported: Cisco IOS, Cisco Nexus, Cisco ASA, Cisco PIX, F5 BIG-IP, CheckPoint Firewall1, Juniper NetScreen, HP Procurve, Nortel, Brocade 4100/4900, EMC DS 4700, EMC DS 24, Allied Telesyn. Blue Coat SG600, Cisco Wireless Lan Controller 5500, Brocade ICX6610-24-HPOE, Cisco UC Telefonzeugs, FOUNDRY-SN-AGENT-MIB, FRITZ!BOX 7390, FRITZ!DECT 200, Juniper IVE, Pulse-Gateway MAG4610, Cisco IronPort AsyncOS, Foundry, etc. A complete list can be found in the plugin documentation.

Custom variables passed as command parameters:

Name	Description
nwc_health_hostname	Optional. The host's address. Defaults to "address" if the host's address attribute is set, "address6" otherwise.
nwc_health_mode	Optional. The plugin mode. A list of all available modes can be found in the plugin documentation.
nwc_health_timeout	Optional. Seconds before plugin times out (default: 15)
nwc_health_blacklist	Optional. Blacklist some (missing/failed) components.
nwc_health_port	Optional. The SNMP port to use (default: 161).
nwc_health_domain	Optional. The transport domain to use (default: udp/ipv4, other possible values: udp6, udp/ipv6, tcp, tcp4, tcp/ipv4, tcp6, tcp/ipv6).
nwc_health_protocol	Optional. The SNMP protocol to use (default: 2c, other possibilities: 1,3).
nwc_health_community	Optional. SNMP community of the server (SNMP v1/2 only).
nwc_health_username	Optional. The securityName for the USM security model (SNMPv3 only).
nwc_health_authpassword	Optional. The authentication password for SNMPv3.
nwc_health_authprotocol	Optional. The authentication protocol for SNMPv3 (md5|sha).
nwc_health_privpassword	Optional. The password for authPriv security level.
nwc_health_privprotocol	Optional. The private protocol for SNMPv3 (des|aes|aes128|3des|3desde).
nwc_health_contextengineid	Optional. The context engine id for SNMPv3 (10 to 64 hex characters).
nwc_health_contextname	Optional. The context name for SNMPv3 (empty represents the default context).
nwc_health_community2	Optional. SNMP community which can be used to switch the context during runtime.
nwc_health_name	Optional. The name of an interface (ifDescr).
nwc_health_drecksptkdb	Optional. This parameter must be used instead of --name, because Devel::ptkdb is stealing the latter from the command line.
nwc_health_alias	Optional. The alias name of a 64bit-interface (ifAlias)
nwc_health_regexp	Optional. A flag indicating that --name is a regular expression
nwc_health_ifspeedin	Optional. Override the ifspeed oid of an interface (only inbound)
nwc_health_ifspeedout	Optional. Override the ifspeed oid of an interface (only outbound)
nwc_health_ifspeed	Optional. Override the ifspeed oid of an interface
nwc_health_units	Optional. One of %, B, KB, MB, GB, Bit, KBi, MBi, GBi. (used for e.g. mode interface-usage)
nwc_health_name2	Optional. The secondary name of a component.
nwc_health_name3	Optional. The tertiary name of a component.
nwc_health_role	Optional. The role of this device in a hsrp group (active/standby/listen).
nwc_health_report	Optional. Can be used to shorten the output. Possible values are: 'long' (default), 'short' (to shorten if available), or 'html' (to produce some html outputs if available)
nwc_health_lookback	Optional. The amount of time you want to look back when calculating average rates. Use it for mode interface-errors or interface-usage. Without --lookback the time between two runs of check_nwc_health is the base for calculations. If you want your checkresult to be based for example on the past hour, use --lookback 3600.
nwc_health_warning	Optional. The warning threshold
nwc_health_critical	Optional. The critical threshold
nwc_health_warningx	Optional. The extended warning thresholds
nwc_health_criticalx	Optional. The extended critical thresholds
nwc_health_mitigation	Optional. The parameter allows you to change a critical error to a warning (1) or ok (0).
nwc_health_selectedperfdata	Optional. The parameter allows you to limit the list of performance data. It's a perl regexp. Only matching perfdata show up in the output.
nwc_health_morphperfdata	Optional. The parameter allows you to change performance data labels. It's a perl regexp and a substitution. --morphperfdata '(.)ISATAP(.)'='$1patasi$2'
nwc_health_negate	Optional. The parameter allows you to map exit levels, such as warning=critical.
nwc_health_mymodules-dyn-dir	Optional. A directory where own extensions can be found.
nwc_health_servertype	Optional. The type of the network device: cisco (default). Use it if auto-detection is not possible.
nwc_health_statefilesdir	Optional. An alternate directory where the plugin can save files.
nwc_health_oids	Optional. A list of oids which are downloaded and written to a cache file. Use it together with --mode oidcache.
nwc_health_offline	Optional. The maximum number of seconds since the last update of cache file before it is considered too old.
nwc_health_multiline	Optional. Multiline output

printer_health

The check_printer_health plugin uses SNMP to monitor printer. The plugin is able to generate supply statistics and check hardware. A complete list can be found in the plugin documentation.

Custom variables passed as command parameters:

Name	Description
printer_health_hostname	Required. The host's address. Defaults to "address" if the host's address attribute is set, "address6" otherwise.
printer_health_mode	Required. The plugin mode. A list of all available modes can be found in the plugin documentation.
printer_health_timeout	Optional. Seconds before plugin times out (default: 15)
printer_health_blacklist	Optional. Blacklist some (missing/failed) components.
printer_health_port	Optional. The SNMP port to use (default: 161).
printer_health_domain	Optional. The transport domain to use (default: udp/ipv4, other possible values: udp6, udp/ipv6, tcp, tcp4, tcp/ipv4, tcp6, tcp/ipv6).
printer_health_protocol	Optional. The SNMP protocol to use (default: 2c, other possibilities: 1,3).
printer_health_community	Optional. SNMP community of the server (SNMP v1/2 only).
printer_health_username	Optional. The securityName for the USM security model (SNMPv3 only).
printer_health_authpassword	Optional. The authentication password for SNMPv3.
printer_health_authprotocol	Optional. The authentication protocol for SNMPv3 (md5|sha).
printer_health_privpassword	Optional. The password for authPriv security level.
printer_health_privprotocol	Optional. The private protocol for SNMPv3 (des|aes|aes128|3des|3desde).
printer_health_contextengineid	Optional. The context engine id for SNMPv3 (10 to 64 hex characters).
printer_health_contextname	Optional. The context name for SNMPv3 (empty represents the default context).
printer_health_community2	Optional. SNMP community which can be used to switch the context during runtime.
printer_health_name	Optional. The name of an interface (ifDescr).
printer_health_regexp	Optional. A flag indicating that --name is a regular expression
printer_health_ifspeedin	Optional. Override the ifspeed oid of an interface (only inbound)
printer_health_ifspeedout	Optional. Override the ifspeed oid of an interface (only outbound)
printer_health_ifspeed	Optional. Override the ifspeed oid of an interface
printer_health_units	Optional. One of %, B, KB, MB, GB, Bit, KBi, MBi, GBi. (used for e.g. mode interface-usage)
printer_health_name2	Optional. The secondary name of a component.
printer_health_name3	Optional. The teritary name of a component.
printer_health_role	Optional. The role of this device in a hsrp group (active/standby/listen).
printer_health_report	Optional. Can be used to shorten the output. Possible values are: 'long' (default), 'short' (to shorten if available), or 'html' (to produce some html outputs if available)
printer_health_lookback	Optional. The amount of time you want to look back when calculating average rates. Use it for mode interface-errors or interface-usage. Without --lookback the time between two runs of check_printer_health is the base for calculations. If you want your checkresult to be based for example on the past hour, use --lookback 3600.
printer_health_warning	Optional. The warning threshold
printer_health_critical	Optional. The critical threshold
printer_health_warningx	Optional. The extended warning thresholds
printer_health_criticalx	Optional. The extended critical thresholds
printer_health_mitigation	Optional. The parameter allows you to change a critical error to a warning (1) or ok (0).
printer_health_selectedperfdata	Optional. The parameter allows you to limit the list of performance data. It's a perl regexp. Only matching perfdata show up in the output.
printer_health_morphperfdata	Optional. The parameter allows you to change performance data labels. It's a perl regexp and a substitution. --morphperfdata '(.)ISATAP(.)'='$1patasi$2'
printer_health_negate	Optional. The parameter allows you to map exit levels, such as warning=critical.
printer_health_mymodules-dyn-dir	Optional. A directory where own extensions can be found.
printer_health_servertype	Optional. The type of the network device: cisco (default). Use it if auto-detection is not possible.
printer_health_statefilesdir	Optional. An alternate directory where the plugin can save files.
printer_health_oids	Optional. A list of oids which are downloaded and written to a cache file. Use it together with --mode oidcache.
printer_health_offline	Optional. The maximum number of seconds since the last update of cache file before it is considered too old.
printer_health_multiline	Optional. Multiline output

Thola

The Thola plugin is a tool for monitoring network devices, that mainly uses SNMP.

To run these commands you need a server that is running the Thola API. If you don't know how to do this, you can have a look at the plugin's documentation. Also, you have to put the Thola-client binary into the PluginContribDir.

thola-cpu-load

Checks the CPU load of a network device.

Custom variables passed as command parameters:

Name	Description
thola_api_address	Required. Address of the Thola API to connect to
thola_device_address	Required. The host's address. Defaults to "address" if the host's address attribute is set, “address6” otherwise.
thola_device_snmp_community	Optional. SNMP community of the device
thola_device_snmp_protocol	Optional. SNMP version to use
thola_cpu_load_critical	Optional. Critical threshold for the CPU load in %
thola_cpu_load_warning	Optional. Warning threshold for the CPU load in %

thola-interface-metrics

Checks the interface metrics of a network device.

Custom variables passed as command parameters:

Name	Description
thola_api_address	Required. Address of the Thola API to connect to
thola_device_address	Required. The host's address. Defaults to "address" if the host's address attribute is set, “address6” otherwise
thola_device_snmp_community	Optional. SNMP community of the device

thola-hardware-health

Checks the hardware health of a network device.

Custom variables passed as command parameters:

Name	Description
thola_api_address	Required. Address of the Thola API to connect to
thola_device_address	Required. The host's address. Defaults to "address" if the host's address attribute is set, “address6” otherwise
thola_device_snmp_community	Optional. SNMP community of the device

thola-identify

Checks if a device can be identified by the given properties.

Custom variables passed as command parameters:

Name	Description
thola_api_address	Required. Address of the Thola API to connect to
thola_device_address	Required. The host's address. Defaults to "address" if the host's address attribute is set, “address6” otherwise
thola_device_snmp_community	Optional. SNMP community of the device
thola_identify_model	Optional. Model that is compared to the actual model of the device
thola_identify_os_version	Optional. OS-version that is compared to the actual OS-version of the device
thola_identify_vendor	Optional. Vendor that is compared to the actual vendor of the device
thola_identify_serial_number	Optional. Serial number that is compared to the actual serial number of the device
thola_identify_discover_retries	Optional. The number of discover retries before aborting
thola_identify_discover_timeouts	Optional. The number of discover timeouts before aborting

Note:

One of the variables thola_identify_model, thola_identify_os_version, thola_identify_vendor or thola_identify_serial_number must be set

thola-memory-usage

Checks the memory usage of a device.

Custom variables passed as command parameters:

Name	Description
thola_api_address	Required. Address of the Thola API to connect to
thola_device_address	Required. The host's address. Defaults to "address" if the host's address attribute is set, “address6” otherwise
thola_device_snmp_community	Optional. SNMP community of the device
thola_memory_usage_critical	Optional. Critical threshold for the memory usage in %
thola_memory_usage_warning	Optional. Warning threshold for the memory usage in %

thola-sbc

Checks special metrics from sbc network devices.

Custom variables passed as command parameters:

Name	Description
thola_api_address	Required. Address of the Thola API to connect to
thola_device_address	Required. The host's address. Defaults to "address" if the host's address attribute is set, “address6” otherwise
thola_device_snmp_community	Optional. SNMP community of the device
thola_sbc_system_health_score_critical	Optional. Critical threshold for the health score in %
thola_sbc_system_health_score_warning	Optional. Warning threshold for the health score in %

thola-thola-server

Checks if a Thola API is running on a given server.

Custom variables passed as command parameters:

Name	Description
thola_api_address	Required. Address of the Thola API to connect to

thola-ups

Checks whether a UPS device has its main voltage applied.

Custom variables passed as command parameters:

Name	Description
thola_api_address	Required. Address of the Thola API to connect to
thola_device_address	Required. The host's address. Defaults to "address" if the host's address attribute is set, “address6” otherwise
thola_device_snmp_community	Optional. SNMP community of the device
thola_ups_batt_current_critical_max	Optional. High critical threshold for the battery current in Volt
thola_ups_batt_current_critical_min	Optional. Low critical threshold for the battery current in Volt
thola_ups_batt_current_warning_max	Optional. High warning threshold for the battery current in Volt
thola_ups_batt_current_warning_min	Optional. Low warning threshold for the battery current in Volt
thola_ups_batt_temperature_critical_max	Optional. High critical threshold for the battery temperature in degree celsius
thola_ups_batt_temperature_critical_min	Optional. Low critical threshold for the battery temperature in degree celsius
thola_ups_batt_temperature_warning_max	Optional. High warning threshold for the battery temperature in degree celsius
thola_ups_batt_temperature_warning_min	Optional. Low warning threshold for the battery temperature in degree celsius
thola_ups_current_load_critical_max	Optional. High critical threshold for the current load in percent
thola_ups_current_load_critical_min	Optional. Low critical threshold for the current load in percent
thola_ups_current_load_warning_max	Optional. High warning threshold for the current load in percent
thola_ups_current_load_warning_min	Optional. Low warning threshold for the current load in percent
thola_ups_rectifier_current_critical_max	Optional. High critical threshold for the current rectifier in Volt
thola_ups_rectifier_current_critical_min	Optional. Low critical threshold for the current rectifier in Volt
thola_ups_rectifier_current_warning_max	Optional. High warning threshold for the current rectifier in Volt
thola_ups_rectifier_current_warning_min	Optional. Low warning threshold for the current rectifier in Volt
thola_ups_system_voltage_critical_max	Optional. High critical threshold for the system voltage in Volt
thola_ups_system_voltage_critical_min	Optional. Low critical threshold for the system voltage in Volt
thola_ups_system_voltage_warning_max	Optional. High warning threshold for the system voltage in Volt
thola_ups_system_voltage_warning_min	Optional. Low warning threshold for the system voltage in Volt

Network Services

This category contains plugins which receive details about network services

lsyncd

The check_lsyncd plugin, uses the lsyncd status file to monitor lsyncd.

Custom variables passed as command parameters:

Name	Description
lsyncd_statfile	Optional. Set status file path (default: /var/run/lsyncd.status).
lsyncd_warning	Optional. Warning if more than N delays (default: 10).
lsyncd_critical	Optional. Critical if more then N delays (default: 100).

fail2ban

The check_fail2ban plugin uses the fail2ban-client binary to monitor fail2ban jails.

The plugin requires sudo permissions. You can add a sudoers file to allow your monitoring user to use the plugin, i.e. edit /etc/sudoers.d/icinga and add:

icinga ALL=(root) NOPASSWD:/usr/lib/nagios/plugins/check_fail2ban

and set the correct permissions:

chown -c root: /etc/sudoers.d/icinga
chmod -c 0440 /etc/sudoers.d/icinga

Custom variables passed as command parameters:

Name	Description
fail2ban_display	Optional. To modify the output display, default is 'CHECK FAIL2BAN ACTIVITY'
fail2ban_path	Optional. Specify the path to the tw_cli binary, default value is /usr/bin/fail2ban-client
fail2ban_warning	Optional. Specify a warning threshold, default is 1
fail2ban_critical	Optional. Specify a critical threshold, default is 2
fail2ban_socket	Optional. Specify a socket path, default is unset
fail2ban_perfdata	Optional. If set to true, activate the perfdata output, default value for the plugin is set to true
fail2ban_jail	Optional. Specify the name of the specific jail to monitor; omitted by default, i.e. all jails are being monitored.

Operating System

This category contains plugins which receive details about your operating system or the guest system.

mem

The check_mem.pl plugin checks the memory usage on linux and unix hosts. It is able to count cache memory as free when compared to thresholds. More details can be found on this blog entry.

Custom variables passed as command parameters:

Name	Description
mem_used	Optional. Tell the plugin to check for used memory to the exclusion of mem_free and mem_available. Must specify one of these as true.
mem_free	Optional. Tell the plugin to check for free memory to the exclusion of mem_used and mem_available. Must specify one of these as true.
mem_available	Optional. Tell the plugin to check available memory to the exclusion of mem_free and mem_used. Must specify one of these as true.
mem_cache	Optional. If set to true, plugin will count cache as free memory. Defaults to false.
mem_warning	Required. Specify the warning threshold as number interpreted as percent.
mem_critical	Required. Specify the critical threshold as number interpreted as percent.

sar-perf

The check_sar_perf.py plugin collects performance metrics from Linux hosts using the sar binary available in the sysstat package.

Custom variables passed as command parameters:

Name	Description
sar_perf_profile	Required. Define the run profile: pagestat, cpu, memory_util, memory_stat, io_transfer, queueln_load, swap_util, swap_stat, task, kernel, disk <disk>. Can be a string or an array of multiple profiles.
sar_perf_disk	Optional. Disk name for the 'disk' profile.

running_kernel

The check_running_kernel plugin is provided by the nagios-plugin-contrib package on Debian/Ubuntu.

Custom variables:

Name	Description
running_kernel_use_sudo	Whether to run the plugin with sudo. Defaults to false except on Ubuntu where it defaults to true.

iostats

The check_iostats plugin uses the iostat binary to monitor I/O on a Linux host. The default thresholds are rather high so you can use a grapher for baselining before setting your own.

Custom variables passed as command parameters:

Name	Description
iostats_disk	Required. The device to monitor without path. e.g. sda or vda. (default: sda).
iostats_warning_tps	Required. Warning threshold for tps (default: 3000).
iostats_warning_read	Required. Warning threshold for KB/s reads (default: 50000).
iostats_warning_write	Required. Warning threshold for KB/s writes (default: 10000).
iostats_warning_wait	Required. Warning threshold for % iowait (default: 50).
iostats_critical_tps	Required. Critical threshold for tps (default: 5000).
iostats_critical_read	Required. Critical threshold for KB/s reads (default: 80000).
iostats_critical_write	Required. Critical threshold for KB/s writes (default: 25000).
iostats_critical_wait	Required. Critical threshold for % iowait (default: 80).

iostat

The check_iostat plugin uses the iostat binary to monitor disk I/O on a Linux host. The default thresholds are rather high so you can use a grapher for baselining before setting your own.

Custom variables passed as command parameters:

Name	Description
iostat_disk	Required. The device to monitor without path. e.g. sda or vda. (default: sda).
iostat_wtps	Required. Warning threshold for tps (default: 100).
iostat_wread	Required. Warning threshold for KB/s reads (default: 100).
iostat_wwrite	Required. Warning threshold for KB/s writes (default: 100).
iostat_ctps	Required. Critical threshold for tps (default: 200).
iostat_cread	Required. Critical threshold for KB/s reads (default: 200).
iostat_cwrite	Required. Critical threshold for KB/s writes (default: 200).

systemd

The check_systemd.py plugin will report a degraded system to your monitoring solution. It requires only the nagiosplugin library.

Custom variables passed as command parameters:

Name	Description
systemd_unit	Optional. Name of the systemd unit that is being tested.
systemd_exclude_unit	Optional. Exclude a systemd unit from the checks. This option can be applied multiple times. Also supports regular expressions.
systemd_no_startup_time	Optional. Don’t check the startup time. Using this option the options systemd_warning and systemd_critical have no effect. (Default: false)
systemd_warning	Optional. Startup time in seconds to result in a warning status. (Default: 60s)
systemd_critical	Optional. Startup time in seconds to result in a critical status. (Default: 120s)
systemd_dead_timers	Optional. Detect dead / inactive timers. (Default: false)
systemd_dead_timers_warning	Optional. Time ago in seconds for dead / inactive timers to trigger a warning state (by default 6 days).
systemd_dead_timers_critical	Optional. Time ago in seconds for dead / inactive timers to trigger a critical state (by default 7 days).
systemd_verbose_level	Optional. Increase verbosity level (Accepted values: 1, 2 or 3). (Defaults to none)

yum

The check_yum plugin checks the YUM package management system for package updates. The plugin requires the yum-plugin-security package to differentiate between security and normal updates.

Custom variables passed as command parameters:

Name	Description
yum_all_updates	Optional. Set to true to not distinguish between security and non-security updates, but returns critical for any available update. This may be used if the YUM security plugin is absent or you want to maintain every single package at the latest version. You may want to use yum_warn_on_any_update instead of this option. Defaults to false.
yum_warn_on_any_update	Optional. Set to true to warn if there are any (non-security) package updates available. Defaults to false.
yum_cache_only	Optional. If set to true, plugin runs entirely from cache and does not update the cache when running YUM. Useful if you have yum makecache cronned. Defaults to false.
yum_no_warn_on_lock	Optional. If set to true, returns OK instead of WARNING when YUM is locked and fails to check for updates due to another instance running. Defaults to false.
yum_no_warn_on_updates	Optional. If set to true, returns OK instead of WARNING even when updates are available. The plugin output still shows the number of available updates. Defaults to false.
yum_enablerepo	Optional. Explicitly enables a repository when calling YUM. Can take a comma separated list of repositories. Note that enabling repositories can lead to unexpected results, for example when protected repositories are enabled.
yum_disablerepo	Optional. Explicitly disables a repository when calling YUM. Can take a comma separated list of repositories. Note that enabling repositories can lead to unexpected results, for example when protected repositories are enabled.
yum_installroot	Optional. Specifies another installation root directory (for example a chroot).
yum_timeout	Optional. Set a timeout in seconds after which the plugin will exit (defaults to 55 seconds).

Storage

This category includes all plugins for various storage and object storage technologies.

glusterfs

The glusterfs plugin is used to check the GlusterFS storage health on the server. The plugin requires sudo permissions.

Custom variables passed as command parameters:

Name	Description
glusterfs_perfdata	Optional. Print perfdata of all or the specified volume.
glusterfs_warnonfailedheal	Optional. Warn if the heal-failed log contains entries. The log can be cleared by restarting glusterd.
glusterfs_volume	Optional. Only check the specified VOLUME. If --volume is not set, all volumes are checked.
glusterfs_disk_warning	Optional. Warn if disk usage is above DISKWARN. Defaults to 90 (percent).
glusterfs_disk_critical	Optional. Return a critical error if disk usage is above DISKCRIT. Defaults to 95 (percent).
glusterfs_inode_warning	Optional. Warn if inode usage is above DISKWARN. Defaults to 90 (percent).
glusterfs_inode_critical	Optional. Return a critical error if inode usage is above DISKCRIT. Defaults to 95 (percent).

ceph

The ceph plugin is used to check the Ceph storage health on the server.

Custom variables passed as command parameters:

Name	Description
ceph_exec_dir	Optional. Ceph executable. Default /usr/bin/ceph.
ceph_conf_file	Optional. Alternative ceph conf file.
ceph_mon_address	Optional. Ceph monitor address[:port].
ceph_client_id	Optional. Ceph client id.
ceph_client_name	Optional. Ceph client name.
ceph_client_key	Optional. Ceph client keyring file.
ceph_whitelist	Optional. Whitelist regexp for ceph health warnings.
ceph_details	Optional. Run 'ceph health detail'.

btrfs

The btrfs plugin is used to check the btrfs storage health on the server.

The plugin requires sudo permissions. You can add a sudoers file to allow your monitoring user to use the plugin, i.e. edit /etc/sudoers.d/icinga and add:

icinga ALL=(root) NOPASSWD:/usr/lib/nagios/plugins/check_btrfs

and set the correct permissions:

chown -c root: /etc/sudoers.d/icinga
chmod -c 0440 /etc/sudoers.d/icinga

monitoring-plugins-btrfs provide the necessary binary on debian/ubuntu.

Custom variables passed as command parameters:

Name	Description
btrfs_awg	Optional. Exit with WARNING status if less than the specified amount of disk space (in GiB) is unallocated
btrfs_acg	Optional. Exit with CRITICAL status if less than the specified amount of disk space (in GiB) is unallocated
btrfs_awp	Optional. Exit with WARNING status if more than the specified percent of disk space is allocated
btrfs_acp	Optional. Exit with CRITICAL status if more than the specified percent of disk space is allocated
btrfs_mountpoint	Required. Path to the BTRFS mountpoint

Virtualization

This category includes all plugins for various virtualization technologies.

esxi_hardware

The check_esxi_hardware.py plugin uses the pywbem Python library to monitor the hardware of ESXi servers through the VMWare CIM API.

Custom variables passed as command parameters:

Name	Description
esxi_hardware_host	Required. Specifies the host to monitor. Defaults to "address".
esxi_hardware_user	Required. Specifies the user for polling. Must be a local user of the root group on the system. Can also be provided as a file path file:/path/to/.passwdfile, then first string of file is used.
esxi_hardware_pass	Required. Password of the user. Can also be provided as a file path file:/path/to/.passwdfile, then second string of file is used.
esxi_hardware_port	Optional. Specifies the CIM port to connect to. Defaults to 5989.
esxi_hardware_sslproto	Optional. Specifies the SSL/TLS protocol to use. Defaults to local openssl config.
esxi_hardware_vendor	Optional. Defines the vendor of the server: "auto", "dell", "hp", "ibm", "intel", "unknown" (default).
esxi_hardware_html	Optional. Add web-links to hardware manuals for Dell servers (use your country extension). Only useful with esxi_hardware_vendor = dell.
esxi_hardware_ignore	Optional. Comma separated list of CIM elements to ignore.
esxi_hardware_regex	Optional. Allow regular expression lookups of elements in ignore list. Defaults to false.
esxi_hardware_perfdata	Optional. Add performcedata for graphers like PNP4Nagios to the output. Defaults to false.
esxi_hardware_format	Optional. Set output format to string or json. Defaults to string.
esxi_hardware_pretty	Optional. Show plugin output in a human readable format. Only useful with esxi_hardware_format = json.
esxi_hardware_nopower	Optional. Do not collect power performance data, when esxi_hardware_perfdata is set to true. Defaults to false.
esxi_hardware_novolts	Optional. Do not collect voltage performance data, when esxi_hardware_perfdata is set to true. Defaults to false.
esxi_hardware_nocurrent	Optional. Do not collect current performance data, when esxi_hardware_perfdata is set to true. Defaults to false.
esxi_hardware_notemp	Optional. Do not collect temperature performance data, when esxi_hardware_perfdata is set to true. Defaults to false.
esxi_hardware_nofan	Optional. Do not collect fan performance data, when esxi_hardware_perfdata is set to true. Defaults to false.
esxi_hardware_nolcd	Optional. Do not collect lcd/display status data. Defaults to false.

VMware

Check commands for the check_vmware_esx plugin.

vmware-esx-dc-volumes

Check command object for the check_vmware_esx plugin. Shows all datastore volumes info.

Custom variables passed as command parameters:

Name	Description
vmware_datacenter	Required. Datacenter/vCenter hostname.
vmware_cluster	Optional. ESX or ESXi clustername.
vmware_sslport	Optional. SSL port connection. Defaults to "443".
vmware_ignoreunknown	Optional. Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
vmware_ignorewarning	Optional. Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
vmware_timeout	Optional. Seconds before plugin times out. Defaults to "90".
vmware_trace	Optional. Set verbosity level of vSphere API request/respond trace.
vmware_sessionfile	Optional. Session file name enhancement.
vmware_sessionfiledir	Optional. Path to store the vmware_sessionfile file. Defaults to "/var/spool/icinga2/tmp".
vmware_nosession	Optional. No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
vmware_username	Optional. The username to connect to Host or vCenter server. No value defined as default.
vmware_password	Optional. The username's password. No value defined as default.
vmware_authfile	Optional. Use auth file instead username/password to session connect. No effect if vmware_username and vmware_password are defined Authentication file content: username=vmuser password=p@ssw0rd
vmware_subselect	Optional. Volume name to be checked the free space.
vmware_gigabyte	Optional. Output in GB instead of MB.
vmware_usedspace	Optional. Output used space instead of free. Defaults to "false".
vmware_alertonly	Optional. List only alerting volumes. Defaults to "false".
vmware_exclude	Optional. Blacklist volumes name. No value defined as default.
vmware_include	Optional. Whitelist volumes name. No value defined as default.
vmware_isregexp	Optional. Treat blacklist and whitelist expressions as regexp.
vmware_dc_volume_used	Optional. Output used space instead of free. Defaults to "true".
vmware_warn	Optional. The warning threshold for volumes. Defaults to "80%".
vmware_crit	Optional. The critical threshold for volumes. Defaults to "90%".

vmware-esx-dc-runtime-info

Check command object for the check_vmware_esx plugin. Shows all runtime info for the datacenter/Vcenter.

Custom variables passed as command parameters:

Name	Description
vmware_datacenter	Required. Datacenter/vCenter hostname.
vmware_cluster	Optional. ESX or ESXi clustername.
vmware_sslport	Optional. SSL port connection. Defaults to "443".
vmware_ignoreunknown	Optional. Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
vmware_ignorewarning	Optional. Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
vmware_timeout	Optional. Seconds before plugin times out. Defaults to "90".
vmware_trace	Optional. Set verbosity level of vSphere API request/respond trace.
vmware_sessionfile	Optional. Session file name enhancement.
vmware_sessionfiledir	Optional. Path to store the vmware_sessionfile file. Defaults to "/var/spool/icinga2/tmp".
vmware_nosession	Optional. No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
vmware_username	Optional. The username to connect to Host or vCenter server. No value defined as default.
vmware_password	Optional. The username's password. No value defined as default.
vmware_authfile	Optional. Use auth file instead username/password to session connect. No effect if vmware_username and vmware_password are defined Authentication file content: username=vmuser password=p@ssw0rd

vmware-esx-dc-runtime-listvms

Check command object for the check_vmware_esx plugin. List of vmware machines and their power state. BEWARE!! In larger environments systems can cause trouble displaying the informations needed due to the mass of data. Use vmware_alertonly to avoid this.

Custom variables passed as command parameters:

Name	Description
vmware_datacenter	Required. Datacenter/vCenter hostname.
vmware_cluster	Optional. ESX or ESXi clustername.
vmware_sslport	Optional. SSL port connection. Defaults to "443".
vmware_ignoreunknown	Optional. Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
vmware_ignorewarning	Optional. Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
vmware_timeout	Optional. Seconds before plugin times out. Defaults to "90".
vmware_trace	Optional. Set verbosity level of vSphere API request/respond trace.
vmware_sessionfile	Optional. Session file name enhancement.
vmware_sessionfiledir	Optional. Path to store the vmware_sessionfile file. Defaults to "/var/spool/icinga2/tmp".
vmware_nosession	Optional. No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
vmware_username	Optional. The username to connect to Host or vCenter server. No value defined as default.
vmware_password	Optional. The username's password. No value defined as default.
vmware_authfile	Optional. Use auth file instead username/password to session connect. No effect if vmware_username and vmware_password are defined Authentication file content: username=vmuser password=p@ssw0rd
vmware_alertonly	Optional. List only alerting VMs. Important here to avoid masses of data.
vmware_exclude	Optional. Blacklist VMs name. No value defined as default.
vmware_include	Optional. Whitelist VMs name. No value defined as default.
vmware_isregexp	Optional. Treat blacklist and whitelist expressions as regexp.
vmware_multiline	Optional. Multiline output in overview. This mean technically that a multiline output uses a HTML <br> for the GUI. No value defined as default.

vmware-esx-dc-runtime-listhost

Check command object for the check_vmware_esx plugin. List of VMware ESX hosts and their power state.

Custom variables passed as command parameters:

Name	Description
vmware_datacenter	Required. Datacenter/vCenter hostname.
vmware_cluster	Optional. ESX or ESXi clustername.
vmware_sslport	Optional. SSL port connection. Defaults to "443".
vmware_ignoreunknown	Optional. Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
vmware_ignorewarning	Optional. Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
vmware_timeout	Optional. Seconds before plugin times out. Defaults to "90".
vmware_trace	Optional. Set verbosity level of vSphere API request/respond trace.
vmware_sessionfile	Optional. Session file name enhancement.
vmware_sessionfiledir	Optional. Path to store the vmware_sessionfile file. Defaults to "/var/spool/icinga2/tmp".
vmware_nosession	Optional. No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
vmware_username	Optional. The username to connect to Host or vCenter server. No value defined as default.
vmware_password	Optional. The username's password. No value defined as default.
vmware_authfile	Optional. Use auth file instead username/password to session connect. No effect if vmware_username and vmware_password are defined Authentication file content: username=vmuser password=p@ssw0rd
vmware_alertonly	Optional. List only alerting hosts. Important here to avoid masses of data.
vmware_exclude	Optional. Blacklist VMware ESX hosts. No value defined as default.
vmware_include	Optional. Whitelist VMware ESX hosts. No value defined as default.
vmware_isregexp	Optional. Treat blacklist and whitelist expressions as regexp.
vmware_multiline	Optional. Multiline output in overview. This mean technically that a multiline output uses a HTML <br> for the GUI. No value defined as default.

vmware-esx-dc-runtime-listcluster

Check command object for the check_vmware_esx plugin. List of VMware clusters and their states.

Custom variables passed as command parameters:

Name	Description
vmware_datacenter	Required. Datacenter/vCenter hostname.
vmware_cluster	Optional. ESX or ESXi clustername.
vmware_sslport	Optional. SSL port connection. Defaults to "443".
vmware_ignoreunknown	Optional. Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
vmware_ignorewarning	Optional. Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
vmware_timeout	Optional. Seconds before plugin times out. Defaults to "90".
vmware_trace	Optional. Set verbosity level of vSphere API request/respond trace.
vmware_sessionfile	Optional. Session file name enhancement.
vmware_sessionfiledir	Optional. Path to store the vmware_sessionfile file. Defaults to "/var/spool/icinga2/tmp".
vmware_nosession	Optional. No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
vmware_username	Optional. The username to connect to Host or vCenter server. No value defined as default.
vmware_password	Optional. The username's password. No value defined as default.
vmware_authfile	Optional. Use auth file instead username/password to session connect. No effect if vmware_username and vmware_password are defined Authentication file content: username=vmuser password=p@ssw0rd
vmware_alertonly	Optional. List only alerting hosts. Important here to avoid masses of data.
vmware_exclude	Optional. Blacklist VMware cluster. No value defined as default.
vmware_include	Optional. Whitelist VMware cluster. No value defined as default.
vmware_isregexp	Optional. Treat blacklist and whitelist expressions as regexp.
vmware_multiline	Optional. Multiline output in overview. This mean technically that a multiline output uses a HTML <br> for the GUI. No value defined as default.

vmware-esx-dc-runtime-issues

Check command object for the check_vmware_esx plugin. All issues for the host.

Custom variables passed as command parameters:

Name	Description
vmware_datacenter	Required. Datacenter/vCenter hostname.
vmware_cluster	Optional. ESX or ESXi clustername.
vmware_sslport	Optional. SSL port connection. Defaults to "443".
vmware_ignoreunknown	Optional. Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
vmware_ignorewarning	Optional. Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
vmware_timeout	Optional. Seconds before plugin times out. Defaults to "90".
vmware_trace	Optional. Set verbosity level of vSphere API request/respond trace.
vmware_sessionfile	Optional. Session file name enhancement.
vmware_sessionfiledir	Optional. Path to store the vmware_sessionfile file. Defaults to "/var/spool/icinga2/tmp".
vmware_nosession	Optional. No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
vmware_username	Optional. The username to connect to Host or vCenter server. No value defined as default.
vmware_password	Optional. The username's password. No value defined as default.
vmware_authfile	Optional. Use auth file instead username/password to session connect. No effect if vmware_username and vmware_password are defined Authentication file content: username=vmuser password=p@ssw0rd
vmware_exclude	Optional. Blacklist issues. No value defined as default.
vmware_include	Optional. Whitelist issues. No value defined as default.
vmware_isregexp	Optional. Treat blacklist and whitelist expressions as regexp.
vmware_multiline	Optional. Multiline output in overview. This mean technically that a multiline output uses a HTML <br> for the GUI. No value defined as default.

vmware-esx-dc-runtime-status

Check command object for the check_vmware_esx plugin. Overall object status (gray/green/red/yellow).

Custom variables passed as command parameters:

Name	Description
vmware_datacenter	Required. Datacenter/vCenter hostname.
vmware_cluster	Optional. ESX or ESXi clustername.
vmware_sslport	Optional. SSL port connection. Defaults to "443".
vmware_ignoreunknown	Optional. Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
vmware_ignorewarning	Optional. Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
vmware_timeout	Optional. Seconds before plugin times out. Defaults to "90".
vmware_trace	Optional. Set verbosity level of vSphere API request/respond trace.
vmware_sessionfile	Optional. Session file name enhancement.
vmware_sessionfiledir	Optional. Path to store the vmware_sessionfile file. Defaults to "/var/spool/icinga2/tmp".
vmware_nosession	Optional. No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
vmware_username	Optional. The username to connect to Host or vCenter server. No value defined as default.
vmware_password	Optional. The username's password. No value defined as default.
vmware_authfile	Optional. Use auth file instead username/password to session connect. No effect if vmware_username and vmware_password are defined Authentication file content: username=vmuser password=p@ssw0rd

vmware-esx-dc-runtime-tools

Check command object for the check_vmware_esx plugin. Vmware Tools status.

Custom variables passed as command parameters:

Name	Description
vmware_datacenter	Required. Datacenter/vCenter hostname.
vmware_cluster	Optional. ESX or ESXi clustername.
vmware_sslport	Optional. SSL port connection. Defaults to "443".
vmware_ignoreunknown	Optional. Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
vmware_ignorewarning	Optional. Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
vmware_timeout	Optional. Seconds before plugin times out. Defaults to "90".
vmware_trace	Optional. Set verbosity level of vSphere API request/respond trace.
vmware_sessionfile	Optional. Session file name enhancement.
vmware_sessionfiledir	Optional. Path to store the vmware_sessionfile file. Defaults to "/var/spool/icinga2/tmp".
vmware_nosession	Optional. No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
vmware_username	Optional. The username to connect to Host or vCenter server. No value defined as default.
vmware_password	Optional. The username's password. No value defined as default.
vmware_authfile	Optional. Use auth file instead username/password to session connect. No effect if vmware_username and vmware_password are defined Authentication file content: username=vmuser password=p@ssw0rd
vmware_poweredonly	Optional. List only VMs which are powered on. No value defined as default.
vmware_alertonly	Optional. List only alerting VMs. Important here to avoid masses of data.
vmware_exclude	Optional. Blacklist VMs. No value defined as default.
vmware_include	Optional. Whitelist VMs. No value defined as default.
vmware_isregexp	Optional. Treat blacklist and whitelist expressions as regexp.
vmware_multiline	Optional. Multiline output in overview. This mean technically that a multiline output uses a HTML <br> for the GUI. No value defined as default.
vmware_openvmtools	Optional Prevent CRITICAL state for installed and running Open VM Tools.
vmware_novmtools	Optional Prevent CRITICAL state for missing VMware tools.

vmware-esx-soap-host-check

Check command object for the check_vmware_esx plugin. Simple check to verify a successful connection to VMware SOAP API.

Custom variables passed as command parameters:

Name	Description
vmware_host	Required. ESX or ESXi hostname.
vmware_datacenter	Optional. Datacenter/vCenter hostname. In case the check is done through a Datacenter/vCenter host.
vmware_sslport	Optional. SSL port connection. Defaults to "443".
vmware_ignoreunknown	Optional. Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
vmware_ignorewarning	Optional. Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
vmware_timeout	Optional. Seconds before plugin times out. Defaults to "90".
vmware_trace	Optional. Set verbosity level of vSphere API request/respond trace.
vmware_sessionfile	Optional. Session file name enhancement.
vmware_sessionfiledir	Optional. Path to store the vmware_sessionfile file. Defaults to "/var/spool/icinga2/tmp".
vmware_nosession	Optional. No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
vmware_username	Optional. The username to connect to Host or vCenter server. No value defined as default.
vmware_password	Optional. The username's password. No value defined as default.
vmware_authfile	Optional. Use auth file instead username/password to session connect. No effect if vmware_username and vmware_password are defined Authentication file content: username=vmuser password=p@ssw0rd

vmware-esx-soap-host-uptime

Check command object for the check_vmware_esx plugin. Displays uptime of the VMware host.

Custom variables passed as command parameters:

Name	Description
vmware_host	Required. ESX or ESXi hostname.
vmware_datacenter	Optional. Datacenter/vCenter hostname. In case the check is done through a Datacenter/vCenter host.
vmware_sslport	Optional. SSL port connection. Defaults to "443".
vmware_ignoreunknown	Optional. Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
vmware_ignorewarning	Optional. Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
vmware_timeout	Optional. Seconds before plugin times out. Defaults to "90".
vmware_trace	Optional. Set verbosity level of vSphere API request/respond trace.
vmware_sessionfile	Optional. Session file name enhancement.
vmware_sessionfiledir	Optional. Path to store the vmware_sessionfile file. Defaults to "/var/spool/icinga2/tmp".
vmware_nosession	Optional. No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
vmware_username	Optional. The username to connect to Host or vCenter server. No value defined as default.
vmware_password	Optional. The username's password. No value defined as default.
vmware_authfile	Optional. Use auth file instead username/password to session connect. No effect if vmware_username and vmware_password are defined Authentication file content: username=vmuser password=p@ssw0rd

vmware-esx-soap-host-cpu

Check command object for the check_vmware_esx plugin. CPU usage in percentage.

Custom variables passed as command parameters:

Name	Description
vmware_host	Required. ESX or ESXi hostname.
vmware_datacenter	Optional. Datacenter/vCenter hostname. In case the check is done through a Datacenter/vCenter host.
vmware_sslport	Optional. SSL port connection. Defaults to "443".
vmware_ignoreunknown	Optional. Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
vmware_ignorewarning	Optional. Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
vmware_timeout	Optional. Seconds before plugin times out. Defaults to "90".
vmware_trace	Optional. Set verbosity level of vSphere API request/respond trace.
vmware_sessionfile	Optional. Session file name enhancement.
vmware_sessionfiledir	Optional. Path to store the vmware_sessionfile file. Defaults to "/var/spool/icinga2/tmp".
vmware_nosession	Optional. No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
vmware_username	Optional. The username to connect to Host or vCenter server. No value defined as default.
vmware_password	Optional. The username's password. No value defined as default.
vmware_authfile	Optional. Use auth file instead username/password to session connect. No effect if vmware_username and vmware_password are defined Authentication file content: username=vmuser password=p@ssw0rd
vmware_warn	Optional. The warning threshold in percent. Defaults to "80%".
vmware_crit	Optional. The critical threshold in percent. Defaults to "90%".

vmware-esx-soap-host-cpu-ready

Check command object for the check_vmware_esx plugin. Percentage of time that the virtual machine was ready, but could not get scheduled to run on the physical CPU. CPU ready time is dependent on the number of virtual machines on the host and their CPU loads. High or growing ready time can be a hint CPU bottlenecks.

Custom variables passed as command parameters:

Name	Description
vmware_host	Required. ESX or ESXi hostname.
vmware_datacenter	Optional. Datacenter/vCenter hostname. In case the check is done through a Datacenter/vCenter host.
vmware_sslport	Optional. SSL port connection. Defaults to "443".
vmware_ignoreunknown	Optional. Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
vmware_ignorewarning	Optional. Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
vmware_timeout	Optional. Seconds before plugin times out. Defaults to "90".
vmware_trace	Optional. Set verbosity level of vSphere API request/respond trace.
vmware_sessionfile	Optional. Session file name enhancement.
vmware_sessionfiledir	Optional. Path to store the vmware_sessionfile file. Defaults to "/var/spool/icinga2/tmp".
vmware_nosession	Optional. No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
vmware_username	Optional. The username to connect to Host or vCenter server. No value defined as default.
vmware_password	Optional. The username's password. No value defined as default.
vmware_authfile	Optional. Use auth file instead username/password to session connect. No effect if vmware_username and vmware_password are defined Authentication file content: username=vmuser password=p@ssw0rd

vmware-esx-soap-host-cpu-wait

Check command object for the check_vmware_esx plugin. CPU time spent in wait state. The wait total includes time spent the CPU idle, CPU swap wait, and CPU I/O wait states. High or growing wait time can be a hint I/O bottlenecks.

Custom variables passed as command parameters:

Name	Description
vmware_host	Required. ESX or ESXi hostname.
vmware_datacenter	Optional. Datacenter/vCenter hostname. In case the check is done through a Datacenter/vCenter host.
vmware_sslport	Optional. SSL port connection. Defaults to "443".
vmware_ignoreunknown	Optional. Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
vmware_ignorewarning	Optional. Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
vmware_timeout	Optional. Seconds before plugin times out. Defaults to "90".
vmware_trace	Optional. Set verbosity level of vSphere API request/respond trace.
vmware_sessionfile	Optional. Session file name enhancement.
vmware_sessionfiledir	Optional. Path to store the vmware_sessionfile file. Defaults to "/var/spool/icinga2/tmp".
vmware_nosession	Optional. No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
vmware_username	Optional. The username to connect to Host or vCenter server. No value defined as default.
vmware_password	Optional. The username's password. No value defined as default.
vmware_authfile	Optional. Use auth file instead username/password to session connect. No effect if vmware_username and vmware_password are defined Authentication file content: username=vmuser password=p@ssw0rd

vmware-esx-soap-host-cpu-usage

Check command object for the check_vmware_esx plugin. Actively used CPU of the host, as a percentage of the total available CPU. Active CPU is approximately equal to the ratio of the used CPU to the available CPU.

Custom variables passed as command parameters:

Name	Description
vmware_host	Required. ESX or ESXi hostname.
vmware_datacenter	Optional. Datacenter/vCenter hostname. In case the check is done through a Datacenter/vCenter host.
vmware_sslport	Optional. SSL port connection. Defaults to "443".
vmware_ignoreunknown	Optional. Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
vmware_ignorewarning	Optional. Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
vmware_timeout	Optional. Seconds before plugin times out. Defaults to "90".
vmware_trace	Optional. Set verbosity level of vSphere API request/respond trace.
vmware_sessionfile	Optional. Session file name enhancement.
vmware_sessionfiledir	Optional. Path to store the vmware_sessionfile file. Defaults to "/var/spool/icinga2/tmp".
vmware_nosession	Optional. No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
vmware_username	Optional. The username to connect to Host or vCenter server. No value defined as default.
vmware_password	Optional. The username's password. No value defined as default.
vmware_authfile	Optional. Use auth file instead username/password to session connect. No effect if vmware_username and vmware_password are defined Authentication file content: username=vmuser password=p@ssw0rd
vmware_warn	Optional. The warning threshold in percent. Defaults to "80%".
vmware_crit	Optional. The critical threshold in percent. Defaults to "90%".

vmware-esx-soap-host-mem

Check command object for the check_vmware_esx plugin. All mem info(except overall and no thresholds).

Custom variables passed as command parameters:

Name	Description
vmware_host	Required. ESX or ESXi hostname.
vmware_datacenter	Optional. Datacenter/vCenter hostname. In case the check is done through a Datacenter/vCenter host.
vmware_sslport	Optional. SSL port connection. Defaults to "443".
vmware_ignoreunknown	Optional. Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
vmware_ignorewarning	Optional. Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
vmware_timeout	Optional. Seconds before plugin times out. Defaults to "90".
vmware_trace	Optional. Set verbosity level of vSphere API request/respond trace.
vmware_sessionfile	Optional. Session file name enhancement.
vmware_sessionfiledir	Optional. Path to store the vmware_sessionfile file. Defaults to "/var/spool/icinga2/tmp".
vmware_nosession	Optional. No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
vmware_username	Optional. The username to connect to Host or vCenter server. No value defined as default.
vmware_password	Optional. The username's password. No value defined as default.
vmware_authfile	Optional. Use auth file instead username/password to session connect. No effect if vmware_username and vmware_password are defined Authentication file content: username=vmuser password=p@ssw0rd

vmware-esx-soap-host-mem-usage

Check command object for the check_vmware_esx plugin. Average mem usage in percentage.

Custom variables passed as command parameters:

Name	Description
vmware_host	Required. ESX or ESXi hostname.
vmware_datacenter	Optional. Datacenter/vCenter hostname. In case the check is done through a Datacenter/vCenter host.
vmware_sslport	Optional. SSL port connection. Defaults to "443".
vmware_ignoreunknown	Optional. Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
vmware_ignorewarning	Optional. Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
vmware_timeout	Optional. Seconds before plugin times out. Defaults to "90".
vmware_trace	Optional. Set verbosity level of vSphere API request/respond trace.
vmware_sessionfile	Optional. Session file name enhancement.
vmware_sessionfiledir	Optional. Path to store the vmware_sessionfile file. Defaults to "/var/spool/icinga2/tmp".
vmware_nosession	Optional. No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
vmware_username	Optional. The username to connect to Host or vCenter server. No value defined as default.
vmware_password	Optional. The username's password. No value defined as default.
vmware_authfile	Optional. Use auth file instead username/password to session connect. No effect if vmware_username and vmware_password are defined Authentication file content: username=vmuser password=p@ssw0rd
vmware_warn	Optional. The warning threshold in percent. Defaults to "80%".
vmware_crit	Optional. The critical threshold in percent. Defaults to "90%".

vmware-esx-soap-host-mem-consumed

Check command object for the check_vmware_esx plugin. Amount of machine memory used on the host. Consumed memory includes Includes memory used by the Service Console, the VMkernel vSphere services, plus the total consumed metrics for all running virtual machines in MB.

Custom variables passed as command parameters:

Name	Description
vmware_host	Required. ESX or ESXi hostname.
vmware_datacenter	Optional. Datacenter/vCenter hostname. In case the check is done through a Datacenter/vCenter host.
vmware_sslport	Optional. SSL port connection. Defaults to "443".
vmware_ignoreunknown	Optional. Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
vmware_ignorewarning	Optional. Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
vmware_timeout	Optional. Seconds before plugin times out. Defaults to "90".
vmware_trace	Optional. Set verbosity level of vSphere API request/respond trace.
vmware_sessionfile	Optional. Session file name enhancement.
vmware_sessionfiledir	Optional. Path to store the vmware_sessionfile file. Defaults to "/var/spool/icinga2/tmp".
vmware_nosession	Optional. No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
vmware_username	Optional. The username to connect to Host or vCenter server. No value defined as default.
vmware_password	Optional. The username's password. No value defined as default.
vmware_authfile	Optional. Use auth file instead username/password to session connect. No effect if vmware_username and vmware_password are defined Authentication file content: username=vmuser password=p@ssw0rd
vmware_warn	Optional. The warning threshold in percent. No value defined as default.
vmware_crit	Optional. The critical threshold in percent. No value defined as default.

vmware-esx-soap-host-mem-swapused

Check command object for the check_vmware_esx plugin. Amount of memory that is used by swap. Sum of memory swapped of all powered on VMs and vSphere services on the host in MB. In case of an error all VMs with their swap used will be displayed.

Custom variables passed as command parameters:

Name	Description
vmware_host	Required. ESX or ESXi hostname.
vmware_datacenter	Optional. Datacenter/vCenter hostname. In case the check is done through a Datacenter/vCenter host.
vmware_sslport	Optional. SSL port connection. Defaults to "443".
vmware_ignoreunknown	Optional. Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
vmware_ignorewarning	Optional. Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
vmware_timeout	Optional. Seconds before plugin times out. Defaults to "90".
vmware_trace	Optional. Set verbosity level of vSphere API request/respond trace.
vmware_sessionfile	Optional. Session file name enhancement.
vmware_sessionfiledir	Optional. Path to store the vmware_sessionfile file. Defaults to "/var/spool/icinga2/tmp".
vmware_nosession	Optional. No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
vmware_username	Optional. The username to connect to Host or vCenter server. No value defined as default.
vmware_password	Optional. The username's password. No value defined as default.
vmware_authfile	Optional. Use auth file instead username/password to session connect. No effect if vmware_username and vmware_password are defined Authentication file content: username=vmuser password=p@ssw0rd
vmware_warn	Optional. The warning threshold in percent. No value defined as default.
vmware_crit	Optional. The critical threshold in percent. No value defined as default.
vmware_multiline	Optional. Multiline output in overview. This mean technically that a multiline output uses a HTML <br> for the GUI. No value defined as default.

vmware-esx-soap-host-mem-overhead

Check command object for the check_vmware_esx plugin. Additional mem used by VM Server in MB.

Custom variables passed as command parameters:

Name	Description
vmware_host	Required. ESX or ESXi hostname.
vmware_datacenter	Optional. Datacenter/vCenter hostname. In case the check is done through a Datacenter/vCenter host.
vmware_sslport	Optional. SSL port connection. Defaults to "443".
vmware_ignoreunknown	Optional. Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
vmware_ignorewarning	Optional. Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
vmware_timeout	Optional. Seconds before plugin times out. Defaults to "90".
vmware_trace	Optional. Set verbosity level of vSphere API request/respond trace.
vmware_sessionfile	Optional. Session file name enhancement.
vmware_sessionfiledir	Optional. Path to store the vmware_sessionfile file. Defaults to "/var/spool/icinga2/tmp".
vmware_nosession	Optional. No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
vmware_username	Optional. The username to connect to Host or vCenter server. No value defined as default.
vmware_password	Optional. The username's password. No value defined as default.
vmware_authfile	Optional. Use auth file instead username/password to session connect. No effect if vmware_username and vmware_password are defined Auhentication file content: username=vmuser password=p@ssw0rd
vmware_warn	Optional. The warning threshold in percent. No value defined as default.
vmware_crit	Optional. The critical threshold in percent. No value defined as default.

vmware-esx-soap-host-mem-memctl

Check command object for the check_vmware_esx plugin. The sum of all vmmemctl values in MB for all powered-on virtual machines, plus vSphere services on the host. If the balloon target value is greater than the balloon value, the VMkernel inflates the balloon, causing more virtual machine memory to be reclaimed. If the balloon target value is less than the balloon value, the VMkernel deflates the balloon, which allows the virtual machine to consume additional memory if needed (used by VM memory control driver). In case of an error all VMs with their vmmemctl values will be displayed.

Custom variables passed as command parameters:

Name	Description
vmware_host	Required. ESX or ESXi hostname.
vmware_datacenter	Optional. Datacenter/vCenter hostname. In case the check is done through a Datacenter/vCenter host.
vmware_sslport	Optional. SSL port connection. Defaults to "443".
vmware_ignoreunknown	Optional. Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
vmware_ignorewarning	Optional. Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
vmware_timeout	Optional. Seconds before plugin times out. Defaults to "90".
vmware_trace	Optional. Set verbosity level of vSphere API request/respond trace.
vmware_sessionfile	Optional. Session file name enhancement.
vmware_sessionfiledir	Optional. Path to store the vmware_sessionfile file. Defaults to "/var/spool/icinga2/tmp".
vmware_nosession	Optional. No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
vmware_username	Optional. The username to connect to Host or vCenter server. No value defined as default.
vmware_password	Optional. The username's password. No value defined as default.
vmware_authfile	Optional. Use auth file instead username/password to session connect. No effect if vmware_username and vmware_password are defined Authentication file content: username=vmuser password=p@ssw0rd
vmware_warn	Optional. The warning threshold in percent. No value defined as default.
vmware_crit	Optional. The critical threshold in percent. No value defined as default.
vmware_multiline	Optional. Multiline output in overview. This mean technically that a multiline output uses a HTML <br> for the GUI. No value defined as default.

vmware-esx-soap-host-net

Check command object for the check_vmware_esx plugin. Shows net info.

Custom variables passed as command parameters:

Name	Description
vmware_host	Required. ESX or ESXi hostname.
vmware_datacenter	Optional. Datacenter/vCenter hostname. In case the check is done through a Datacenter/vCenter host.
vmware_sslport	Optional. SSL port connection. Defaults to "443".
vmware_ignoreunknown	Optional. Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
vmware_ignorewarning	Optional. Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
vmware_timeout	Optional. Seconds before plugin times out. Defaults to "90".
vmware_trace	Optional. Set verbosity level of vSphere API request/respond trace.
vmware_sessionfile	Optional. Session file name enhancement.
vmware_sessionfiledir	Optional. Path to store the vmware_sessionfile file. Defaults to "/var/spool/icinga2/tmp".
vmware_nosession	Optional. No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
vmware_username	Optional. The username to connect to Host or vCenter server. No value defined as default.
vmware_password	Optional. The username's password. No value defined as default.
vmware_authfile	Optional. Use auth file instead username/password to session connect. No effect if vmware_username and vmware_password are defined Authentication file content: username=vmuser password=p@ssw0rd
vmware_exclude	Optional. Blacklist NICs. No value defined as default.
vmware_isregexp	Optional. Treat blacklist expression as regexp.

vmware-esx-soap-host-net-usage

Check command object for the check_vmware_esx plugin. Overall network usage in KBps(Kilobytes per Second).

Custom variables passed as command parameters:

Name	Description
vmware_host	Required. ESX or ESXi hostname.
vmware_datacenter	Optional. Datacenter/vCenter hostname. In case the check is done through a Datacenter/vCenter host.
vmware_sslport	Optional. SSL port connection. Defaults to "443".
vmware_ignoreunknown	Optional. Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
vmware_ignorewarning	Optional. Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
vmware_timeout	Optional. Seconds before plugin times out. Defaults to "90".
vmware_trace	Optional. Set verbosity level of vSphere API request/respond trace.
vmware_sessionfile	Optional. Session file name enhancement.
vmware_sessionfiledir	Optional. Path to store the vmware_sessionfile file. Defaults to "/var/spool/icinga2/tmp".
vmware_nosession	Optional. No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
vmware_username	Optional. The username to connect to Host or vCenter server. No value defined as default.
vmware_password	Optional. The username's password. No value defined as default.
vmware_authfile	Optional. Use auth file instead username/password to session connect. No effect if vmware_username and vmware_password are defined Authentication file content: username=vmuser password=p@ssw0rd
vmware_warn	Optional. The warning threshold in KBps(Kilobytes per Second). No value defined as default.
vmware_crit	Optional. The critical threshold in KBps(Kilobytes per Second). No value defined as default.

vmware-esx-soap-host-net-receive

Check command object for the check_vmware_esx plugin. Data receive in KBps(Kilobytes per Second).

Custom variables passed as command parameters:

Name	Description
vmware_host	Required. ESX or ESXi hostname.
vmware_datacenter	Optional. Datacenter/vCenter hostname. In case the check is done through a Datacenter/vCenter host.
vmware_sslport	Optional. SSL port connection. Defaults to "443".
vmware_ignoreunknown	Optional. Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
vmware_ignorewarning	Optional. Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
vmware_timeout	Optional. Seconds before plugin times out. Defaults to "90".
vmware_trace	Optional. Set verbosity level of vSphere API request/respond trace.
vmware_sessionfile	Optional. Session file name enhancement.
vmware_sessionfiledir	Optional. Path to store the vmware_sessionfile file. Defaults to "/var/spool/icinga2/tmp".
vmware_nosession	Optional. No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
vmware_username	Optional. The username to connect to Host or vCenter server. No value defined as default.
vmware_password	Optional. The username's password. No value defined as default.
vmware_authfile	Optional. Use auth file instead username/password to session connect. No effect if vmware_username and vmware_password are defined Authentication file content: username=vmuser password=p@ssw0rd
vmware_warn	Optional. The warning threshold in KBps(Kilobytes per Second). No value defined as default.
vmware_crit	Optional. The critical threshold in KBps(Kilobytes per Second). No value defined as default.

vmware-esx-soap-host-net-send

Check command object for the check_vmware_esx plugin. Data send in KBps(Kilobytes per Second).

Custom variables passed as command parameters:

Name	Description
vmware_host	Required. ESX or ESXi hostname.
vmware_datacenter	Optional. Datacenter/vCenter hostname. In case the check is done through a Datacenter/vCenter host.
vmware_sslport	Optional. SSL port connection. Defaults to "443".
vmware_ignoreunknown	Optional. Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
vmware_ignorewarning	Optional. Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
vmware_timeout	Optional. Seconds before plugin times out. Defaults to "90".
vmware_trace	Optional. Set verbosity level of vSphere API request/respond trace.
vmware_sessionfile	Optional. Session file name enhancement.
vmware_sessionfiledir	Optional. Path to store the vmware_sessionfile file. Defaults to "/var/spool/icinga2/tmp".
vmware_nosession	Optional. No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
vmware_username	Optional. The username to connect to Host or vCenter server. No value defined as default.
vmware_password	Optional. The username's password. No value defined as default.
vmware_authfile	Optional. Use auth file instead username/password to session connect. No effect if vmware_username and vmware_password are defined Authentication file content: username=vmuser password=p@ssw0rd
vmware_warn	Optional. The warning threshold in KBps(Kilobytes per Second). No value defined as default.
vmware_crit	Optional. The critical threshold in KBps(Kilobytes per Second). No value defined as default.

vmware-esx-soap-host-net-nic

Check command object for the check_vmware_esx plugin. Check all active NICs.

Custom variables passed as command parameters:

Name	Description
vmware_host	Required. ESX or ESXi hostname.
vmware_datacenter	Optional. Datacenter/vCenter hostname. In case the check is done through a Datacenter/vCenter host.
vmware_sslport	Optional. SSL port connection. Defaults to "443".
vmware_ignoreunknown	Optional. Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
vmware_ignorewarning	Optional. Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
vmware_timeout	Optional. Seconds before plugin times out. Defaults to "90".
vmware_trace	Optional. Set verbosity level of vSphere API request/respond trace.
vmware_sessionfile	Optional. Session file name enhancement.
vmware_sessionfiledir	Optional. Path to store the vmware_sessionfile file. Defaults to "/var/spool/icinga2/tmp".
vmware_nosession	Optional. No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
vmware_username	Optional. The username to connect to Host or vCenter server. No value defined as default.
vmware_password	Optional. The username's password. No value defined as default.
vmware_authfile	Optional. Use auth file instead username/password to session connect. No effect if vmware_username and vmware_password are defined Authentication file content: username=vmuser password=p@ssw0rd
vmware_exclude	Optional. Blacklist NICs. No value defined as default.
vmware_isregexp	Optional. Treat blacklist expression as regexp.

vmware-esx-soap-host-volumes

Check command object for the check_vmware_esx plugin. Shows all datastore volumes info.

Custom variables passed as command parameters:

Name	Description
vmware_host	Required. ESX or ESXi hostname.
vmware_datacenter	Optional. Datacenter/vCenter hostname. In case the check is done through a Datacenter/vCenter host.
vmware_sslport	Optional. SSL port connection. Defaults to "443".
vmware_ignoreunknown	Optional. Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
vmware_ignorewarning	Optional. Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
vmware_timeout	Optional. Seconds before plugin times out. Defaults to "90".
vmware_trace	Optional. Set verbosity level of vSphere API request/respond trace.
vmware_sessionfile	Optional. Session file name enhancement.
vmware_sessionfiledir	Optional. Path to store the vmware_sessionfile file. Defaults to "/var/spool/icinga2/tmp".
vmware_nosession	Optional. No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
vmware_username	Optional. The username to connect to Host or vCenter server. No value defined as default.
vmware_password	Optional. The username's password. No value defined as default.
vmware_authfile	Optional. Use auth file instead username/password to session connect. No effect if vmware_username and vmware_password are defined Authentication file content: username=vmuser password=p@ssw0rd
vmware_subselect	Optional. Volume name to be checked the free space.
vmware_gigabyte	Optional. Output in GB instead of MB.
vmware_usedspace	Optional. Output used space instead of free. Defaults to "false".
vmware_alertonly	Optional. List only alerting volumes. Defaults to "false".
vmware_exclude	Optional. Blacklist volumes name. No value defined as default.
vmware_include	Optional. Whitelist volumes name. No value defined as default.
vmware_isregexp	Optional. Treat blacklist and whitelist expressions as regexp.
vmware_warn	Optional. The warning threshold for volumes. Defaults to "80%".
vmware_crit	Optional. The critical threshold for volumes. Defaults to "90%".
vmware_spaceleft	Optional. This has to be used in conjunction with thresholds as mentioned above.

vmware-esx-soap-host-io

Check command object for the check_vmware_esx plugin. Shows all disk io info. Without subselect no thresholds can be given. All I/O values are aggregated from historical intervals over the past 24 hours with a 5 minute sample rate.

Custom variables passed as command parameters:

Name	Description
vmware_host	Required. ESX or ESXi hostname.
vmware_datacenter	Optional. Datacenter/vCenter hostname. In case the check is done through a Datacenter/vCenter host.
vmware_sslport	Optional. SSL port connection. Defaults to "443".
vmware_ignoreunknown	Optional. Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
vmware_ignorewarning	Optional. Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
vmware_timeout	Optional. Seconds before plugin times out. Defaults to "90".
vmware_trace	Optional. Set verbosity level of vSphere API request/respond trace.
vmware_sessionfile	Optional. Session file name enhancement.
vmware_sessionfiledir	Optional. Path to store the vmware_sessionfile file. Defaults to "/var/spool/icinga2/tmp".
vmware_nosession	Optional. No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
vmware_username	Optional. The username to connect to Host or vCenter server. No value defined as default.
vmware_password	Optional. The username's password. No value defined as default.
vmware_authfile	Optional. Use auth file instead username/password to session connect. No effect if vmware_username and vmware_password are defined Authentication file content: username=vmuser password=p@ssw0rd

vmware-esx-soap-host-io-aborted

Check command object for the check_vmware_esx plugin. Number of aborted SCSI commands.

Custom variables passed as command parameters:

Name	Description
vmware_host	Required. ESX or ESXi hostname.
vmware_datacenter	Optional. Datacenter/vCenter hostname. In case the check is done through a Datacenter/vCenter host.
vmware_sslport	Optional. SSL port connection. Defaults to "443".
vmware_ignoreunknown	Optional. Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
vmware_ignorewarning	Optional. Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
vmware_timeout	Optional. Seconds before plugin times out. Defaults to "90".
vmware_trace	Optional. Set verbosity level of vSphere API request/respond trace.
vmware_sessionfile	Optional. Session file name enhancement.
vmware_sessionfiledir	Optional. Path to store the vmware_sessionfile file. Defaults to "/var/spool/icinga2/tmp".
vmware_nosession	Optional. No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
vmware_username	Optional. The username to connect to Host or vCenter server. No value defined as default.
vmware_password	Optional. The username's password. No value defined as default.
vmware_authfile	Optional. Use auth file instead username/password to session connect. No effect if vmware_username and vmware_password are defined Authentication file content: username=vmuser password=p@ssw0rd
vmware_warn	Optional. The warning threshold. No value defined as default.
vmware_crit	Optional. The critical threshold. No value defined as default.

vmware-esx-soap-host-io-resets

Check command object for the check_vmware_esx plugin. Number of SCSI bus resets.

Custom variables passed as command parameters:

Name	Description
vmware_host	Required. ESX or ESXi hostname.
vmware_datacenter	Optional. Datacenter/vCenter hostname. In case the check is done through a Datacenter/vCenter host.
vmware_sslport	Optional. SSL port connection. Defaults to "443".
vmware_ignoreunknown	Optional. Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
vmware_ignorewarning	Optional. Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
vmware_timeout	Optional. Seconds before plugin times out. Defaults to "90".
vmware_trace	Optional. Set verbosity level of vSphere API request/respond trace.
vmware_sessionfile	Optional. Session file name enhancement.
vmware_sessionfiledir	Optional. Path to store the vmware_sessionfile file. Defaults to "/var/spool/icinga2/tmp".
vmware_nosession	Optional. No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
vmware_username	Optional. The username to connect to Host or vCenter server. No value defined as default.
vmware_password	Optional. The username's password. No value defined as default.
vmware_authfile	Optional. Use auth file instead username/password to session connect. No effect if vmware_username and vmware_password are defined Authentication file content: username=vmuser password=p@ssw0rd
vmware_warn	Optional. The warning threshold. No value defined as default.
vmware_crit	Optional. The critical threshold. No value defined as default.

vmware-esx-soap-host-io-read

Check command object for the check_vmware_esx plugin. Average number of kilobytes read from the disk each second.

Custom variables passed as command parameters:

Name	Description
vmware_host	Required. ESX or ESXi hostname.
vmware_datacenter	Optional. Datacenter/vCenter hostname. In case the check is done through a Datacenter/vCenter host.
vmware_sslport	Optional. SSL port connection. Defaults to "443".
vmware_ignoreunknown	Optional. Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
vmware_ignorewarning	Optional. Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
vmware_timeout	Optional. Seconds before plugin times out. Defaults to "90".
vmware_trace	Optional. Set verbosity level of vSphere API request/respond trace.
vmware_sessionfile	Optional. Session file name enhancement.
vmware_sessionfiledir	Optional. Path to store the vmware_sessionfile file. Defaults to "/var/spool/icinga2/tmp".
vmware_nosession	Optional. No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
vmware_username	Optional. The username to connect to Host or vCenter server. No value defined as default.
vmware_password	Optional. The username's password. No value defined as default.
vmware_authfile	Optional. Use auth file instead username/password to session connect. No effect if vmware_username and vmware_password are defined Authentication file content: username=vmuser password=p@ssw0rd
vmware_warn	Optional. The warning threshold. No value defined as default.
vmware_crit	Optional. The critical threshold. No value defined as default.

vmware-esx-soap-host-io-read-latency

Check command object for the check_vmware_esx plugin. Average amount of time (ms) to process a SCSI read command issued from the Guest OS to the virtual machine.

Custom variables passed as command parameters:

Name	Description
vmware_host	Required. ESX or ESXi hostname.
vmware_datacenter	Optional. Datacenter/vCenter hostname. In case the check is done through a Datacenter/vCenter host.
vmware_sslport	Optional. SSL port connection. Defaults to "443".
vmware_ignoreunknown	Optional. Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
vmware_ignorewarning	Optional. Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
vmware_timeout	Optional. Seconds before plugin times out. Defaults to "90".
vmware_trace	Optional. Set verbosity level of vSphere API request/respond trace.
vmware_sessionfile	Optional. Session file name enhancement.
vmware_sessionfiledir	Optional. Path to store the vmware_sessionfile file. Defaults to "/var/spool/icinga2/tmp".
vmware_nosession	Optional. No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
vmware_username	Optional. The username to connect to Host or vCenter server. No value defined as default.
vmware_password	Optional. The username's password. No value defined as default.
vmware_authfile	Optional. Use auth file instead username/password to session connect. No effect if vmware_username and vmware_password are defined Authentication file content: username=vmuser password=p@ssw0rd
vmware_warn	Optional. The warning threshold. No value defined as default.
vmware_crit	Optional. The critical threshold. No value defined as default.

vmware-esx-soap-host-io-write

Check command object for the check_vmware_esx plugin. Average number of kilobytes written to disk each second.

Custom variables passed as command parameters:

Name	Description
vmware_host	Required. ESX or ESXi hostname.
vmware_datacenter	Optional. Datacenter/vCenter hostname. In case the check is done through a Datacenter/vCenter host.
vmware_sslport	Optional. SSL port connection. Defaults to "443".
vmware_ignoreunknown	Optional. Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
vmware_ignorewarning	Optional. Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
vmware_timeout	Optional. Seconds before plugin times out. Defaults to "90".
vmware_trace	Optional. Set verbosity level of vSphere API request/respond trace.
vmware_sessionfile	Optional. Session file name enhancement.
vmware_sessionfiledir	Optional. Path to store the vmware_sessionfile file. Defaults to "/var/spool/icinga2/tmp".
vmware_nosession	Optional. No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
vmware_username	Optional. The username to connect to Host or vCenter server. No value defined as default.
vmware_password	Optional. The username's password. No value defined as default.
vmware_authfile	Optional. Use auth file instead username/password to session connect. No effect if vmware_username and vmware_password are defined Authentication file content: username=vmuser password=p@ssw0rd
vmware_warn	Optional. The warning threshold. No value defined as default.
vmware_crit	Optional. The critical threshold. No value defined as default.

vmware-esx-soap-host-io-write-latency

Check command object for the check_vmware_esx plugin. Average amount of time (ms) taken to process a SCSI write command issued by the Guest OS to the virtual machine.

Custom variables passed as command parameters:

Name	Description
vmware_host	Required. ESX or ESXi hostname.
vmware_datacenter	Optional. Datacenter/vCenter hostname. In case the check is done through a Datacenter/vCenter host.
vmware_sslport	Optional. SSL port connection. Defaults to "443".
vmware_ignoreunknown	Optional. Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
vmware_ignorewarning	Optional. Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
vmware_timeout	Optional. Seconds before plugin times out. Defaults to "90".
vmware_trace	Optional. Set verbosity level of vSphere API request/respond trace.
vmware_sessionfile	Optional. Session file name enhancement.
vmware_sessionfiledir	Optional. Path to store the vmware_sessionfile file. Defaults to "/var/spool/icinga2/tmp".
vmware_nosession	Optional. No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
vmware_username	Optional. The username to connect to Host or vCenter server. No value defined as default.
vmware_password	Optional. The username's password. No value defined as default.
vmware_authfile	Optional. Use auth file instead username/password to session connect. No effect if vmware_username and vmware_password are defined Authentication file content: username=vmuser password=p@ssw0rd
vmware_warn	Optional. The warning threshold. No value defined as default.
vmware_crit	Optional. The critical threshold. No value defined as default.

vmware-esx-soap-host-io-usage

Check command object for the check_vmware_esx plugin. Aggregated disk I/O rate. For hosts, this metric includes the rates for all virtual machines running on the host.

Custom variables passed as command parameters:

Name	Description
vmware_host	Required. ESX or ESXi hostname.
vmware_datacenter	Optional. Datacenter/vCenter hostname. In case the check is done through a Datacenter/vCenter host.
vmware_sslport	Optional. SSL port connection. Defaults to "443".
vmware_ignoreunknown	Optional. Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
vmware_ignorewarning	Optional. Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
vmware_timeout	Optional. Seconds before plugin times out. Defaults to "90".
vmware_trace	Optional. Set verbosity level of vSphere API request/respond trace.
vmware_sessionfile	Optional. Session file name enhancement.
vmware_sessionfiledir	Optional. Path to store the vmware_sessionfile file. Defaults to "/var/spool/icinga2/tmp".
vmware_nosession	Optional. No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
vmware_username	Optional. The username to connect to Host or vCenter server. No value defined as default.
vmware_password	Optional. The username's password. No value defined as default.
vmware_authfile	Optional. Use auth file instead username/password to session connect. No effect if vmware_username and vmware_password are defined Authentication file content: username=vmuser password=p@ssw0rd
vmware_warn	Optional. The warning threshold. No value defined as default.
vmware_crit	Optional. The critical threshold. No value defined as default.

vmware-esx-soap-host-io-kernel-latency

Check command object for the check_vmware_esx plugin. Average amount of time (ms) spent by VMkernel processing each SCSI command.

Custom variables passed as command parameters:

Name	Description
vmware_host	Required. ESX or ESXi hostname.
vmware_datacenter	Optional. Datacenter/vCenter hostname. In case the check is done through a Datacenter/vCenter host.
vmware_sslport	Optional. SSL port connection. Defaults to "443".
vmware_ignoreunknown	Optional. Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
vmware_ignorewarning	Optional. Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
vmware_timeout	Optional. Seconds before plugin times out. Defaults to "90".
vmware_trace	Optional. Set verbosity level of vSphere API request/respond trace.
vmware_sessionfile	Optional. Session file name enhancement.
vmware_sessionfiledir	Optional. Path to store the vmware_sessionfile file. Defaults to "/var/spool/icinga2/tmp".
vmware_nosession	Optional. No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
vmware_username	Optional. The username to connect to Host or vCenter server. No value defined as default.
vmware_password	Optional. The username's password. No value defined as default.
vmware_authfile	Optional. Use auth file instead username/password to session connect. No effect if vmware_username and vmware_password are defined Authentication file content: username=vmuser password=p@ssw0rd
vmware_warn	Optional. The warning threshold. No value defined as default.
vmware_crit	Optional. The critical threshold. No value defined as default.

vmware-esx-soap-host-io-device-latency

Check command object for the check_vmware_esx plugin. Average amount of time (ms) to complete a SCSI command from the physical device.

Custom variables passed as command parameters:

Name	Description
vmware_host	Required. ESX or ESXi hostname.
vmware_datacenter	Optional. Datacenter/vCenter hostname. In case the check is done through a Datacenter/vCenter host.
vmware_sslport	Optional. SSL port connection. Defaults to "443".
vmware_ignoreunknown	Optional. Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
vmware_ignorewarning	Optional. Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
vmware_timeout	Optional. Seconds before plugin times out. Defaults to "90".
vmware_trace	Optional. Set verbosity level of vSphere API request/respond trace.
vmware_sessionfile	Optional. Session file name enhancement.
vmware_sessionfiledir	Optional. Path to store the vmware_sessionfile file. Defaults to "/var/spool/icinga2/tmp".
vmware_nosession	Optional. No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
vmware_username	Optional. The username to connect to Host or vCenter server. No value defined as default.
vmware_password	Optional. The username's password. No value defined as default.
vmware_authfile	Optional. Use auth file instead username/password to session connect. No effect if vmware_username and vmware_password are defined Authentication file content: username=vmuser password=p@ssw0rd
vmware_warn	Optional. The warning threshold. No value defined as default.
vmware_crit	Optional. The critical threshold. No value defined as default.

vmware-esx-soap-host-io-queue-latency

Check command object for the check_vmware_esx plugin. Average amount of time (ms) spent in the VMkernel queue.

Custom variables passed as command parameters:

Name	Description
vmware_host	Required. ESX or ESXi hostname.
vmware_datacenter	Optional. Datacenter/vCenter hostname. In case the check is done through a Datacenter/vCenter host.
vmware_sslport	Optional. SSL port connection. Defaults to "443".
vmware_ignoreunknown	Optional. Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
vmware_ignorewarning	Optional. Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
vmware_timeout	Optional. Seconds before plugin times out. Defaults to "90".
vmware_trace	Optional. Set verbosity level of vSphere API request/respond trace.
vmware_sessionfile	Optional. Session file name enhancement.
vmware_sessionfiledir	Optional. Path to store the vmware_sessionfile file. Defaults to "/var/spool/icinga2/tmp".
vmware_nosession	Optional. No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
vmware_username	Optional. The username to connect to Host or vCenter server. No value defined as default.
vmware_password	Optional. The username's password. No value defined as default.
vmware_authfile	Optional. Use auth file instead username/password to session connect. No effect if vmware_username and vmware_password are defined Authentication file content: username=vmuser password=p@ssw0rd
vmware_warn	Optional. The warning threshold. No value defined as default.
vmware_crit	Optional. The critical threshold. No value defined as default.

vmware-esx-soap-host-io-total-latency

Check command object for the check_vmware_esx plugin. Average amount of time (ms) taken during the collection interval to process a SCSI command issued by the guest OS to the virtual machine. The sum of kernelWriteLatency and deviceWriteLatency.

Custom variables passed as command parameters:

Name	Description
vmware_host	Required. ESX or ESXi hostname.
vmware_datacenter	Optional. Datacenter/vCenter hostname. In case the check is done through a Datacenter/vCenter host.
vmware_sslport	Optional. SSL port connection. Defaults to "443".
vmware_ignoreunknown	Optional. Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
vmware_ignorewarning	Optional. Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
vmware_timeout	Optional. Seconds before plugin times out. Defaults to "90".
vmware_trace	Optional. Set verbosity level of vSphere API request/respond trace.
vmware_sessionfile	Optional. Session file name enhancement.
vmware_sessionfiledir	Optional. Path to store the vmware_sessionfile file. Defaults to "/var/spool/icinga2/tmp".
vmware_nosession	Optional. No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
vmware_username	Optional. The username to connect to Host or vCenter server. No value defined as default.
vmware_password	Optional. The username's password. No value defined as default.
vmware_authfile	Optional. Use auth file instead username/password to session connect. No effect if vmware_username and vmware_password are defined Authentication file content: username=vmuser password=p@ssw0rd
vmware_warn	Optional. The warning threshold. No value defined as default.
vmware_crit	Optional. The critical threshold. No value defined as default.

vmware-esx-soap-host-media

Check command object for the check_vmware_esx plugin. List vm's with attached host mounted media like cd,dvd or floppy drives. This is important for monitoring because a virtual machine with a mount cd or dvd drive can not be moved to another host.

Custom variables passed as command parameters:

Name	Description
vmware_host	Required. ESX or ESXi hostname.
vmware_datacenter	Optional. Datacenter/vCenter hostname. In case the check is done through a Datacenter/vCenter host.
vmware_sslport	Optional. SSL port connection. Defaults to "443".
vmware_ignoreunknown	Optional. Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
vmware_ignorewarning	Optional. Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
vmware_timeout	Optional. Seconds before plugin times out. Defaults to "90".
vmware_trace	Optional. Set verbosity level of vSphere API request/respond trace.
vmware_sessionfile	Optional. Session file name enhancement.
vmware_sessionfiledir	Optional. Path to store the vmware_sessionfile file. Defaults to "/var/spool/icinga2/tmp".
vmware_nosession	Optional. No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
vmware_username	Optional. The username to connect to Host or vCenter server. No value defined as default.
vmware_password	Optional. The username's password. No value defined as default.
vmware_authfile	Optional. Use auth file instead username/password to session connect. No effect if vmware_username and vmware_password are defined Authentication file content: username=vmuser password=p@ssw0rd
vmware_exclude	Optional. Blacklist VMs name. No value defined as default.
vmware_include	Optional. Whitelist VMs name. No value defined as default.
vmware_isregexp	Optional. Treat blacklist and whitelist expressions as regexp.
vmware_multiline	Optional. Multiline output in overview. This mean technically that a multiline output uses a HTML <br> for the GUI. No value defined as default.

vmware-esx-soap-host-service

Check command object for the check_vmware_esx plugin. Shows host service info.

Custom variables passed as command parameters:

Name	Description
vmware_host	Required. ESX or ESXi hostname.
vmware_datacenter	Optional. Datacenter/vCenter hostname. In case the check is done through a Datacenter/vCenter host.
vmware_sslport	Optional. SSL port connection. Defaults to "443".
vmware_ignoreunknown	Optional. Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
vmware_ignorewarning	Optional. Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
vmware_timeout	Optional. Seconds before plugin times out. Defaults to "90".
vmware_trace	Optional. Set verbosity level of vSphere API request/respond trace.
vmware_sessionfile	Optional. Session file name enhancement.
vmware_sessionfiledir	Optional. Path to store the vmware_sessionfile file. Defaults to "/var/spool/icinga2/tmp".
vmware_nosession	Optional. No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
vmware_username	Optional. The username to connect to Host or vCenter server. No value defined as default.
vmware_password	Optional. The username's password. No value defined as default.
vmware_authfile	Optional. Use auth file instead username/password to session connect. No effect if vmware_username and vmware_password are defined Authentication file content: username=vmuser password=p@ssw0rd
vmware_exclude	Optional. Blacklist services name. No value defined as default.
vmware_include	Optional. Whitelist services name. No value defined as default.
vmware_isregexp	Optional. Treat blacklist and whitelist expressions as regexp.
vmware_multiline	Optional. Multiline output in overview. This mean technically that a multiline output uses a HTML <br> for the GUI. No value defined as default.

vmware-esx-soap-host-runtime

Check command object for the check_vmware_esx plugin. Shows runtime info: VMs, overall status, connection state, health, storagehealth, temperature and sensor are represented as one value and without thresholds.

Custom variables passed as command parameters:

Name	Description
vmware_host	Required. ESX or ESXi hostname.
vmware_datacenter	Optional. Datacenter/vCenter hostname. In case the check is done through a Datacenter/vCenter host.
vmware_sslport	Optional. SSL port connection. Defaults to "443".
vmware_ignoreunknown	Optional. Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
vmware_ignorewarning	Optional. Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
vmware_timeout	Optional. Seconds before plugin times out. Defaults to "90".
vmware_trace	Optional. Set verbosity level of vSphere API request/respond trace.
vmware_sessionfile	Optional. Session file name enhancement.
vmware_sessionfiledir	Optional. Path to store the vmware_sessionfile file. Defaults to "/var/spool/icinga2/tmp".
vmware_nosession	Optional. No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
vmware_username	Optional. The username to connect to Host or vCenter server. No value defined as default.
vmware_password	Optional. The username's password. No value defined as default.
vmware_authfile	Optional. Use auth file instead username/password to session connect. No effect if vmware_username and vmware_password are defined Authentication file content: username=vmuser password=p@ssw0rd
vmware_exclude	Optional. Blacklist VMs name. No value defined as default.
vmware_include	Optional. Whitelist VMs name. No value defined as default.
vmware_isregexp	Optional. Treat blacklist and whitelist expressions as regexp.

vmware-esx-soap-host-runtime-con

Check command object for the check_vmware_esx plugin. Shows connection state.

Custom variables passed as command parameters:

Name	Description
vmware_host	Required. ESX or ESXi hostname.
vmware_datacenter	Optional. Datacenter/vCenter hostname. In case the check is done through a Datacenter/vCenter host.
vmware_sslport	Optional. SSL port connection. Defaults to "443".
vmware_ignoreunknown	Optional. Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
vmware_ignorewarning	Optional. Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
vmware_timeout	Optional. Seconds before plugin times out. Defaults to "90".
vmware_trace	Optional. Set verbosity level of vSphere API request/respond trace.
vmware_sessionfile	Optional. Session file name enhancement.
vmware_sessionfiledir	Optional. Path to store the vmware_sessionfile file. Defaults to "/var/spool/icinga2/tmp".
vmware_nosession	Optional. No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
vmware_username	Optional. The username to connect to Host or vCenter server. No value defined as default.
vmware_password	Optional. The username's password. No value defined as default.
vmware_authfile	Optional. Use auth file instead username/password to session connect. No effect if vmware_username and vmware_password are defined Authentication file content: username=vmuser password=p@ssw0rd

vmware-esx-soap-host-runtime-listvms

Check command object for the check_vmware_esx plugin. List of VMware machines and their status.

Custom variables passed as command parameters:

Name	Description
vmware_host	Required. ESX or ESXi hostname.
vmware_datacenter	Optional. Datacenter/vCenter hostname. In case the check is done through a Datacenter/vCenter host.
vmware_sslport	Optional. SSL port connection. Defaults to "443".
vmware_ignoreunknown	Optional. Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
vmware_ignorewarning	Optional. Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
vmware_timeout	Optional. Seconds before plugin times out. Defaults to "90".
vmware_trace	Optional. Set verbosity level of vSphere API request/respond trace.
vmware_sessionfile	Optional. Session file name enhancement.
vmware_sessionfiledir	Optional. Path to store the vmware_sessionfile file. Defaults to "/var/spool/icinga2/tmp".
vmware_nosession	Optional. No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
vmware_username	Optional. The username to connect to Host or vCenter server. No value defined as default.
vmware_password	Optional. The username's password. No value defined as default.
vmware_authfile	Optional. Use auth file instead username/password to session connect. No effect if vmware_username and vmware_password are defined Authentication file content: username=vmuser password=p@ssw0rd
vmware_exclude	Optional. Blacklist VMs name. No value defined as default.
vmware_include	Optional. Whitelist VMs name. No value defined as default.
vmware_isregexp	Optional. Treat blacklist and whitelist expressions as regexp.
vmware_multiline	Optional. Multiline output in overview. This mean technically that a multiline output uses a HTML <br> for the GUI. No value defined as default.

vmware-esx-soap-host-runtime-status

Check command object for the check_vmware_esx plugin. Overall object status (gray/green/red/yellow).

Custom variables passed as command parameters:

Name	Description
vmware_host	Required. ESX or ESXi hostname.
vmware_datacenter	Optional. Datacenter/vCenter hostname. In case the check is done through a Datacenter/vCenter host.
vmware_sslport	Optional. SSL port connection. Defaults to "443".
vmware_ignoreunknown	Optional. Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
vmware_ignorewarning	Optional. Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
vmware_timeout	Optional. Seconds before plugin times out. Defaults to "90".
vmware_trace	Optional. Set verbosity level of vSphere API request/respond trace.
vmware_sessionfile	Optional. Session file name enhancement.
vmware_sessionfiledir	Optional. Path to store the vmware_sessionfile file. Defaults to "/var/spool/icinga2/tmp".
vmware_nosession	Optional. No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
vmware_username	Optional. The username to connect to Host or vCenter server. No value defined as default.
vmware_password	Optional. The username's password. No value defined as default.
vmware_authfile	Optional. Use auth file instead username/password to session connect. No effect if vmware_username and vmware_password are defined Authentication file content: username=vmuser password=p@ssw0rd

vmware-esx-soap-host-runtime-health

Check command object for the check_vmware_esx plugin. Checks cpu/storage/memory/sensor status.

Custom variables passed as command parameters:

Name	Description
vmware_host	Required. ESX or ESXi hostname.
vmware_datacenter	Optional. Datacenter/vCenter hostname. In case the check is done through a Datacenter/vCenter host.
vmware_sslport	Optional. SSL port connection. Defaults to "443".
vmware_ignoreunknown	Optional. Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
vmware_ignorewarning	Optional. Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
vmware_timeout	Optional. Seconds before plugin times out. Defaults to "90".
vmware_trace	Optional. Set verbosity level of vSphere API request/respond trace.
vmware_sessionfile	Optional. Session file name enhancement.
vmware_sessionfiledir	Optional. Path to store the vmware_sessionfile file. Defaults to "/var/spool/icinga2/tmp".
vmware_nosession	Optional. No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
vmware_username	Optional. The username to connect to Host or vCenter server. No value defined as default.
vmware_password	Optional. The username's password. No value defined as default.
vmware_authfile	Optional. Use auth file instead username/password to session connect. No effect if vmware_username and vmware_password are defined Authentication file content: username=vmuser password=p@ssw0rd
vmware_exclude	Optional. Blacklist status name. No value defined as default.
vmware_include	Optional. Whitelist status name. No value defined as default.
vmware_isregexp	Optional. Treat blacklist and whitelist expressions as regexp.

vmware-esx-soap-host-runtime-health-listsensors

Check command object for the check_vmware_esx plugin. List all available sensors(use for listing purpose only).

Custom variables passed as command parameters:

Name	Description
vmware_host	Required. ESX or ESXi hostname.
vmware_datacenter	Optional. Datacenter/vCenter hostname. In case the check is done through a Datacenter/vCenter host.
vmware_sslport	Optional. SSL port connection. Defaults to "443".
vmware_ignoreunknown	Optional. Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
vmware_ignorewarning	Optional. Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
vmware_timeout	Optional. Seconds before plugin times out. Defaults to "90".
vmware_trace	Optional. Set verbosity level of vSphere API request/respond trace.
vmware_sessionfile	Optional. Session file name enhancement.
vmware_sessionfiledir	Optional. Path to store the vmware_sessionfile file. Defaults to "/var/spool/icinga2/tmp".
vmware_nosession	Optional. No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
vmware_username	Optional. The username to connect to Host or vCenter server. No value defined as default.
vmware_password	Optional. The username's password. No value defined as default.
vmware_authfile	Optional. Use auth file instead username/password to session connect. No effect if vmware_username and vmware_password are defined Authentication file content: username=vmuser password=p@ssw0rd
vmware_exclude	Optional. Blacklist status name. No value defined as default.
vmware_include	Optional. Whitelist status name. No value defined as default.
vmware_isregexp	Optional. Treat blacklist and whitelist expressions as regexp.

vmware-esx-soap-host-runtime-health-nostoragestatus

Check command object for the check_vmware_esx plugin. This is to avoid a double alarm if you use vmware-esx-soap-host-runtime-health and vmware-esx-soap-host-runtime-storagehealth.

Custom variables passed as command parameters:

Name	Description
vmware_host	Required. ESX or ESXi hostname.
vmware_datacenter	Optional. Datacenter/vCenter hostname. In case the check is done through a Datacenter/vCenter host.
vmware_sslport	Optional. SSL port connection. Defaults to "443".
vmware_ignoreunknown	Optional. Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
vmware_ignorewarning	Optional. Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
vmware_timeout	Optional. Seconds before plugin times out. Defaults to "90".
vmware_trace	Optional. Set verbosity level of vSphere API request/respond trace.
vmware_sessionfile	Optional. Session file name enhancement.
vmware_sessionfiledir	Optional. Path to store the vmware_sessionfile file. Defaults to "/var/spool/icinga2/tmp".
vmware_nosession	Optional. No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
vmware_username	Optional. The username to connect to Host or vCenter server. No value defined as default.
vmware_password	Optional. The username's password. No value defined as default.
vmware_authfile	Optional. Use auth file instead username/password to session connect. No effect if vmware_username and vmware_password are defined Authentication file content: username=vmuser password=p@ssw0rd
vmware_exclude	Optional. Blacklist status name. No value defined as default.
vmware_include	Optional. Whitelist status name. No value defined as default.
vmware_isregexp	Optional. Treat blacklist and whitelist expressions as regexp.

vmware-esx-soap-host-runtime-storagehealth

Check command object for the check_vmware_esx plugin. Local storage status check.

Custom variables passed as command parameters:

Name	Description
vmware_host	Required. ESX or ESXi hostname.
vmware_datacenter	Optional. Datacenter/vCenter hostname. In case the check is done through a Datacenter/vCenter host.
vmware_sslport	Optional. SSL port connection. Defaults to "443".
vmware_ignoreunknown	Optional. Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
vmware_ignorewarning	Optional. Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
vmware_timeout	Optional. Seconds before plugin times out. Defaults to "90".
vmware_trace	Optional. Set verbosity level of vSphere API request/respond trace.
vmware_sessionfile	Optional. Session file name enhancement.
vmware_sessionfiledir	Optional. Path to store the vmware_sessionfile file. Defaults to "/var/spool/icinga2/tmp".
vmware_nosession	Optional. No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
vmware_username	Optional. The username to connect to Host or vCenter server. No value defined as default.
vmware_password	Optional. The username's password. No value defined as default.
vmware_authfile	Optional. Use auth file instead username/password to session connect. No effect if vmware_username and vmware_password are defined Authentication file content: username=vmuser password=p@ssw0rd
vmware_exclude	Optional. Blacklist storage name. No value defined as default.
vmware_include	Optional. Whitelist storage name. No value defined as default.
vmware_isregexp	Optional. Treat blacklist and whitelist expressions as regexp.
vmware_multiline	Optional. Multiline output in overview. This mean technically that a multiline output uses a HTML <br> for the GUI. No value defined as default.

vmware-esx-soap-host-runtime-temp

Check command object for the check_vmware_esx plugin. Lists all temperature sensors.

Custom variables passed as command parameters:

Name	Description
vmware_host	Required. ESX or ESXi hostname.
vmware_datacenter	Optional. Datacenter/vCenter hostname. In case the check is done through a Datacenter/vCenter host.
vmware_sslport	Optional. SSL port connection. Defaults to "443".
vmware_ignoreunknown	Optional. Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
vmware_ignorewarning	Optional. Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
vmware_timeout	Optional. Seconds before plugin times out. Defaults to "90".
vmware_trace	Optional. Set verbosity level of vSphere API request/respond trace.
vmware_sessionfile	Optional. Session file name enhancement.
vmware_sessionfiledir	Optional. Path to store the vmware_sessionfile file. Defaults to "/var/spool/icinga2/tmp".
vmware_nosession	Optional. No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
vmware_username	Optional. The username to connect to Host or vCenter server. No value defined as default.
vmware_password	Optional. The username's password. No value defined as default.
vmware_authfile	Optional. Use auth file instead username/password to session connect. No effect if vmware_username and vmware_password are defined Authentication file content: username=vmuser password=p@ssw0rd
vmware_exclude	Optional. Blacklist sensor name. No value defined as default.
vmware_include	Optional. Whitelist sensor name. No value defined as default.
vmware_isregexp	Optional. Treat blacklist and whitelist expressions as regexp.
vmware_multiline	Optional. Multiline output in overview. This mean technically that a multiline output uses a HTML <br> for the GUI. No value defined as default.

vmware-esx-soap-host-runtime-issues

Check command object for the check_vmware_esx plugin. Lists all configuration issues for the host.

Custom variables passed as command parameters:

Name	Description
vmware_host	Required. ESX or ESXi hostname.
vmware_datacenter	Optional. Datacenter/vCenter hostname. In case the check is done through a Datacenter/vCenter host.
vmware_sslport	Optional. SSL port connection. Defaults to "443".
vmware_ignoreunknown	Optional. Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
vmware_ignorewarning	Optional. Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
vmware_timeout	Optional. Seconds before plugin times out. Defaults to "90".
vmware_trace	Optional. Set verbosity level of vSphere API request/respond trace.
vmware_sessionfile	Optional. Session file name enhancement.
vmware_sessionfiledir	Optional. Path to store the vmware_sessionfile file. Defaults to "/var/spool/icinga2/tmp".
vmware_nosession	Optional. No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
vmware_username	Optional. The username to connect to Host or vCenter server. No value defined as default.
vmware_password	Optional. The username's password. No value defined as default.
vmware_authfile	Optional. Use auth file instead username/password to session connect. No effect if vmware_username and vmware_password are defined Authentication file content: username=vmuser password=p@ssw0rd
vmware_exclude	Optional. Blacklist configuration issues. No value defined as default.
vmware_include	Optional. Whitelist configuration issues. No value defined as default.
vmware_isregexp	Optional. Treat blacklist and whitelist expressions as regexp.
vmware_multiline	Optional. Multiline output in overview. This mean technically that a multiline output uses a HTML <br> for the GUI. No value defined as default.

vmware-esx-soap-host-storage

Check command object for the check_vmware_esx plugin. Shows Host storage info.

Custom variables passed as command parameters:

Name	Description
vmware_host	Required. ESX or ESXi hostname.
vmware_datacenter	Optional. Datacenter/vCenter hostname. In case the check is done through a Datacenter/vCenter host.
vmware_sslport	Optional. SSL port connection. Defaults to "443".
vmware_ignoreunknown	Optional. Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
vmware_ignorewarning	Optional. Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
vmware_timeout	Optional. Seconds before plugin times out. Defaults to "90".
vmware_trace	Optional. Set verbosity level of vSphere API request/respond trace.
vmware_sessionfile	Optional. Session file name enhancement.
vmware_sessionfiledir	Optional. Path to store the vmware_sessionfile file. Defaults to "/var/spool/icinga2/tmp".
vmware_nosession	Optional. No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
vmware_username	Optional. The username to connect to Host or vCenter server. No value defined as default.
vmware_password	Optional. The username's password. No value defined as default.
vmware_authfile	Optional. Use auth file instead username/password to session connect. No effect if vmware_username and vmware_password are defined Authentication file content: username=vmuser password=p@ssw0rd
vmware_exclude	Optional. Blacklist adapters, luns and paths. No value defined as default.
vmware_include	Optional. Whitelist adapters, luns and paths. No value defined as default.
vmware_isregexp	Optional. Treat blacklist and whitelist expressions as regexp.

vmware-esx-soap-host-storage-adapter

Check command object for the check_vmware_esx plugin. List host bus adapters.

Custom variables passed as command parameters:

Name	Description
vmware_host	Required. ESX or ESXi hostname.
vmware_datacenter	Optional. Datacenter/vCenter hostname. In case the check is done through a Datacenter/vCenter host.
vmware_sslport	Optional. SSL port connection. Defaults to "443".
vmware_ignoreunknown	Optional. Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
vmware_ignorewarning	Optional. Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
vmware_timeout	Optional. Seconds before plugin times out. Defaults to "90".
vmware_trace	Optional. Set verbosity level of vSphere API request/respond trace.
vmware_sessionfile	Optional. Session file name enhancement.
vmware_sessionfiledir	Optional. Path to store the vmware_sessionfile file. Defaults to "/var/spool/icinga2/tmp".
vmware_nosession	Optional. No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
vmware_username	Optional. The username to connect to Host or vCenter server. No value defined as default.
vmware_password	Optional. The username's password. No value defined as default.
vmware_authfile	Optional. Use auth file instead username/password to session connect. No effect if vmware_username and vmware_password are defined Authentication file content: username=vmuser password=p@ssw0rd
vmware_exclude	Optional. Blacklist adapters. No value defined as default.
vmware_include	Optional. Whitelist adapters. No value defined as default.
vmware_isregexp	Optional. Treat blacklist and whitelist expressions as regexp.
vmware_multiline	Optional. Multiline output in overview. This mean technically that a multiline output uses a HTML <br> for the GUI. No value defined as default.

vmware-esx-soap-host-storage-lun

Check command object for the check_vmware_esx plugin. List SCSI logical units. The listing will include: LUN, canonical name of the disc, all of displayed name which is not part of the canonical name and status.

Custom variables passed as command parameters:

Name	Description
vmware_host	Required. ESX or ESXi hostname.
vmware_datacenter	Optional. Datacenter/vCenter hostname. In case the check is done through a Datacenter/vCenter host.
vmware_sslport	Optional. SSL port connection. Defaults to "443".
vmware_ignoreunknown	Optional. Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
vmware_ignorewarning	Optional. Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
vmware_timeout	Optional. Seconds before plugin times out. Defaults to "90".
vmware_trace	Optional. Set verbosity level of vSphere API request/respond trace.
vmware_sessionfile	Optional. Session file name enhancement.
vmware_sessionfiledir	Optional. Path to store the vmware_sessionfile file. Defaults to "/var/spool/icinga2/tmp".
vmware_nosession	Optional. No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
vmware_username	Optional. The username to connect to Host or vCenter server. No value defined as default.
vmware_password	Optional. The username's password. No value defined as default.
vmware_authfile	Optional. Use auth file instead username/password to session connect. No effect if vmware_username and vmware_password are defined Authentication file content: username=vmuser password=p@ssw0rd
vmware_exclude	Optional. Blacklist luns. No value defined as default.
vmware_include	Optional. Whitelist luns. No value defined as default.
vmware_isregexp	Optional. Treat blacklist and whitelist expressions as regexp.
vmware_multiline	Optional. Multiline output in overview. This mean technically that a multiline output uses a HTML <br> for the GUI. No value defined as default.

vmware-esx-soap-host-storage-path

Check command object for the check_vmware_esx plugin. List multipaths and the associated paths.

Custom variables passed as command parameters:

Name	Description
vmware_host	Required. ESX or ESXi hostname.
vmware_datacenter	Optional. Datacenter/vCenter hostname. In case the check is done through a Datacenter/vCenter host.
vmware_sslport	Optional. SSL port connection. Defaults to "443".
vmware_ignoreunknown	Optional. Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
vmware_ignorewarning	Optional. Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
vmware_timeout	Optional. Seconds before plugin times out. Defaults to "90".
vmware_trace	Optional. Set verbosity level of vSphere API request/respond trace.
vmware_sessionfile	Optional. Session file name enhancement.
vmware_sessionfiledir	Optional. Path to store the vmware_sessionfile file. Defaults to "/var/spool/icinga2/tmp".
vmware_nosession	Optional. No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
vmware_username	Optional. The username to connect to Host or vCenter server. No value defined as default.
vmware_password	Optional. The username's password. No value defined as default.
vmware_authfile	Optional. Use auth file instead username/password to session connect. No effect if vmware_username and vmware_password are defined Authentication file content: username=vmuser password=p@ssw0rd
vmware_alertonly	Optional. List only alerting units. Important here to avoid masses of data. Defaults to "false".
vmware_exclude	Optional. Blacklist paths. No value defined as default.
vmware_include	Optional. Whitelist paths. No value defined as default.
vmware_isregexp	Optional. Treat blacklist and whitelist expressions as regexp.
vmware_multiline	Optional. Multiline output in overview. This mean technically that a multiline output uses a HTML <br> for the GUI. No value defined as default.
vmware_standbyok	Optional. For storage systems where a standby multipath is ok and not a warning. Defaults to false.

vmware-esx-soap-vm-cpu

Check command object for the check_vmware_esx plugin. Shows all CPU usage info.

Custom variables passed as command parameters:

Name	Description
vmware_datacenter	Optional. Datacenter/vCenter hostname. Conflicts with vmware_host.
vmware_host	Optional. ESX or ESXi hostname. Conflicts with vmware_datacenter.
vmware_vmname	Required. Virtual machine name.
vmware_sslport	Optional. SSL port connection. Defaults to "443".
vmware_ignoreunknown	Optional. Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
vmware_ignorewarning	Optional. Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
vmware_timeout	Optional. Seconds before plugin times out. Defaults to "90".
vmware_trace	Optional. Set verbosity level of vSphere API request/respond trace.
vmware_sessionfile	Optional. Session file name enhancement.
vmware_sessionfiledir	Optional. Path to store the vmware_sessionfile file. Defaults to "/var/spool/icinga2/tmp".
vmware_nosession	Optional. No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
vmware_username	Optional. The username to connect to Host or vCenter server. No value defined as default.
vmware_password	Optional. The username's password. No value defined as default.
vmware_authfile	Optional. Use auth file instead username/password to session connect. No effect if vmware_username and vmware_password are defined Authentication file content: username=vmuser password=p@ssw0rd

vmware-esx-soap-vm-cpu-ready

Check command object for the check_vmware_esx plugin. Percentage of time that the virtual machine was ready, but could not get scheduled to run on the physical CPU.

Custom variables passed as command parameters:

Name	Description
vmware_datacenter	Optional. Datacenter/vCenter hostname. Conflicts with vmware_host.
vmware_host	Optional. ESX or ESXi hostname. Conflicts with vmware_datacenter.
vmware_vmname	Required. Virtual machine name.
vmware_sslport	Optional. SSL port connection. Defaults to "443".
vmware_ignoreunknown	Optional. Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
vmware_ignorewarning	Optional. Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
vmware_timeout	Optional. Seconds before plugin times out. Defaults to "90".
vmware_trace	Optional. Set verbosity level of vSphere API request/respond trace.
vmware_sessionfile	Optional. Session file name enhancement.
vmware_sessionfiledir	Optional. Path to store the vmware_sessionfile file. Defaults to "/var/spool/icinga2/tmp".
vmware_nosession	Optional. No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
vmware_username	Optional. The username to connect to Host or vCenter server. No value defined as default.
vmware_password	Optional. The username's password. No value defined as default.
vmware_authfile	Optional. Use auth file instead username/password to session connect. No effect if vmware_username and vmware_password are defined Authentication file content: username=vmuser password=p@ssw0rd
vmware_warn	Optional. The warning threshold. No value defined as default.
vmware_crit	Optional. The critical threshold. No value defined as default.

vmware-esx-soap-vm-cpu-wait

Check command object for the check_vmware_esx plugin. CPU time spent in wait state. The wait total includes time spent the CPU idle, CPU swap wait, and CPU I/O wait states. High or growing wait time can be a hint I/O bottlenecks.

Custom variables passed as command parameters:

Name	Description
vmware_datacenter	Optional. Datacenter/vCenter hostname. Conflicts with vmware_host.
vmware_host	Optional. ESX or ESXi hostname. Conflicts with vmware_datacenter.
vmware_vmname	Required. Virtual machine name.
vmware_sslport	Optional. SSL port connection. Defaults to "443".
vmware_ignoreunknown	Optional. Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
vmware_ignorewarning	Optional. Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
vmware_timeout	Optional. Seconds before plugin times out. Defaults to "90".
vmware_trace	Optional. Set verbosity level of vSphere API request/respond trace.
vmware_sessionfile	Optional. Session file name enhancement.
vmware_sessionfiledir	Optional. Path to store the vmware_sessionfile file. Defaults to "/var/spool/icinga2/tmp".
vmware_nosession	Optional. No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
vmware_username	Optional. The username to connect to Host or vCenter server. No value defined as default.
vmware_password	Optional. The username's password. No value defined as default.
vmware_authfile	Optional. Use auth file instead username/password to session connect. No effect if vmware_username and vmware_password are defined Authentication file content: username=vmuser password=p@ssw0rd
vmware_warn	Optional. The warning threshold. No value defined as default.
vmware_crit	Optional. The critical threshold. No value defined as default.

vmware-esx-soap-vm-cpu-usage

Check command object for the check_vmware_esx plugin. Amount of actively used virtual CPU, as a percentage of total available CPU. This is the host's view of the CPU usage, not the guest operating system view. It is the average CPU utilization over all available virtual CPUs in the virtual machine.

Custom variables passed as command parameters:

Name	Description
vmware_datacenter	Optional. Datacenter/vCenter hostname. Conflicts with vmware_host.
vmware_host	Optional. ESX or ESXi hostname. Conflicts with vmware_datacenter.
vmware_vmname	Required. Virtual machine name.
vmware_sslport	Optional. SSL port connection. Defaults to "443".
vmware_ignoreunknown	Optional. Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
vmware_ignorewarning	Optional. Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
vmware_timeout	Optional. Seconds before plugin times out. Defaults to "90".
vmware_trace	Optional. Set verbosity level of vSphere API request/respond trace.
vmware_sessionfile	Optional. Session file name enhancement.
vmware_sessionfiledir	Optional. Path to store the vmware_sessionfile file. Defaults to "/var/spool/icinga2/tmp".
vmware_nosession	Optional. No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
vmware_username	Optional. The username to connect to Host or vCenter server. No value defined as default.
vmware_password	Optional. The username's password. No value defined as default.
vmware_authfile	Optional. Use auth file instead username/password to session connect. No effect if vmware_username and vmware_password are defined Authentication file content: username=vmuser password=p@ssw0rd
vmware_warn	Optional. Warning threshold in percent. Defaults to "80%".
vmware_crit	Optional. Critical threshold in percent. Defaults to "90%".

vmware-esx-soap-vm-mem

Check command object for the check_vmware_esx plugin. Shows all memory info, except overall.

Custom variables passed as command parameters:

Name	Description
vmware_datacenter	Optional. Datacenter/vCenter hostname. Conflicts with vmware_host.
vmware_host	Optional. ESX or ESXi hostname. Conflicts with vmware_datacenter.
vmware_vmname	Required. Virtual machine name.
vmware_sslport	Optional. SSL port connection. Defaults to "443".
vmware_ignoreunknown	Optional. Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
vmware_ignorewarning	Optional. Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
vmware_timeout	Optional. Seconds before plugin times out. Defaults to "90".
vmware_trace	Optional. Set verbosity level of vSphere API request/respond trace.
vmware_sessionfile	Optional. Session file name enhancement.
vmware_sessionfiledir	Optional. Path to store the vmware_sessionfile file. Defaults to "/var/spool/icinga2/tmp".
vmware_nosession	Optional. No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
vmware_username	Optional. The username to connect to Host or vCenter server. No value defined as default.
vmware_password	Optional. The username's password. No value defined as default.
vmware_authfile	Optional. Use auth file instead username/password to session connect. No effect if vmware_username and vmware_password are defined Authentication file content: username=vmuser password=p@ssw0rd

vmware-esx-soap-vm-mem-usage

Check command object for the check_vmware_esx plugin. Average mem usage in percentage of configured virtual machine "physical" memory.

Custom variables passed as command parameters:

Name	Description
vmware_datacenter	Optional. Datacenter/vCenter hostname. Conflicts with vmware_host.
vmware_host	Optional. ESX or ESXi hostname. Conflicts with vmware_datacenter.
vmware_vmname	Required. Virtual machine name.
vmware_sslport	Optional. SSL port connection. Defaults to "443".
vmware_ignoreunknown	Optional. Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
vmware_ignorewarning	Optional. Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
vmware_timeout	Optional. Seconds before plugin times out. Defaults to "90".
vmware_trace	Optional. Set verbosity level of vSphere API request/respond trace.
vmware_sessionfile	Optional. Session file name enhancement.
vmware_sessionfiledir	Optional. Path to store the vmware_sessionfile file. Defaults to "/var/spool/icinga2/tmp".
vmware_nosession	Optional. No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
vmware_username	Optional. The username to connect to Host or vCenter server. No value defined as default.
vmware_password	Optional. The username's password. No value defined as default.
vmware_authfile	Optional. Use auth file instead username/password to session connect. No effect if vmware_username and vmware_password are defined Authentication file content: username=vmuser password=p@ssw0rd
vmware_warn	Optional. Warning threshold in percent. Defaults to "80%".
vmware_crit	Optional. Critical threshold in percent. Defaults to "90%".

vmware-esx-soap-vm-mem-consumed

Check command object for the check_vmware_esx plugin. Amount of guest physical memory in MB consumed by the virtual machine for guest memory. Consumed memory does not include overhead memory. It includes shared memory and memory that might be reserved, but not actually used. Use this metric for charge-back purposes.
vm consumed memory = memory granted -- memory saved

Custom variables passed as command parameters:

Name	Description
vmware_datacenter	Optional. Datacenter/vCenter hostname. Conflicts with vmware_host.
vmware_host	Optional. ESX or ESXi hostname. Conflicts with vmware_datacenter.
vmware_vmname	Required. Virtual machine name.
vmware_sslport	Optional. SSL port connection. Defaults to "443".
vmware_ignoreunknown	Optional. Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
vmware_ignorewarning	Optional. Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
vmware_timeout	Optional. Seconds before plugin times out. Defaults to "90".
vmware_trace	Optional. Set verbosity level of vSphere API request/respond trace.
vmware_sessionfile	Optional. Session file name enhancement.
vmware_sessionfiledir	Optional. Path to store the vmware_sessionfile file. Defaults to "/var/spool/icinga2/tmp".
vmware_nosession	Optional. No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
vmware_username	Optional. The username to connect to Host or vCenter server. No value defined as default.
vmware_password	Optional. The username's password. No value defined as default.
vmware_authfile	Optional. Use auth file instead username/password to session connect. No effect if vmware_username and vmware_password are defined Authentication file content: username=vmuser password=p@ssw0rd
vmware_warn	Optional. The warning threshold. No value defined as default.
vmware_crit	Optional. The critical threshold. No value defined as default.

vmware-esx-soap-vm-mem-memctl

Check command object for the check_vmware_esx plugin. Amount of guest physical memory that is currently reclaimed from the virtual machine through ballooning. This is the amount of guest physical memory that has been allocated and pinned by the balloon driver.

Custom variables passed as command parameters:

Name	Description
vmware_datacenter	Optional. Datacenter/vCenter hostname. Conflicts with vmware_host.
vmware_host	Optional. ESX or ESXi hostname. Conflicts with vmware_datacenter.
vmware_vmname	Required. Virtual machine name.
vmware_sslport	Optional. SSL port connection. Defaults to "443".
vmware_ignoreunknown	Optional. Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
vmware_ignorewarning	Optional. Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
vmware_timeout	Optional. Seconds before plugin times out. Defaults to "90".
vmware_trace	Optional. Set verbosity level of vSphere API request/respond trace.
vmware_sessionfile	Optional. Session file name enhancement.
vmware_sessionfiledir	Optional. Path to store the vmware_sessionfile file. Defaults to "/var/spool/icinga2/tmp".
vmware_nosession	Optional. No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
vmware_username	Optional. The username to connect to Host or vCenter server. No value defined as default.
vmware_password	Optional. The username's password. No value defined as default.
vmware_authfile	Optional. Use auth file instead username/password to session connect. No effect if vmware_username and vmware_password are defined Authentication file content: username=vmuser password=p@ssw0rd
vmware_warn	Optional. The warning threshold. No value defined as default.
vmware_crit	Optional. The critical threshold. No value defined as default.

vmware-esx-soap-vm-net

Check command object for the check_vmware_esx plugin. Shows net info.

Custom variables passed as command parameters:

Name	Description
vmware_datacenter	Optional. Datacenter/vCenter hostname. Conflicts with vmware_host.
vmware_host	Optional. ESX or ESXi hostname. Conflicts with vmware_datacenter.
vmware_vmname	Required. Virtual machine name.
vmware_sslport	Optional. SSL port connection. Defaults to "443".
vmware_ignoreunknown	Optional. Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
vmware_ignorewarning	Optional. Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
vmware_timeout	Optional. Seconds before plugin times out. Defaults to "90".
vmware_trace	Optional. Set verbosity level of vSphere API request/respond trace.
vmware_sessionfile	Optional. Session file name enhancement.
vmware_sessionfiledir	Optional. Path to store the vmware_sessionfile file. Defaults to "/var/spool/icinga2/tmp".
vmware_nosession	Optional. No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
vmware_username	Optional. The username to connect to Host or vCenter server. No value defined as default.
vmware_password	Optional. The username's password. No value defined as default.
vmware_authfile	Optional. Use auth file instead username/password to session connect. No effect if vmware_username and vmware_password are defined Authentication file content: username=vmuser password=p@ssw0rd

vmware-esx-soap-vm-net-usage

Check command object for the check_vmware_esx plugin. Overall network usage in KBps(Kilobytes per Second).

Custom variables passed as command parameters:

Name	Description
vmware_datacenter	Optional. Datacenter/vCenter hostname. Conflicts with vmware_host.
vmware_host	Optional. ESX or ESXi hostname. Conflicts with vmware_datacenter.
vmware_vmname	Required. Virtual machine name.
vmware_sslport	Optional. SSL port connection. Defaults to "443".
vmware_ignoreunknown	Optional. Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
vmware_ignorewarning	Optional. Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
vmware_timeout	Optional. Seconds before plugin times out. Defaults to "90".
vmware_trace	Optional. Set verbosity level of vSphere API request/respond trace.
vmware_sessionfile	Optional. Session file name enhancement.
vmware_sessionfiledir	Optional. Path to store the vmware_sessionfile file. Defaults to "/var/spool/icinga2/tmp".
vmware_nosession	Optional. No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
vmware_username	Optional. The username to connect to Host or vCenter server. No value defined as default.
vmware_password	Optional. The username's password. No value defined as default.
vmware_authfile	Optional. Use auth file instead username/password to session connect. No effect if vmware_username and vmware_password are defined Authentication file content: username=vmuser password=p@ssw0rd
vmware_warn	Optional. The warning threshold. No value defined as default.
vmware_crit	Optional. The critical threshold. No value defined as default.

vmware-esx-soap-vm-net-receive

Check command object for the check_vmware_esx plugin. Receive in KBps(Kilobytes per Second).

Custom variables passed as command parameters:

Name	Description
vmware_datacenter	Optional. Datacenter/vCenter hostname. Conflicts with vmware_host.
vmware_host	Optional. ESX or ESXi hostname. Conflicts with vmware_datacenter.
vmware_vmname	Required. Virtual machine name.
vmware_sslport	Optional. SSL port connection. Defaults to "443".
vmware_ignoreunknown	Optional. Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
vmware_ignorewarning	Optional. Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
vmware_timeout	Optional. Seconds before plugin times out. Defaults to "90".
vmware_trace	Optional. Set verbosity level of vSphere API request/respond trace.
vmware_sessionfile	Optional. Session file name enhancement.
vmware_sessionfiledir	Optional. Path to store the vmware_sessionfile file. Defaults to "/var/spool/icinga2/tmp".
vmware_nosession	Optional. No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
vmware_username	Optional. The username to connect to Host or vCenter server. No value defined as default.
vmware_password	Optional. The username's password. No value defined as default.
vmware_authfile	Optional. Use auth file instead username/password to session connect. No effect if vmware_username and vmware_password are defined Authentication file content: username=vmuser password=p@ssw0rd
vmware_warn	Optional. The warning threshold. No value defined as default.
vmware_crit	Optional. The critical threshold. No value defined as default.

vmware-esx-soap-vm-net-send

Check command object for the check_vmware_esx plugin. Send in KBps(Kilobytes per Second).

Custom variables passed as command parameters:

Name	Description
vmware_datacenter	Optional. Datacenter/vCenter hostname. Conflicts with vmware_host.
vmware_host	Optional. ESX or ESXi hostname. Conflicts with vmware_datacenter.
vmware_vmname	Required. Virtual machine name.
vmware_sslport	Optional. SSL port connection. Defaults to "443".
vmware_ignoreunknown	Optional. Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
vmware_ignorewarning	Optional. Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
vmware_timeout	Optional. Seconds before plugin times out. Defaults to "90".
vmware_trace	Optional. Set verbosity level of vSphere API request/respond trace.
vmware_sessionfile	Optional. Session file name enhancement.
vmware_sessionfiledir	Optional. Path to store the vmware_sessionfile file. Defaults to "/var/spool/icinga2/tmp".
vmware_nosession	Optional. No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
vmware_username	Optional. The username to connect to Host or vCenter server. No value defined as default.
vmware_password	Optional. The username's password. No value defined as default.
vmware_authfile	Optional. Use auth file instead username/password to session connect. No effect if vmware_username and vmware_password are defined Authentication file content: username=vmuser password=p@ssw0rd
vmware_warn	Optional. The warning threshold. No value defined as default.
vmware_crit	Optional. The critical threshold. No value defined as default.

vmware-esx-soap-vm-io

Check command object for the check_vmware_esx plugin. Shows all disk io info. Without subselect no thresholds can be given. All I/O values are aggregated from historical intervals over the past 24 hours with a 5 minute sample rate.

Custom variables passed as command parameters:

Name	Description
vmware_datacenter	Optional. Datacenter/vCenter hostname. Conflicts with vmware_host.
vmware_host	Optional. ESX or ESXi hostname. Conflicts with vmware_datacenter.
vmware_vmname	Required. Virtual machine name.
vmware_sslport	Optional. SSL port connection. Defaults to "443".
vmware_ignoreunknown	Optional. Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
vmware_ignorewarning	Optional. Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
vmware_timeout	Optional. Seconds before plugin times out. Defaults to "90".
vmware_trace	Optional. Set verbosity level of vSphere API request/respond trace.
vmware_sessionfile	Optional. Session file name enhancement.
vmware_sessionfiledir	Optional. Path to store the vmware_sessionfile file. Defaults to "/var/spool/icinga2/tmp".
vmware_nosession	Optional. No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
vmware_username	Optional. The username to connect to Host or vCenter server. No value defined as default.
vmware_password	Optional. The username's password. No value defined as default.
vmware_authfile	Optional. Use auth file instead username/password to session connect. No effect if vmware_username and vmware_password are defined Authentication file content: username=vmuser password=p@ssw0rd

vmware-esx-soap-vm-io-read

Check command object for the check_vmware_esx plugin. Average number of kilobytes read from the disk each second.

Custom variables passed as command parameters:

Name	Description
vmware_datacenter	Optional. Datacenter/vCenter hostname. Conflicts with vmware_host.
vmware_host	Optional. ESX or ESXi hostname. Conflicts with vmware_datacenter.
vmware_vmname	Required. Virtual machine name.
vmware_sslport	Optional. SSL port connection. Defaults to "443".
vmware_ignoreunknown	Optional. Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
vmware_ignorewarning	Optional. Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
vmware_timeout	Optional. Seconds before plugin times out. Defaults to "90".
vmware_trace	Optional. Set verbosity level of vSphere API request/respond trace.
vmware_sessionfile	Optional. Session file name enhancement.
vmware_sessionfiledir	Optional. Path to store the vmware_sessionfile file. Defaults to "/var/spool/icinga2/tmp".
vmware_nosession	Optional. No auth session - IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
vmware_username	Optional. The username to connect to Host or vCenter server. No value defined as default.
vmware_password	Optional. The username's password. No value defined as default.
vmware_authfile	Optional. Use auth file instead username/password to session connect. No effect if vmware_username and vmware_password are defined Authentication file content: username=vmuser password=p@ssw0rd
vmware_warn	Optional. The warning threshold. No value defined as default.
vmware_crit	Optional. The critical threshold. No value defined as default.

vmware-esx-soap-vm-io-write

Check command object for the check_vmware_esx plugin. Average number of kilobytes written to disk each second.

Custom variables passed as command parameters:

Name	Description
vmware_datacenter	Optional. Datacenter/vCenter hostname. Conflicts with vmware_host.
vmware_host	Optional. ESX or ESXi hostname. Conflicts with vmware_datacenter.
vmware_vmname	Required. Virtual machine name.
vmware_sslport	Optional. SSL port connection. Defaults to "443".
vmware_ignoreunknown	Optional. Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
vmware_ignorewarning	Optional. Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
vmware_timeout	Optional. Seconds before plugin times out. Defaults to "90".
vmware_trace	Optional. Set verbosity level of vSphere API request/respond trace.
vmware_sessionfile	Optional. Session file name enhancement.
vmware_sessionfiledir	Optional. Path to store the vmware_sessionfile file. Defaults to "/var/spool/icinga2/tmp".
vmware_nosession	Optional. No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
vmware_username	Optional. The username to connect to Host or vCenter server. No value defined as default.
vmware_password	Optional. The username's password. No value defined as default.
vmware_authfile	Optional. Use auth file instead username/password to session connect. No effect if vmware_username and vmware_password are defined Authentication file content: username=vmuser password=p@ssw0rd
vmware_warn	Optional. The warning threshold. No value defined as default.
vmware_crit	Optional. The critical threshold. No value defined as default.

vmware-esx-soap-vm-io-usage

Check command object for the check_vmware_esx plugin. Aggregated disk I/O rate.

Custom variables passed as command parameters:

Name	Description
vmware_datacenter	Optional. Datacenter/vCenter hostname. Conflicts with vmware_host.
vmware_host	Optional. ESX or ESXi hostname. Conflicts with vmware_datacenter.
vmware_vmname	Required. Virtual machine name.
vmware_sslport	Optional. SSL port connection. Defaults to "443".
vmware_ignoreunknown	Optional. Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
vmware_ignorewarning	Optional. Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
vmware_timeout	Optional. Seconds before plugin times out. Defaults to "90".
vmware_trace	Optional. Set verbosity level of vSphere API request/respond trace.
vmware_sessionfile	Optional. Session file name enhancement.
vmware_sessionfiledir	Optional. Path to store the vmware_sessionfile file. Defaults to "/var/spool/icinga2/tmp".
vmware_nosession	Optional. No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
vmware_username	Optional. The username to connect to Host or vCenter server. No value defined as default.
vmware_password	Optional. The username's password. No value defined as default.
vmware_authfile	Optional. Use auth file instead username/password to session connect. No effect if vmware_username and vmware_password are defined Authentication file content: username=vmuser password=p@ssw0rd
vmware_warn	Optional. The warning threshold. No value defined as default.
vmware_crit	Optional. The critical threshold. No value defined as default.

vmware-esx-soap-vm-runtime

Check command object for the check_vmware_esx plugin. Shows virtual machine runtime info.

Custom variables passed as command parameters:

Name	Description
vmware_datacenter	Optional. Datacenter/vCenter hostname. Conflicts with vmware_host.
vmware_host	Optional. ESX or ESXi hostname. Conflicts with vmware_datacenter.
vmware_vmname	Required. Virtual machine name.
vmware_sslport	Optional. SSL port connection. Defaults to "443".
vmware_ignoreunknown	Optional. Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
vmware_ignorewarning	Optional. Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
vmware_timeout	Optional. Seconds before plugin times out. Defaults to "90".
vmware_trace	Optional. Set verbosity level of vSphere API request/respond trace.
vmware_sessionfile	Optional. Session file name enhancement.
vmware_sessionfiledir	Optional. Path to store the vmware_sessionfile file. Defaults to "/var/spool/icinga2/tmp".
vmware_nosession	Optional. No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
vmware_username	Optional. The username to connect to Host or vCenter server. No value defined as default.
vmware_password	Optional. The username's password. No value defined as default.
vmware_authfile	Optional. Use auth file instead username/password to session connect. No effect if vmware_username and vmware_password are defined Authentication file content: username=vmuser password=p@ssw0rd

vmware-esx-soap-vm-runtime-con

Check command object for the check_vmware_esx plugin. Shows the connection state.

Custom variables passed as command parameters:

Name	Description
vmware_datacenter	Optional. Datacenter/vCenter hostname. Conflicts with vmware_host.
vmware_host	Optional. ESX or ESXi hostname. Conflicts with vmware_datacenter.
vmware_vmname	Required. Virtual machine name.
vmware_sslport	Optional. SSL port connection. Defaults to "443".
vmware_ignoreunknown	Optional. Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
vmware_ignorewarning	Optional. Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
vmware_timeout	Optional. Seconds before plugin times out. Defaults to "90".
vmware_trace	Optional. Set verbosity level of vSphere API request/respond trace.
vmware_sessionfile	Optional. Session file name enhancement.
vmware_sessionfiledir	Optional. Path to store the vmware_sessionfile file. Defaults to "/var/spool/icinga2/tmp".
vmware_nosession	Optional. No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
vmware_username	Optional. The username to connect to Host or vCenter server. No value defined as default.
vmware_password	Optional. The username's password. No value defined as default.
vmware_authfile	Optional. Use auth file instead username/password to session connect. No effect if vmware_username and vmware_password are defined Authentication file content: username=vmuser password=p@ssw0rd

vmware-esx-soap-vm-runtime-powerstate

Check command object for the check_vmware_esx plugin. Shows virtual machine power state: poweredOn, poweredOff or suspended.

Custom variables passed as command parameters:

Name	Description
vmware_datacenter	Optional. Datacenter/vCenter hostname. Conflicts with vmware_host.
vmware_host	Optional. ESX or ESXi hostname. Conflicts with vmware_datacenter.
vmware_vmname	Required. Virtual machine name.
vmware_sslport	Optional. SSL port connection. Defaults to "443".
vmware_ignoreunknown	Optional. Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
vmware_ignorewarning	Optional. Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
vmware_timeout	Optional. Seconds before plugin times out. Defaults to "90".
vmware_trace	Optional. Set verbosity level of vSphere API request/respond trace.
vmware_sessionfile	Optional. Session file name enhancement.
vmware_sessionfiledir	Optional. Path to store the vmware_sessionfile file. Defaults to "/var/spool/icinga2/tmp".
vmware_nosession	Optional. No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
vmware_username	Optional. The username to connect to Host or vCenter server. No value defined as default.
vmware_password	Optional. The username's password. No value defined as default.
vmware_authfile	Optional. Use auth file instead username/password to session connect. No effect if vmware_username and vmware_password are defined Authentication file content: username=vmuser password=p@ssw0rd

vmware-esx-soap-vm-runtime-status

Check command object for the check_vmware_esx plugin. Overall object status (gray/green/red/yellow).

Custom variables passed as command parameters:

Name	Description
vmware_datacenter	Optional. Datacenter/vCenter hostname. Conflicts with vmware_host.
vmware_host	Optional. ESX or ESXi hostname. Conflicts with vmware_datacenter.
vmware_vmname	Required. Virtual machine name.
vmware_sslport	Optional. SSL port connection. Defaults to "443".
vmware_ignoreunknown	Optional. Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
vmware_ignorewarning	Optional. Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
vmware_timeout	Optional. Seconds before plugin times out. Defaults to "90".
vmware_trace	Optional. Set verbosity level of vSphere API request/respond trace.
vmware_sessionfile	Optional. Session file name enhancement.
vmware_sessionfiledir	Optional. Path to store the vmware_sessionfile file. Defaults to "/var/spool/icinga2/tmp".
vmware_nosession	Optional. No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
vmware_username	Optional. The username to connect to Host or vCenter server. No value defined as default.
vmware_password	Optional. The username's password. No value defined as default.
vmware_authfile	Optional. Use auth file instead username/password to session connect. No effect if vmware_username and vmware_password are defined Authentication file content: username=vmuser password=p@ssw0rd

vmware-esx-soap-vm-runtime-consoleconnections

Check command object for the check_vmware_esx plugin. Console connections to virtual machine.

Custom variables passed as command parameters:

Name	Description
vmware_datacenter	Optional. Datacenter/vCenter hostname. Conflicts with vmware_host.
vmware_host	Optional. ESX or ESXi hostname. Conflicts with vmware_datacenter.
vmware_vmname	Required. Virtual machine name.
vmware_sslport	Optional. SSL port connection. Defaults to "443".
vmware_ignoreunknown	Optional. Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
vmware_ignorewarning	Optional. Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
vmware_timeout	Optional. Seconds before plugin times out. Defaults to "90".
vmware_trace	Optional. Set verbosity level of vSphere API request/respond trace.
vmware_sessionfile	Optional. Session file name enhancement.
vmware_sessionfiledir	Optional. Path to store the vmware_sessionfile file. Defaults to "/var/spool/icinga2/tmp".
vmware_nosession	Optional. No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
vmware_username	Optional. The username to connect to Host or vCenter server. No value defined as default.
vmware_password	Optional. The username's password. No value defined as default.
vmware_authfile	Optional. Use auth file instead username/password to session connect. No effect if vmware_username and vmware_password are defined Authentication file content: username=vmuser password=p@ssw0rd
vmware_warn	Optional. The warning threshold. No value defined as default.
vmware_crit	Optional. The critical threshold. No value defined as default.

vmware-esx-soap-vm-runtime-gueststate

Check command object for the check_vmware_esx plugin. Guest OS status. Needs VMware Tools installed and running.

Custom variables passed as command parameters:

Name	Description
vmware_datacenter	Optional. Datacenter/vCenter hostname. Conflicts with vmware_host.
vmware_host	Optional. ESX or ESXi hostname. Conflicts with vmware_datacenter.
vmware_vmname	Required. Virtual machine name.
vmware_sslport	Optional. SSL port connection. Defaults to "443".
vmware_ignoreunknown	Optional. Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
vmware_ignorewarning	Optional. Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
vmware_timeout	Optional. Seconds before plugin times out. Defaults to "90".
vmware_trace	Optional. Set verbosity level of vSphere API request/respond trace.
vmware_sessionfile	Optional. Session file name enhancement.
vmware_sessionfiledir	Optional. Path to store the vmware_sessionfile file. Defaults to "/var/spool/icinga2/tmp".
vmware_nosession	Optional. No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
vmware_username	Optional. The username to connect to Host or vCenter server. No value defined as default.
vmware_password	Optional. The username's password. No value defined as default.
vmware_authfile	Optional. Use auth file instead username/password to session connect. No effect if vmware_username and vmware_password are defined Authentication file content: username=vmuser password=p@ssw0rd

vmware-esx-soap-vm-runtime-tools

Check command object for the check_vmware_esx plugin. Guest OS status. VMware tools status.

Custom variables passed as command parameters:

Name	Description
vmware_datacenter	Optional. Datacenter/vCenter hostname. Conflicts with vmware_host.
vmware_host	Optional. ESX or ESXi hostname. Conflicts with vmware_datacenter.
vmware_vmname	Required. Virtual machine name.
vmware_sslport	Optional. SSL port connection. Defaults to "443".
vmware_ignoreunknown	Optional. Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
vmware_ignorewarning	Optional. Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
vmware_timeout	Optional. Seconds before plugin times out. Defaults to "90".
vmware_trace	Optional. Set verbosity level of vSphere API request/respond trace.
vmware_sessionfile	Optional. Session file name enhancement.
vmware_sessionfiledir	Optional. Path to store the vmware_sessionfile file. Defaults to "/var/spool/icinga2/tmp".
vmware_nosession	Optional. No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
vmware_username	Optional. The username to connect to Host or vCenter server. No value defined as default.
vmware_password	Optional. The username's password. No value defined as default.
vmware_authfile	Optional. Use auth file instead username/password to session connect. No effect if vmware_username and vmware_password are defined Authentication file content: username=vmuser password=p@ssw0rd
vmware_openvmtools	Optional Prevent CRITICAL state for installed and running Open VM Tools.
vmware_novmtools	Optional Prevent CRITICAL state for missing VMware tools.

vmware-esx-soap-vm-runtime-issues

Check command object for the check_vmware_esx plugin. All issues for the virtual machine.

Custom variables passed as command parameters:

Name	Description
vmware_datacenter	Optional. Datacenter/vCenter hostname. Conflicts with vmware_host.
vmware_host	Optional. ESX or ESXi hostname. Conflicts with vmware_datacenter.
vmware_vmname	Required. Virtual machine name.
vmware_sslport	Optional. SSL port connection. Defaults to "443".
vmware_ignoreunknown	Optional. Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
vmware_ignorewarning	Optional. Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
vmware_timeout	Optional. Seconds before plugin times out. Defaults to "90".
vmware_trace	Optional. Set verbosity level of vSphere API request/respond trace.
vmware_sessionfile	Optional. Session file name enhancement.
vmware_sessionfiledir	Optional. Path to store the vmware_sessionfile file. Defaults to "/var/spool/icinga2/tmp".
vmware_nosession	Optional. No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
vmware_username	Optional. The username to connect to Host or vCenter server. No value defined as default.
vmware_password	Optional. The username's password. No value defined as default.
vmware_authfile	Optional. Use auth file instead username/password to session connect. No effect if vmware_username and vmware_password are defined Authentication file content: username=vmuser password=p@ssw0rd
vmware_multiline	Optional. Multiline output in overview. This mean technically that a multiline output uses a HTML <br> for the GUI. No value defined as default.

Web

This category includes all plugins for web-based checks.

apache-status

The check_apache_status.pl plugin uses the /server-status HTTP endpoint to monitor status metrics for the Apache webserver.

Custom variables passed as command parameters:

Name	Description
apache_status_address	Optional. Host address. Defaults to "address" if the host's address attribute is set, address6 otherwise.
apache_status_port	Optional. HTTP port.
apache_status_uri	Optional. URL to use, instead of the default (http://apache_status_address/server-status).
apache_status_ssl	Optional. Set to use SSL connection.
apache_status_no_validate	Optional. Skip SSL certificate validation.
apache_status_username	Optional. Username for basic auth.
apache_status_password	Optional. Password for basic auth.
apache_status_timeout	Optional. Timeout in seconds.
apache_status_unreachable	Optional. Return CRITICAL if socket timed out or http code >= 500.
apache_status_warning	Optional. Warning threshold (number of open slots, busy workers and idle workers that will cause a WARNING) like ':20,50,:50'.
apache_status_critical	Optional. Critical threshold (number of open slots, busy workers and idle workers that will cause a CRITICAL) like ':10,25,:20'.

ssl_cert

The check_ssl_cert plugin uses the openssl binary (and optional curl) to check a X.509 certificate.

Custom variables passed as command parameters:

Name	Description
ssl_cert_address	Optional. The host's address. Defaults to "address" if the host's address attribute is set, "address6" otherwise.
ssl_cert_port	Optional. TCP port number (default: 443).
ssl_cert_proxy	Optional. Proxy server to use for connecting to the host. Sets http_proxy and the s_client -proxy option.
ssl_cert_file	Optional. Local file path. Works only if ssl_cert_address is set to "localhost".
ssl_cert_warn	Optional. Minimum number of days a certificate has to be valid.
ssl_cert_critical	Optional. Minimum number of days a certificate has to be valid to issue a critical status.
ssl_cert_cn	Optional. Pattern to match the CN of the certificate.
ssl_cert_altnames	Optional. Matches the pattern specified in -n with alternate
ssl_cert_issuer	Optional. Pattern to match the issuer of the certificate.
ssl_cert_org	Optional. Pattern to match the organization of the certificate.
ssl_cert_email	Optional. Pattern to match the email address contained in the certificate.
ssl_cert_serial	Optional. Pattern to match the serial number.
ssl_cert_noauth	Optional. Ignore authority warnings (expiration only)
ssl_cert_match_host	Optional. Match CN with the host name.
ssl_cert_selfsigned	Optional. Allow self-signed certificate.
ssl_cert_sni	Optional. Sets the TLS SNI (Server Name Indication) extension.
ssl_cert_timeout	Optional. Seconds before connection times out (default: 15)
ssl_cert_protocol	Optional. Use the specific protocol {http,smtp,pop3,imap,ftp,xmpp,irc,ldap} (default: http).
ssl_cert_http_url	Optional. HTTP Request URL (default: /)
ssl_cert_clientcert	Optional. Use client certificate to authenticate.
ssl_cert_clientpass	Optional. Set passphrase for client certificate.
ssl_cert_ssllabs	Optional. SSL Labs assessment
ssl_cert_ssllabs_nocache	Optional. Forces a new check by SSL Labs
ssl_cert_rootcert	Optional. Root certificate or directory to be used for certificate validation.
ssl_cert_ignore_signature	Optional. Do not check if the certificate was signed with SHA1 od MD5.
ssl_cert_ssl_version	Optional. Force specific SSL version out of {ssl2,ssl3,tls1,tls1_1,tls1_2}.
ssl_cert_disable_ssl_versions	Optional. Disable specific SSL versions out of {ssl2,ssl3,tls1,tls1_1,tls1_2}. Multiple versions can be given as array.
ssl_cert_cipher	Optional. Cipher selection: force {ecdsa,rsa} authentication.
ssl_cert_ignore_expiration	Optional. Ignore expiration date.
ssl_cert_ignore_host_cn	Optional. Do not complain if the CN does not match.
ssl_cert_ignore_ocsp	Optional. Do not check revocation with OCSP.
ssl_cert_ignore_ocsp_errors	Optional. Continue if the OCSP status cannot be checked.
ssl_cert_ignore_ocsp_timeout	Optional. Ignore OCSP result when timeout occurs while checking.
ssl_cert_ignore_sct	Optional. Do not check for signed certificate timestamps.
ssl_cert_ignore_tls_renegotiation	Optional. Do not check for renegotiation.

jmx4perl

The check_jmx4perl plugin uses the HTTP API exposed by the Jolokia web application and queries Java message beans on an application server. It is part of the JMX::Jmx4Perl Perl module which includes detailed documentation.

Custom variables passed as command parameters:

Name	Description
jmx4perl_url	Required. URL to agent web application. Defaults to "http://address:8080/jolokia".
jmx4perl_product	Optional. Name of app server product (e.g. jboss), by default is uses an auto detection facility.
jmx4perl_alias	Optional. Alias name for attribute (e.g. MEMORY_HEAP_USED). All available aliases can be viewed by executing jmx4perl aliases on the command line.
jmx4perl_mbean	Optional. MBean name (e.g. java.lang:type=Memory).
jmx4perl_attribute	Optional. Attribute name (e.g. HeapMemoryUsage).
jmx4perl_operation	Optional. Operation to execute.
jmx4perl_value	Optional. Shortcut for specifying mbean/attribute/path. Slashes within names must be escaped with backslash.
jmx4perl_delta	Optional. Switches on incremental mode. Optional argument are seconds used for normalizing.
jmx4perl_path	Optional. Inner path for extracting a single value from a complex attribute or return value (e.g. used).
jmx4perl_target	Optional. JSR-160 Service URL specifing the target server.
jmx4perl_target_user	Optional. Username to use for JSR-160 connection.
jmx4perl_target_password	Optional. Password to use for JSR-160 connection.
jmx4perl_proxy	Optional. Proxy to use.
jmx4perl_user	Optional. User for HTTP authentication.
jmx4perl_password	Optional. Password for HTTP authentication.
jmx4perl_name	Optional. Name to use for output, by default a standard value based on the MBean and attribute will be used.
jmx4perl_method	Optional. HTTP method to use, either get or post. By default a method is determined automatically based on the request type.
jmx4perl_base	Optional. Base name, which when given, interprets critical and warning values as relative in the range 0 .. 100%. Must be given in the form mbean/attribute/path.
jmx4perl_base_mbean	Optional. Base MBean name, interprets critical and warning values as relative in the range 0 .. 100%. Requires "jmx4perl_base_attribute".
jmx4perl_base_attribute	Optional. Base attribute for a relative check. Requires "jmx4perl_base_mbean".
jmx4perl_base_path	Optional. Base path for relative checks, where this path is used on the base attribute's value.
jmx4perl_unit	Optional. Unit of measurement of the data retrieved. Recognized values are [B|KB|MN|GB|TB] for memory values and [us|ms|s|m|h|d] for time values.
jmx4perl_null	Optional. Value which should be used in case of a null return value of an operation or attribute. Defaults to null.
jmx4perl_string	Optional. Force string comparison for critical and warning checks. Defaults to false.
jmx4perl_numeric	Optional. Force numeric comparison for critical and warning checks. Defaults to false.
jmx4perl_critical	Optional. Critical threshold for value.
jmx4perl_warning	Optional. Warning threshold for value.
jmx4perl_label	Optional. Label to be used for printing out the result of the check. For placeholders which can be used see the documentation.
jmx4perl_perfdata	Optional. Whether performance data should be omitted, which are included by default. Defaults to "on" for numeric values, to "off" for strings.
jmx4perl_unknown_is_critical	Optional. Map UNKNOWN errors to errors with a CRITICAL status. Defaults to false.
jmx4perl_timeout	Optional. Seconds before plugin times out. Defaults to "15".
jmx4perl_config	Optional. Path to configuration file.
jmx4perl_server	Optional. Symbolic name of server url to use, which needs to be configured in the configuration file.
jmx4perl_check	Optional. Name of a check configuration as defined in the configuration file, use array if you need arguments.

kdc

The check_kdc plugin uses the Kerberos kinit binary to monitor Kerberos 5 KDC by acquiring a ticket.

Custom variables passed as command parameters:

Name	Description
kdc_address	Optional. The host's address. Defaults to "address" if the host's address attribute is set, address6 otherwise.
kdc_port	Optional Port on which KDC runs (default 88).
kdc_principal	Required Principal name to authenticate as (including realm).
kdc_keytab	Required Keytab file containing principal's key.

nginx_status

The check_nginx_status.pl plugin uses the /nginx_status HTTP endpoint which provides metrics for monitoring Nginx.

Custom variables passed as command parameters:

Name	Description
nginx_status_host_address	Optional. The host's address. Defaults to "address" if the host's address attribute is set, address6 otherwise.
nginx_status_port	Optional. the http port.
nginx_status_url	Optional. URL to use, instead of the default (http://nginx_status_hostname/nginx_status).
nginx_status_servername	Optional. ServerName to use if you specified an IP to match the good Virtualhost in your target.
nginx_status_ssl	Optional. set to use ssl connection.
nginx_status_disable_sslverify	Optional. set to disable SSL hostname verification.
nginx_status_user	Optional. Username for basic auth.
nginx_status_pass	Optional. Password for basic auth.
nginx_status_realm	Optional. Realm for basic auth.
nginx_status_maxreach	Optional. Number of max processes reached (since last check) that should trigger an alert.
nginx_status_timeout	Optional. timeout in seconds.
nginx_status_warn	Optional. Warning threshold (number of active connections, ReqPerSec or ConnPerSec that will cause a WARNING) like '10000,100,200'.
nginx_status_critical	Optional. Critical threshold (number of active connections, ReqPerSec or ConnPerSec that will cause a CRITICAL) like '20000,200,300'.

rbl

The check_rbl plugin uses the Net::DNS Perl library to check whether your SMTP server is blacklisted.

Custom variables passed as command parameters:

Name	Description
rbl_hostname	Optional. The address or name of the SMTP server to check. Defaults to "address" if the host's address attribute is set, address6 otherwise.
rbl_server	Required List of RBL servers as an array.
rbl_warning	Optional Number of blacklisting servers for a warning.
rbl_critical	Optional Number of blacklisting servers for a critical.
rbl_timeout	Optional Seconds before plugin times out (default: 15).

squid

The check_squid plugin uses the squidclient binary to monitor a Squid proxy.

Custom variables passed as command parameters:

Name	Description
squid_hostname	Optional. The host's address. Defaults to "address" if the host's address attribute is set, "address6" otherwise.
squid_data	Optional. Data to fetch (default: Connections) available data: Connections Cache Resources Memory FileDescriptors.
squid_port	Optional. Port number (default: 3128).
squid_user	Optional. WWW user.
squid_password	Optional. WWW password.
squid_warning	Optional. Warning threshold. See http://nagiosplug.sourceforge.net/developer-guidelines.html#THRESHOLDFORMAT for the threshold format.
squid_critical	Optional. Critical threshold. See http://nagiosplug.sourceforge.net/developer-guidelines.html#THRESHOLDFORMAT for the threshold format.
squid_client	Optional. Path of squidclient (default: /usr/bin/squidclient).
squid_timeout	Optional. Seconds before plugin times out (default: 15).

webinject

The check_webinject plugin uses WebInject to test web applications and web services in an automated fashion. It can be used to test individual system components that have HTTP interfaces (JSP, ASP, CGI, PHP, AJAX, Servlets, HTML Forms, XML/SOAP Web Services, REST, etc), and can be used as a test harness to create a suite of HTTP level automated functional, acceptance, and regression tests. A test harness allows you to run many test cases and collect/report your results. WebInject offers real-time results display and may also be used for monitoring system response times.

Custom variables passed as command parameters:

Name	Description
webinject_config_file	Optional. There is a configuration file named 'config.xml' that is used to store configuration settings for your project. You can use this to specify which test case files to run and to set some constants and settings to be used by WebInject.
webinject_output	Optional. This option is followed by a directory name or a prefix to prepended to the output files. This is used to specify the location for writing output files (http.log, results.html, and results.xml). If a directory name is supplied (use either an absolute or relative path and make sure to add the trailing slash), all output files are written to this directory. If the trailing slash is omitted, it is assumed to a prefix and this will be prepended to the output files. You may also use a combination of a directory and prefix.
webinject_no_output	Optional. Suppresses all output to STDOUT except the results summary.
webinject_timeout	Optional. The value [given in seconds] will be compared to the global time elapsed to run all the tests. If the tests have all been successful, but have taken more time than the 'globaltimeout' value, a warning message is sent back to Icinga.
webinject_report_type	Optional. This setting is used to enable output formatting that is compatible for use with specific external programs. The available values you can set this to are: nagios, mrtg, external and standard.
webinject_testcase_file	Optional. When you launch WebInject in console mode, you can optionally supply an argument for a testcase file to run. It will look for this file in the directory that webinject.pl resides in. If no filename is passed from the command line, it will look in config.xml for testcasefile declarations. If no files are specified, it will look for a default file named 'testcases.xml' in the current [webinject] directory. If none of these are found, the engine will stop and give you an error.

varnish

The check_varnish plugin, also available in the monitoring-plugins-contrib on debian, uses the varnishstat binary to monitor varnish.

Custom variables passed as command parameters:

Name	Description
varnish_name	Optional. Specify the Varnish instance name
varnish_param	Optional. Specify the parameter to check (see below). The default is 'ratio'.
varnish_critical	Optional. Set critical threshold: [@][lo:]hi
varnish_warning	Optional. Set warning threshold: [@][lo:]hi

For varnish_param, all items reported by varnishstat(1) are available - use the identifier listed in the left column by varnishstat -l. In addition, the following parameters are available:

Name	Description
uptime	How long the cache has been running (in seconds)
ratio	The cache hit ratio expressed as a percentage of hits to hits + misses. Default thresholds are 95 and 90.
usage	Cache file usage as a percentage of the total cache space.

haproxy

The check_haproxy plugin, also available in the monitoring-plugins-contrib on debian, uses the haproxy csv statistics page to monitor haproxy response time. The plugin output performance data for backends sessions and statistics response time.

This plugin need to access the csv statistics page. You can configure it in haproxy by adding a new frontend:

frontend stats
    bind 127.0.0.1:80
    stats enablestats
    stats uri /stats

The statistics page will be available at http://127.0.0.1/stats;csv;norefresh.

Custom variables passed as command parameters:

Name	Description
haproxy_username	Optional. Username for HTTP Auth
haproxy_password	Optional. Password for HTTP Auth
haproxy_url	Required. URL of the HAProxy csv statistics page.
haproxy_timeout	Optional. Seconds before plugin times out (default: 10)
haproxy_warning	Optional. Warning request time threshold (in seconds)
haproxy_critical	Optional. Critical request time threshold (in seconds)

haproxy_status

The check_haproxy_status plugin, uses the haproxy statistics socket to monitor haproxy frontends/backends.

This plugin need read/write access to the statistics socket with an operator level. You can configure it in the global section of haproxy to allow icinga user to use it:

stats socket /run/haproxy/admin.sock user haproxy group icinga mode 660 level operator

Custom variables passed as command parameters:

Name	Description
haproxy_status_default	Optional. Set/Override the defaults which will be applied to all checks (unless specifically set by --overrides).
haproxy_status_frontends	Optional. Enable checks for the frontends in HAProxy (that they're marked as OPEN and the session limits haven't been reached).
haproxy_status_nofrontends	Optional. Disable checks for the frontends in HAProxy (that they're marked as OPEN and the session limits haven't been reached).
haproxy_status_backends	Optional. Enable checks for the backends in HAProxy (that they have the required quorum of servers, and that the session limits haven't been reached).
haproxy_status_nobackends	Optional. Disable checks for the backends in HAProxy (that they have the required quorum of servers, and that the session limits haven't been reached).
haproxy_status_servers	Optional. Enable checks for the servers in HAProxy (that they haven't reached the limits for the sessions or for queues).
haproxy_status_noservers	Optional. Disable checks for the servers in HAProxy (that they haven't reached the limits for the sessions or for queues).
haproxy_status_overrides	Optional. Override the defaults for a particular frontend or backend, in the form {name}:{override}, where {override} is the same format as --defaults above.
haproxy_status_socket	Required. Path to the socket check_haproxy should connect to

phpfpm_status

The check_phpfpm_status plugin, uses the php-fpm status page to monitor php-fpm.

Custom variables passed as command parameters:

Name	Description
phpfpm_status_hostname	Required. name or IP address of host to check
phpfpm_status_port	Optional. Http port, or Fastcgi port when using --fastcgi
phpfpm_status_url	Optional. Specific URL (only the path part of it in fact) to use, instead of the default /fpm-status
phpfpm_status_servername	Optional. ServerName, (host header of HTTP request) use it if you specified an IP in -H to match the good Virtualhost in your target
phpfpm_status_fastcgi	Optional. If set, connect directly to php-fpm via network or local socket, using fastcgi protocol instead of HTTP.
phpfpm_status_user	Optional. Username for basic auth
phpfpm_status_pass	Optional. Password for basic auth
phpfpm_status_realm	Optional. Realm for basic auth
phpfpm_status_debug	Optional. If set, debug mode (show http request response)
phpfpm_status_timeout	Optional. timeout in seconds (Default: 15)
phpfpm_status_ssl	Optional. Wether we should use HTTPS instead of HTTP. Note that you can give some extra parameters to this settings. Default value is 'TLSv1' but you could use things like 'TLSv1_1' or 'TLSV1_2' (or even 'SSLv23:!SSLv2:!SSLv3' for old stuff).
phpfpm_status_verifyssl	Optional. If set, verify certificate and hostname from ssl cert, default is 0 (no security), set it to 1 to really make SSL peer name and certificater checks.
phpfpm_status_cacert	Optional. Full path to the cacert.pem certificate authority used to verify ssl certificates (use with --verifyssl). if not given the cacert from Mozilla::CA cpan plugin will be used.
phpfpm_status_warn	Optional. MIN_AVAILABLE_PROCESSES,PROC_MAX_REACHED,QUEUE_MAX_REACHED number of available workers, or max states reached that will cause a warning. -1 for no warning
phpfpm_status_critical	Optional. MIN_AVAILABLE_PROCESSES,PROC_MAX_REACHED,QUEUE_MAX_REACHED number of available workers, or max states reached that will cause an error, -1 for no CRITICAL