Check command for the built-in `cluster-zone` check.
-Custom Attributes:
+Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
Name | Description
-------------|---------------
Check command for the built-in `ido` check.
-Custom Attributes:
+Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-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.
+### <a id="itl-random"></a> 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.
+
# <a id="plugin-check-commands"></a> Plugin Check Commands
The Plugin Check Commands provides example configuration for plugin check commands
Check command object for the `check_by_ssh` plugin.
-Custom Attributes:
+Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
Name | Description
----------------|--------------
-by_ssh_address | **Optional.** The host's address. Defaults to "$address$" or "$address6$" if the `address` attribute is not set.
+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 | **Optional.** The command that should be executed.
by_ssh_logname | **Optional.** The SSH username.
Check command object for the `check_dhcp` plugin.
-Custom Attributes:
+Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
Name | Description
----------------|--------------
Check command object for the `check_dig` plugin.
-Custom Attributes:
+Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
Name | Description
---------------------|--------------
> `disk_wfree` and `disk_cfree` require the percent sign compared to older versions.
> If omitted, disk units can be used. This has been changed in **2.3.0**.
-Custom Attributes:
+Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
Name | Description
------------------------|------------------------
disk_units | **Optional.** Choose bytes, kB, MB, GB, TB (default: MB).
disk_exclude_type | **Optional.** Ignore all filesystems of indicated type (may be repeated).
+## <a id="plugin-check-command-disk-smb"></a> disk_smb
+
+Check command object for the `check_disk_smb` plugin.
+
+> **Note**
+>
+> `disk_smb_wused` and `disk_smb_cused` require the percent sign. If omitted, disk units can be used.
+
+Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-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.
## <a id="plugin-check-command-dns"></a> dns
Check command object for the `check_dns` plugin.
-Custom Attributes:
+Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
Name | Description
---------------------|--------------
-dns_lookup | **Optional.** The hostname or IP to query the DNS for. Defaults to $host_name$.
+dns_lookup | **Optional.** The hostname or IP to query the DNS for. Defaults to "$host_name$".
dns_server | **Optional.** The DNS server to query. Defaults to the server configured in the OS.
dns_expected_answer | **Optional.** The answer to look for. A hostname must end with a dot. **Deprecated in 2.3.**
dns_expected_answers | **Optional.** The answer(s) to look for. A hostname must end with a dot. Multiple answers must be defined as array.
dns_authoritative | **Optional.** Expect the server to send an authoritative answer.
+dns_wtime | **Optional.** Return warning if elapsed time exceeds value.
+dns_ctime | **Optional.** Return critical if elapsed time exceeds value.
+dns_timeout | **Optional.** Seconds before connection times out. Defaults to 10.
## <a id="plugin-check-command-dummy"></a> dummy
Check command object for the `check_dummy` plugin.
-Custom Attributes:
+Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
Name | Description
----------------|--------------
Check command object for the `check_fping` plugin.
-Custom Attributes:
+Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
Name | Description
----------------|--------------
Check command object for the `check_fping` plugin.
-Custom Attributes:
+Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
Name | Description
----------------|--------------
Check command object for the `check_ftp` plugin.
-Custom Attributes:
+Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
Name | Description
-------------------|--------------
-ftp_address | **Optional.** The host's address. Defaults to "$address$" or "$address6$" if the `address` attribute is not set.
+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 (may be repeated).
+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) - seperated 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.
## <a id="plugin-check-command-hostalive"></a> hostalive
uses the host's `address` attribute if available and falls back to using the `address6` attribute
if the `address` attribute is not set.
-Custom Attributes:
+Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
Name | Description
----------------|--------------
-ping_address | **Optional.** The host's address. Defaults to "$address$" or "$address6$" if the `address` attribute is not set.
+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.
Check command object for the `check_ping` plugin with host check default values. This variant
uses the host's `address` attribute.
-Custom Attributes:
+Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
Name | Description
----------------|--------------
Check command object for the `check_ping` plugin with host check default values. This variant
uses the host's `address6` attribute.
-Custom Attributes:
+Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
Name | Description
----------------|--------------
Check command object for the `check_hpjd` plugin.
-Custom Attributes:
+Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
Name | Description
----------------|--------------
-hpjd_address | **Optional.** The host's address. Defaults to "$address$" or "$address6$" if the `address` attribute is not set.
+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".
Check command object for the `check_http` plugin.
-Custom Attributes:
+Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
Name | Description
-------------------------|--------------
-http_address | **Optional.** The host's address. Defaults to "$address$" or "$address6$" if the `address` attribute is not set.
+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.
http_port | **Optional.** The TCP port. Defaults to 80 when not using SSL, 443 otherwise.
Check command object for the `check_icmp` plugin.
-Custom Attributes:
+Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
Name | Description
----------------|--------------
Check command object for the `check_imap` plugin.
-Custom Attributes:
+Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
Name | Description
----------------|--------------
-imap_address | **Optional.** The host's address. Defaults to "$address$" or "$address6$" if the `address` attribute is not set.
+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.
+## <a id="plugin-check-command-ldap"></a> ldap
+
+Check command object for the `check_ldap` plugin.
+
+Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
+
+Name | Description
+----------------|--------------
+ldap_address | **Optional.** Host name, IP Address, or unix socket (must be an absolute path). Defaults to "$address$" if the host's `address` attribute is set, "$address6$" otherwise.
+ldap_port | **Optional.** Port number. Defaults to 389.
+ldap_attr | **Optional.** LDAP attribute to search for (default: "(objectclass=*)"
+ldap_base | **Required.** LDAP base (eg. ou=myunit,o=myorg,c=at).
+ldap_bind | **Optional.** LDAP bind DN (if required).
+ldap_pass | **Optional.** LDAP password (if required).
+ldap_starttls | **Optional.** Use STARTSSL mechanism introduced in protocol version 3.
+ldap_ssl | **Optional.** Use LDAPS (LDAP v2 SSL method). This also sets the default port to 636.
+ldap_v2 | **Optional.** Use LDAP protocol version 2 (enabled by default).
+ldap_v3 | **Optional.** Use LDAP protocol version 3 (disabled by default)
+ldap_warning | **Optional.** Response time to result in warning status (seconds).
+ldap_critical | **Optional.** Response time to result in critical status (seconds).
+ldap_timeout | **Optional.** Seconds before connection times out (default: 10).
+ldap_verbose | **Optional.** Show details for command-line debugging (disabled by default)
+
## <a id="plugin-check-command-load"></a> load
Check command object for the `check_load` plugin.
-Custom Attributes:
+Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
Name | Description
----------------|--------------
Check command object for the `check_nrpe` plugin.
-Custom Attributes:
+Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
Name | Description
----------------|--------------
-nrpe_address | **Optional.** The host's address. Defaults to "$address$" or "$address6$" if the `address` attribute is not set.
+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 5668.
nrpe_command | **Optional.** The command that should be executed.
nrpe_no_ssl | **Optional.** Whether to disable SSL or not. Defaults to `false`.
Check command object for the `check_nt` plugin.
-Custom Attributes:
+Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
Name | Description
----------------|--------------
-nscp_address | **Optional.** The host's address. Defaults to "$address$" or "$address6$" if the `address` attribute is not set.
+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_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.
## <a id="plugin-check-command-ntp-time"></a> ntp_time
Check command object for the `check_ntp_time` plugin.
-Custom Attributes:
+Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
Name | Description
----------------|--------------
-ntp_address | **Optional.** The host's address. Defaults to "$address$" or "$address6$" if the `address` attribute is not set.
+ntp_address | **Optional.** The host's address. Defaults to "$address$" if the host's `address` attribute is set, "$address6$" otherwise.
## <a id="plugin-check-command-passive"></a> passive
Specialised check command object for passive checks executing the `check_dummy` plugin with appropriate default values.
-Custom Attributes:
+Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
Name | Description
----------------|--------------
if available and falls back to using the `address6` attribute if the `address` attribute is not set.
-Custom Attributes:
+Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
Name | Description
----------------|--------------
-ping_address | **Optional.** The host's address. Defaults to "$address$" or "$address6$" if the `address` attribute is not set.
+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.
Check command object for the `check_ping` plugin.
-Custom Attributes:
+Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
Name | Description
----------------|--------------
Check command object for the `check_ping` plugin.
-Custom Attributes:
+Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
Name | Description
----------------|--------------
Check command object for the `check_pop` plugin.
-Custom Attributes:
+Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
Name | Description
----------------|--------------
-pop_address | **Optional.** The host's address. Defaults to "$address$" or "$address6$" if the `address` attribute is not set.
+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.
Check command object for the `check_procs` plugin.
-Custom Attributes:
+Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
Name | Description
---------------------|--------------
procs_nokthreads | **Optional.** Only scan for non kernel threads. Defaults to false.
-## <a id="plugin-check-command-running-kernel"></a> running_kernel
-
-Check command object for the `check_running_kernel` plugin
-provided by the `nagios-plugins-contrib` package on Debian.
-
-The `running_kernel` check command does not support any vars.
-
-
## <a id="plugin-check-command-simap"></a> simap
Check command object for the `check_simap` plugin.
-Custom Attributes:
+Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
Name | Description
----------------|--------------
-simap_address | **Optional.** The host's address. Defaults to "$address$" or "$address6$" if the `address` attribute is not set.
+simap_address | **Optional.** The host's address. Defaults to "$address$" if the host's `address` attribute is set, "$address6$" otherwise.
simap_port | **Optional.** The host's port.
Check command object for the `check_smtp` plugin.
-Custom Attributes:
+Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
Name | Description
---------------------|--------------
-smtp_address | **Optional.** The host's address. Defaults to "$address$" or "$address6$" if the `address` attribute is not set.
+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.
Check command object for the `check_snmp` plugin.
-Custom Attributes:
+Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
Name | Description
--------------------|--------------
-snmp_address | **Optional.** The host's address. Defaults to "$address$" or "$address6$" if the `address` attribute is not set.
+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_warn | **Optional.** The warning threshold.
Check command object for the `check_snmp` plugin, using SNMPv3 authentication and encryption options.
-Custom Attributes:
+Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
Name | Description
------------------|--------------
-snmpv3_address | **Optional.** The host's address. Defaults to "$address$" or "$address6$" if the `address` attribute is not set.
+snmpv3_address | **Optional.** The host's address. Defaults to "$address$" if the host's `address` attribute is set, "$address6$" otherwise.
snmpv3_user | **Required.** The username to log in with.
snmpv3_auth_alg | **Optional.** The authentication algorithm. Defaults to SHA.
snmpv3_auth_key | **Required.** The authentication key.
Check command object for the `check_snmp` plugin.
-Custom Attributes:
+Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
Name | Description
----------------|--------------
-snmp_address | **Optional.** The host's address. Defaults to "$address$" or "$address6$" if the `address` attribute is not set.
+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".
Check command object for the `check_spop` plugin.
-Custom Attributes:
+Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
Name | Description
----------------|--------------
-spop_address | **Optional.** The host's address. Defaults to "$address$" or "$address6$" if the `address` attribute is not set.
+spop_address | **Optional.** The host's address. Defaults to "$address$" if the host's `address` attribute is set, "$address6$" otherwise.
spop_port | **Optional.** The host's port.
Check command object for the `check_ssh` plugin.
-Custom Attributes:
+Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
Name | Description
----------------|--------------
-ssh_address | **Optional.** The host's address. Defaults to "$address$" or "$address6$" if the `address` attribute is not set.
+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.
Check command object for the `check_tcp` plugin, using ssl-related options.
-Custom Attributes:
+Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
Name | Description
------------------------------|--------------
-ssl_address | **Optional.** The host's address. Defaults to "$address$" or "$address6$" if the `address` attribute is not set.
+ssl_address | **Optional.** The host's address. Defaults to "$address$" if the host's `address` attribute is set, "$address6$" otherwise.
ssl_port | **Required.** The port that should be checked.
ssl_timeout | **Optional.** Timeout in seconds for the connect and handshake. The plugin default is 10 seconds.
ssl_cert_valid_days_warn | **Optional.** Warning threshold for days before the certificate will expire. When used, ssl_cert_valid_days_critical must also be set.
Check command object for the `check_ssmtp` plugin.
-Custom Attributes:
+Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
Name | Description
----------------|--------------
-ssmtp_address | **Required.** The host's address. Defaults to "$address$" or "$address6$" if the `address` attribute is not set.
+ssmtp_address | **Required.** 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.
Check command object for the `check_swap` plugin.
-Custom Attributes:
+Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
Name | Description
----------------|--------------
Check command object for the `check_tcp` plugin.
-Custom Attributes:
+Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
Name | Description
----------------|--------------
-tcp_address | **Optional.** The host's address. Defaults to "$address$" or "$address6$" if the `address` attribute is not set.
+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 (may be repeated).
+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) - seperated by comma.
+tcp_ssl | **Optional.** Use SSL for the connection. Defaults to false.
+tcp_wtime | **Optional.** Response time to result in warning status (seconds).
+tcp_ctime | **Optional.** Response time to result in critical status (seconds).
+tcp_timeout | **Optional.** Seconds before connection times out. Defaults to 10.
## <a id="plugin-check-command-udp"></a> udp
Check command object for the `check_udp` plugin.
-Custom Attributes:
+Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
Name | Description
----------------|--------------
-udp_address | **Optional.** The host's address. Defaults to "$address$" or "$address6$" if the `address` attribute is not set.
+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.
Check command object for the `check_ups` plugin.
-Custom Attributes:
+Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
Name | Description
----------------|--------------
-ups_address | **Optional.** The host's address. Defaults to "$address$" or "$address6$" if the `address` attribute is not set.
-ups_name | **Optional.** The UPS name. Defaults to `ups`.
+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.
## <a id="plugin-check-command-users"></a> users
Check command object for the `check_users` plugin.
-Custom Attributes:
+Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-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.
+
+# <a id="windows-plugins"></a>Icinga 2 Windows plugins
+
+To allow a basic monitoring of Windows clients Icinga 2 comes with a set of Windows only plugins. While trying to mirror the functionalities of their linux cousins from the monitoring-plugins package, the differences between Windows and Linux are too big to be able use the same CheckCommands for both systems.
+
+A check-commands-windows.conf comes with Icinga 2, it asumes that the Windows Plugins are installed in the PluginDir set in your constants.conf. To enable them the following include directive is needed in you icinga2.conf:
+
+ include <windows-plugins>
+
+One of the differences between the Windows plugins and their linux counterparts is that they consistently do not require thresholds to run, functioning like dummies without.
+
+
+## <a id"windows-plugins-thresholds"></a>Threshold syntax
+
+So not specified differently the thresholds for the plugins all follow the same pattern
+
+Threshold | Meaning
+:------------|:----------
+"29" | The threshold is 29.
+"!29" | The threshold is 29, but the negative of the result is returned.
+"[10-40]" | The threshold is a range from (including) 20 to 40, a value inside means the threshold has been exceeded.
+"![10-40]" | Same as above, but the result is inverted.
+
+
+## <a id="windows-plugins-disk-windows"></a>disk-windows
+
+Check command object for the `check_disk.exe` plugin.
+Aggregates the free disk space of all volumes and mount points it can find, or the ones defined in `disk_win_path`. Ignores removable storage like fash drives and discs (CD, DVD etc.).
+
+Custom attributes:
+
+Name | Description
+:---------------|:------------
+disk\_win\_warn | **Optional**. The warning threshold.
+disk\_win\_crit | **Optional**. The critical threshold.
+disk\_win\_path | **Optional**. Check only these paths, default checks all.
+disk\_win\_unit | **Optional**. Use this unit to display disk space, thresholds are interpreted in this unit. Defaults to "mb", possible values are: b, kb, mb, gb and tb.
+
+
+## <a id="windows-plugins-load-windows"></a>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`](7-icinga-template-library.md#windows-plugins-load-windows).
+
+Custom attributes:
+
+Name | Description
+:---------------|:------------
+load\_win\_warn | **Optional**. The warning threshold.
+load\_win\_crit | **Optional**. The critical threshold.
+
+
+## <a id="windows-plugins-memory-windows"></a>memory-windows
+
+Check command object for the `check_memory.exe` plugin.
+The memory collection is instant.
+
+Custom attributes:
+
+Name | Description
+:-----------------|:------------
+memory\_win\_warn | **Optional**. The warning threshold.
+memory\_win\_crit | **Optional**. The critical threshold.
+memory\_win\_unit | **Optional**. The unit to display the received value in, thresholds are interpreted in this unit. Defaults to "mb" (megabye), possible values are: b, kb, mb, gb and tb.
+
+
+## <a id="windows-plugins-network-windows"></a>network-windows
+
+Check command object for the `check_network.exe` plugin.
+Collects the total Bytes inbount and outbound for all interfaces in one second, to itemise interfaces or use a different collection interval use [`perfmon-windows`](7-icinga-template-library.md#windows-plugins-load-windows).
+
+Custom attributes:
+
+Name | Description
+:------------------|:------------
+network\_win\_warn | **Optional**. The warning threshold.
+network\_win\_crit | **Optional**. The critical threshold.
+
+
+## <a id="windows-plugins-permon-windows"></a>perfmon-windows
+
+Check command object for the `check_perfmon.exe` plugin.
+This plugins allows to collect data from a Performance Counter. After the first data collection a second one is done after `perfmon_win_wait` milliseconds. When you know `perfmon_win_counter` only requires one set of data to provide valid data you can set `perfmon_win_wait` to `0`.
+
+To recieve a list of possible Performance Counter Objects run `check_perfmon.exe --print-objects` and to view an objects instances and counters run `check_perfmon.exe --print-object-info -P "name of object"`
+
+Custom attributes:
+
+Name | Description
+:---------------------|:------------
+perfmon\_win\_warn | **Optional**. The warning threshold.
+perfmon\_win\_crit | **Optional**. The critical threshold.
+perfmon\_win\_counter | **Required**. The Performance Counter to use. Ex. `\Processor(_Total)\% Idle Time`.
+perfmon\_win\_wait | **Optional**. Time in milliseconds to wait between data collection (default: 1000).
+perfmon\_win\_type | **Optional**. Format in which to expect perfomance values. Possible are: long, int64 and double (default).
+
+
+## <a id="windows-plugins-ping-windows"></a>ping-windows
+
+Check command object for the `check_ping.exe` plugin.
+ping-windows should automaticly detect whether `ping_win_address` is an IPv4 or IPv6 address, if not use ping4-windows and ping6-windows. Also note that check\_ping.exe waits at least `ping_win_timeout` milliseconds between the pings.
+
+Custom attributes:
+
+Name | Description
+:------------------|:------------
+ping\_win\_warn | **Optional**. The warning threshold. RTA and package loss seperated by comma.
+ping\_win\_crit | **Optional**. The critical threshold. RTA and package loss seperated 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
+
+
+## <a id="windows-plugins-procs-windows"></a>procs-windows
+
+Check command object for `check_procs.exe` plugin.
+When useing `procs_win_user` this plugins needs adminstratice privileges to access the processes of other users, to just enumerate them no additional privileges are required.
+
+Custom attributes:
+
+Name | Description
+:----------------|:------------
+procs\_win\_warn | **Optional**. The warning threshold.
+procs\_win\_crit | **Optional**. The critical threshold.
+procs\_win\_user | **Optional**. Count this useres processes.
+
+
+## <a id="windows-plugins-service-windows"></a>service-windows
+
+Check command object for `check_service.exe` plugin.
+This checks thresholds work different since the binary decision whether a service is running or not does not allow for three states. As a default `check_service.exe` will return CRITICAL when `service_win_service` is not running, the `service_win_warn` flag changes this to WARNING.
+
+Custom attributes:
+
+Name | Description
+:---------------------|:------------
+service\_win\_warn | **Optional**. Warn when service is not running.
+service\_win\_service | **Required**. The critical threshold.
+
+
+## <a id="windows-plugins-swap-windows"></a>swap-windows
+
+Check command object for `check_swap.exe` plugin.
+The data collection is instant.
+
+Custom attributes:
+
+Name | Description
+:---------------|:------------
+swap\_win\_warn | **Optional**. The warning threshold.
+swap\_win\_crit | **Optional**. The critical threshold.
+swap\_win\_unit | **Optional**. The unit to display the received value in, thresholds are interpreted in this unit. Defaults to "mb" (megabyte).
+
+
+## <a id="windows-plugins-update-windows"></a>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.
+
+Custom attributes:
+
+Name | Description
+:-------------------|:------------
+update\_win\_warn | If set returns warning when important updates are available
+update\_win\_crit | If set return critical when important updates that require a reboot are available.
+update\_win\_reboot | Set to treat 'may need update' as 'definitely needs update'
+
+
+## <a id="windows-plugins-uptime-windows"></a>uptime-windows
+
+Check command opject for `check_uptime.exe` plugin.
+Uses GetTickCount64 to get the uptime, so boot time is not included.
+
+Custom attributes:
+
+Name | Description
+:-----------------|:------------
+uptime\_win\_warn | **Optional**. The warning threshold.
+uptime\_win\_crit | **Optional**. The critical threshold.
+uptime\_win\_unit | **Optional**. The unit to display the received value in, thresholds are interpreted in this unit. Defaults to "s"(seconds), possible values are ms (milliseconds), s, m (minutes), h (hours).
+
+
+## <a id="windows-plugins-users-windows"></a>users-windows
+
+Check command object for `check_users.exe` plugin.
+
+Custom attributes:
+
+Name | Description
+:----------------|:------------
+users\_win\_warn | **Optional**. The warning threshold.
+users\_win\_crit | **Optional**. The critical threshold.
+
+
# <a id="nscp-plugin-check-commands"></a> NSClient++ Check Commands
Icinga 2 can use the `nscp client` command to run arbitrary NSClient++ checks.
You can enable these check commands by adding the following the include directive in your
-[icinga2.conf](5-configuring-icinga-2.md#icinga2-conf) configuration file:
+[icinga2.conf](4-configuring-icinga-2.md#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](5-configuring-icinga-2.md#constants-conf) configuration
+the NscpPath constant in your [constants.conf](4-configuring-icinga-2.md#constants-conf) configuration
file:
const NscpPath = "C:\\Program Files (x86)\\NSClient++"
-By default the check commands assume that NSClient++ is installed in "C:\Program Files\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.
Check command object for NSClient++
-Custom Attributes:
+Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
Name | Description
----------------|--------------
nscp_path | **Optional.** Can be used to override the NSClient++ on a per-command basis. Defaults to NscpPath.
+nscp_log_level | **Optional.** The log level. Defaults to "critical".
+nscp_load_all | **Optional.** Whether to load all modules. Defaults to true.
nscp_boot | **Optional.** Whether to use the --boot option. Defaults to true.
nscp_query | **Required.** The NSClient++ query. Try `nscp client -q x` for a list.
nscp_arguments | **Optional.** An array of query arguments.
This command has the same custom attributes like the `nscp-local` check command.
+## <a id="nscp-check-local-disk"></a> nscp-local-disk
+
+Check command object for the `check_drivesize` NSClient++ plugin.
+
+This command has the same custom attributes like the `nscp-local` check command.
+
# <a id="snmp-manubulon-plugin-check-commands"></a> SNMP Manubulon Plugin Check Commands
The `SNMP Manubulon Plugin Check Commands` provide example configuration for plugin check
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](5-configuring-icinga-2.md#icinga2-conf) configuration file:
+[icinga2.conf](4-configuring-icinga-2.md#icinga2-conf) configuration file:
include <manubulon>
Check command object for the [check_snmp_load.pl](http://nagios.manubulon.com/snmp_load.html) plugin.
-Custom Attributes:
+Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
Name | Description
------------------------|--------------
-snmp_address | **Optional.** The host's address. Defaults to "$address$" or "$address6$" if the `address` attribute is not set.
+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 **snmp_v3** needs to be set. Defaults to false.
snmp_community | **Optional.** The SNMP community. Defaults to "public".
snmp_port | **Optional.** The SNMP port connection.
Check command object for the [check_snmp_mem.pl](http://nagios.manubulon.com/snmp_mem.html) plugin.
-Custom Attributes:
+Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
Name | Description
------------------------|--------------
-snmp_address | **Optional.** The host's address. Defaults to "$address$" or "$address6$" if the `address` attribute is not set.
+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 **snmp_v3** needs to be set. Defaults to false.
snmp_community | **Optional.** The SNMP community. Defaults to "public".
snmp_port | **Optional.** The SNMP port connection.
Check command object for the [check_snmp_storage.pl](http://nagios.manubulon.com/snmp_storage.html) plugin.
-Custom Attributes:
+Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
Name | Description
------------------------|--------------
-snmp_address | **Optional.** The host's address. Defaults to "$address$" or "$address6$" if the `address` attribute is not set.
+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 **snmp_v3** needs to be set. Defaults to false.
snmp_community | **Optional.** The SNMP community. Defaults to "public".
snmp_port | **Optional.** The SNMP port connection.
Check command object for the [check_snmp_int.pl](http://nagios.manubulon.com/snmp_int.html) plugin.
-Custom Attributes:
+Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
Name | Description
----------------------------|--------------
-snmp_address | **Optional.** The host's address. Defaults to "$address$" or "$address6$" if the `address` attribute is not set.
+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 **snmp_v3** needs to be set. Defaults to false.
snmp_community | **Optional.** The SNMP community. Defaults to "public".
snmp_port | **Optional.** The SNMP port connection.
Check command object for the [check_snmp_process.pl](http://nagios.manubulon.com/snmp_process.html) plugin.
-Custom Attributes:
+Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
Name | Description
------------------------|--------------
-snmp_address | **Optional.** The host's address. Defaults to "$address$" or "$address6$" if the `address` attribute is not set.
+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 **snmp_v3** needs to be set. Defaults to false.
snmp_community | **Optional.** The SNMP community. Defaults to "public".
snmp_port | **Optional.** The SNMP port connection.
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.
+## <a id="plugins-contrib-databases"></a> Databases
+
+All database plugins go in this category.
+
+### <a id="plugins-contrib-command-mssql_health"></a> mssql_health
+
+The plugin `mssql_health` utilises Perl DBD::Sybase based on FreeTDS to connect to MSSQL databases for monitoring.
+For release tarballs, detailed documentation especially on the different modes and scripts for creating a monitoring user see [https://labs.consol.de](https://labs.consol.de/nagios/check_mssql_health/). For development check [https://github.com](https://github.com/lausser/check_mssql_health).
+
+Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
+
+Name | Description
+---------------------------------|------------------------------------------------------------------------------------------------------------------------------
+mssql_health_hostname | **Optional.** Specifies the database hostname or address. No default because you typically use "mssql_health_server".
+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_username | **Optional.** The username for the database connection.
+mssql_health_password | **Optional.** The password for the database connection.
+mssql_health_warning | **Optional.** The warning threshold depending on the mode.
+mssql_health_critical | **Optional.** The critical threshold depending on the mode.
+mssql_health_mode | **Required.** The mode uses predefined keywords for the different checks. For example "connection-time", "database-free" or "sql".
+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_regexp | **Optional.** If set to true, "mssql_health_name" will be interpreted as a regular expression. Defaults to false.
+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_offlineok | **Optional.** Set this to true, if offline databases are perfectly ok for you. Defaults to false.
+mssql_health_commit | **Optional.** Set this to true to turn on autocommit for the dbd::sybase module. Defaults to false.
+
+### <a id="plugins-contrib-command-mysql_health"></a> mysql_health
+
+The plugin `mysql_health` utilises Perl DBD::MySQL to connect to MySQL databases for monitoring.
+For release tarballs and detailed documentation especially on the different modes and required permissions see [https://labs.consol.de](https://labs.consol.de/nagios/check_mysql_health/). For development check [https://github.com](https://github.com/lausser/check_mysql_health).
+
+Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-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_mode | **Required.** The mode uses predefined keywords for the different checks. For example "connection-time", "slave-lag" or "sql".
+mysql_health_name | **Optional.** The SQL statement to be executed with "mysql_health_mode" sql.
+mysql_health_name2 | **Optional.** If "mysql_health_name" is a sql statement, "mysql_health_name2" can be used to appear in the output and the performance data.
+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.
+
+### <a id="plugins-contrib-command-oracle_health"></a> oracle_health
+
+The plugin `oracle_health` utilises Perl DBD::Oracle based on oracle-instantclient-sdk or sqlplus to connect to Oracle databases for monitoring.
+For release tarballs and detailed documentation especially on the different modes and required permissions see [https://labs.consol.de](https://labs.consol.de/nagios/check_oracle_health/). For development check [https://github.com](https://github.com/lausser/check_oracle_health).
+
+Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-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_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.
+
+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 "oracle_home".
+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 "oracle_tns_admin".
+
+### <a id="plugins-contrib-command-postgres"></a> postgres
+
+The plugin `postgres` utilises the psql binary to connect to PostgreSQL databases for monitoring.
+For release tarballs and detailed documentation especially the different actions and required persmissions see [https://bucardo.org/wiki/Check_postgres](https://bucardo.org/wiki/Check_postgres). For development check [https://github.com](https://github.com/bucardo/check_postgres).
+
+Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-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 continious 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.
+
+### <a id="plugins-contrib-command-mongodb"></a> mongodb
+
+The plugin `mongodb` utilises Python PyMongo.
+For development check [https://github.com](https://github.com/mzupan/nagios-plugin-mongodb).
+
+Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
+
+Name | Description
+---------------------------------|------------------------------------------------------------------------------------------------------------------------------
+mongodb_host | **Required.** Specifies the hostname or address.
+mongodb_port | **Required.** The port mongodb is runnung on.
+mongodb_user | **Optional.** The username you want to login as
+mongodb_passwd | **Optional.** The password you want to use for that user
+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_replicaset | **Optional.** Connect to replicaset
+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
+
## <a id="plugins-contrib-ipmi"></a> IPMI Devices
This category includes all plugins for IPMI devices.
With the plugin `ipmi-sensor` provided by <a href="https://www.thomas-krenn.com/">Thomas-Krenn.AG</a> you can monitor sensor data for IPMI devices. See https://www.thomas-krenn.com/en/wiki/IPMI_Sensor_Monitoring_Plugin for installation and configuration instructions.
-Custom Attributes:
+Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
Name | Description
---------------------------------|-----------------------------------------------------------------------------------------------------
The plugin `interfacetable` generates a html page containing information about the monitored node and all of its interfaces. The actively developed and maintained version is `interfacetable_v3t` provided by `Yannick Charton` on [http://www.tontonitch.com](http://www.tontonitch.com/tiki/tiki-index.php?page=Nagios+plugins+-+interfacetable_v3t) or [https://github.com](https://github.com/Tontonitch/interfacetable_v3t).
-Custom Attributes:
+Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
Name | Description
------------------------------------|-----------------------------------------------------------------------------------------------------
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.
+### <a id="plugins-contrib-command-iftraffic"></a> iftraffic
+
+The plugin [check_iftraffic](https://exchange.icinga.org/exchange/iftraffic)
+checks the utilization of a given interface name using the SNMP protocol.
+
+Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
+
+Name | Description
+------------------------|---------------------------------------------------------
+iftraffic_address | **Required.** Specifies the remote host. Defaults to "$address$".
+iftraffic_community | **Optional.** SNMP community. Defaults to "public'" if omitted.
+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.
+
## <a id="plugins-contrib-web"></a> Web
This category includes all plugins for web-based checks.
Check command object for the [check_webinject](http://http://www.webinject.org/manual.html) plugin.
-Custom Attributes:
+Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
Name | Description
------------------------|--------------
The plugin `mem` is used for gathering information about memory usage on linux and unix hosts. It is able to count cache memory as free when comparing it to the thresholds. It is provided by `Justin Ellison` on [https://github.com](https://github.com/justintime/nagios-plugins). For more details see the developers blog [http://sysadminsjourney.com](http://sysadminsjourney.com/content/2009/06/04/new-and-improved-checkmempl-nagios-plugin).
-Custom Attributes:
+Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
Name | Description
-------------|-----------------------------------------------------------------------------------------------------------------------
mem_warning | **Required.** Specifiy the warning threshold as number interpreted as percent.
mem_critical | **Required.** Specifiy the critical threshold as number interpreted as percent.
+## <a id="plugin-contrib-command-running-kernel"></a> running_kernel
+
+Check command object for the `check_running_kernel` plugin
+provided by the `nagios-plugins-contrib` package on Debian.
+
+The `running_kernel` check command does not support any vars.
+
+
## <a id="plugins-contrib-virtualization"></a> Virtualization
This category includes all plugins for various virtualization technologies.
The plugin `esxi_hardware` is a plugin to monitor hardware of ESXi servers through the vmware api and cim service. It is provided by `Claudio Kuenzler` on [http://www.claudiokuenzler.com](http://www.claudiokuenzler.com/nagios-plugins/check_esxi_hardware.php). For instruction on creating the required local user and workarounds for some hardware types have a look on his homepage.
-Custom Attributes:
+Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
Name | Description
------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
Check command object for the `check_vmware_esx` plugin. Shows all datastore volumes info.
-Custom Attributes:
+Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
Name | Description
------------------------|--------------
Check command object for the `check_vmware_esx` plugin. Shows all runtime info for the datacenter/Vcenter.
-Custom Attributes:
+Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
Name | Description
------------------------|--------------
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 Attributes:
+Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
Name | Description
------------------------|--------------
Check command object for the `check_vmware_esx` plugin. List of VMware ESX hosts and their power state.
-Custom Attributes:
+Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
Name | Description
------------------------|--------------
Check command object for the `check_vmware_esx` plugin. List of VMware clusters and their states.
-Custom Attributes:
+Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
Name | Description
------------------------|--------------
Check command object for the `check_vmware_esx` plugin. All issues for the host.
-Custom Attributes:
+Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
Name | Description
------------------------|--------------
Check command object for the `check_vmware_esx` plugin. Overall object status (gray/green/red/yellow).
-Custom Attributes:
+Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
Name | Description
------------------------|--------------
Check command object for the `check_vmware_esx` plugin. Vmware Tools status.
-Custom Attributes:
+Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
Name | Description
------------------------|--------------
Check command object for the `check_vmware_esx` plugin. Simple check to verify a successfull connection to VMware SOAP API.
-Custom Attributes:
+Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
Name | Description
------------------------|--------------
Check command object for the `check_vmware_esx` plugin. Displays uptime of the VMware host.
-Custom Attributes:
+Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
Name | Description
------------------------|--------------
Check command object for the `check_vmware_esx` plugin. CPU usage in percentage.
-Custom Attributes:
+Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
Name | Description
------------------------|--------------
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 Attributes:
+Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
Name | Description
------------------------|--------------
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 Attributes:
+Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
Name | Description
------------------------|--------------
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 Attributes:
+Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
Name | Description
------------------------|--------------
Check command object for the `check_vmware_esx` plugin. All mem info(except overall and no thresholds).
-Custom Attributes:
+Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
Name | Description
------------------------|--------------
Check command object for the `check_vmware_esx` plugin. Average mem usage in percentage.
-Custom Attributes:
+Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
Name | Description
------------------------|--------------
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 Attributes:
+Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
Name | Description
------------------------|--------------
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 Attributes:
+Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
Name | Description
------------------------|--------------
Check command object for the `check_vmware_esx` plugin. Additional mem used by VM Server in MB.
-Custom Attributes:
+Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
Name | Description
------------------------|--------------
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 Attributes:
+Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
Name | Description
------------------------|--------------
Check command object for the `check_vmware_esx` plugin. Shows net info.
-Custom Attributes:
+Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
Name | Description
------------------------|--------------
Check command object for the `check_vmware_esx` plugin. Overall network usage in KBps(Kilobytes per Second).
-Custom Attributes:
+Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
Name | Description
------------------------|--------------
Check command object for the `check_vmware_esx` plugin. Data receive in KBps(Kilobytes per Second).
-Custom Attributes:
+Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
Name | Description
------------------------|--------------
Check command object for the `check_vmware_esx` plugin. Data send in KBps(Kilobytes per Second).
-Custom Attributes:
+Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
Name | Description
------------------------|--------------
Check command object for the `check_vmware_esx` plugin. Check all active NICs.
-Custom Attributes:
+Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
Name | Description
------------------------|--------------
Check command object for the `check_vmware_esx` plugin. Shows all datastore volumes info.
-Custom Attributes:
+Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
Name | Description
------------------------|--------------
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 Attributes:
+Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
Name | Description
------------------------|--------------
Check command object for the `check_vmware_esx` plugin. Number of aborted SCSI commands.
-Custom Attributes:
+Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
Name | Description
------------------------|--------------
Check command object for the `check_vmware_esx` plugin. Number of SCSI bus resets.
-Custom Attributes:
+Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
Name | Description
------------------------|--------------
Check command object for the `check_vmware_esx` plugin. Average number of kilobytes read from the disk each second.
-Custom Attributes:
+Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
Name | Description
------------------------|--------------
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 Attributes:
+Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
Name | Description
------------------------|--------------
Check command object for the `check_vmware_esx` plugin. Average number of kilobytes written to disk each second.
-Custom Attributes:
+Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
Name | Description
------------------------|--------------
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 Attributes:
+Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
Name | Description
------------------------|--------------
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 Attributes:
+Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
Name | Description
------------------------|--------------
Check command object for the `check_vmware_esx` plugin. Average amount of time (ms) spent by VMkernel processing each SCSI command.
-Custom Attributes:
+Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
Name | Description
------------------------|--------------
Check command object for the `check_vmware_esx` plugin. Average amount of time (ms) to complete a SCSI command from the physical device.
-Custom Attributes:
+Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
Name | Description
------------------------|--------------
Check command object for the `check_vmware_esx` plugin. Average amount of time (ms) spent in the VMkernel queue.
-Custom Attributes:
+Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
Name | Description
------------------------|--------------
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 Attributes:
+Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
Name | Description
------------------------|--------------
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 Attributes:
+Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
Name | Description
------------------------|--------------
Check command object for the `check_vmware_esx` plugin. Shows host service info.
-Custom Attributes:
+Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
Name | Description
------------------------|--------------
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 Attributes:
+Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
Name | Description
------------------------|--------------
Check command object for the `check_vmware_esx` plugin. Shows connection state.
-Custom Attributes:
+Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
Name | Description
------------------------|--------------
Check command object for the `check_vmware_esx` plugin. List of VMware machines and their status.
-Custom Attributes:
+Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
Name | Description
------------------------|--------------
Check command object for the `check_vmware_esx` plugin. Overall object status (gray/green/red/yellow).
-Custom Attributes:
+Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
Name | Description
------------------------|--------------
Check command object for the `check_vmware_esx` plugin. Checks cpu/storage/memory/sensor status.
-Custom Attributes:
+Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
Name | Description
------------------------|--------------
Check command object for the `check_vmware_esx` plugin. List all available sensors(use for listing purpose only).
-Custom Attributes:
+Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
Name | Description
------------------------|--------------
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 Attributes:
+Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
Name | Description
------------------------|--------------
Check command object for the `check_vmware_esx` plugin. Local storage status check.
-Custom Attributes:
+Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
Name | Description
------------------------|--------------
Check command object for the `check_vmware_esx` plugin. Lists all temperature sensors.
-Custom Attributes:
+Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
Name | Description
------------------------|--------------
Check command object for the `check_vmware_esx` plugin. Lists all configuration issues for the host.
-Custom Attributes:
+Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
Name | Description
------------------------|--------------
Check command object for the `check_vmware_esx` plugin. Shows Host storage info.
-Custom Attributes:
+Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
Name | Description
------------------------|--------------
Check command object for the `check_vmware_esx` plugin. List host bus adapters.
-Custom Attributes:
+Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
Name | Description
------------------------|--------------
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 Attributes:
+Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
Name | Description
------------------------|--------------
Check command object for the `check_vmware_esx` plugin. List multipaths and the associated paths.
-Custom Attributes:
+Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
Name | Description
------------------------|--------------
Check command object for the `check_vmware_esx` plugin. Shows all CPU usage info.
-Custom Attributes:
+Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
Name | Description
------------------------|--------------
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 Attributes:
+Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
Name | Description
------------------------|--------------
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 Attributes:
+Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
Name | Description
------------------------|--------------
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 Attributes:
+Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
Name | Description
------------------------|--------------
Check command object for the `check_vmware_esx` plugin. Shows all memory info, except overall.
-Custom Attributes:
+Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
Name | Description
------------------------|--------------
Check command object for the `check_vmware_esx` plugin. Average mem usage in percentage of configured virtual machine "physical" memory.
-Custom Attributes:
+Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
Name | Description
------------------------|--------------
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.<br>
**vm consumed memory = memory granted - memory saved**
-Custom Attributes:
+Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
Name | Description
------------------------|--------------
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 Attributes:
+Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
Name | Description
------------------------|--------------
Check command object for the `check_vmware_esx` plugin. Shows net info.
-Custom Attributes:
+Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
Name | Description
------------------------|--------------
Check command object for the `check_vmware_esx` plugin. Overall network usage in KBps(Kilobytes per Second).
-Custom Attributes:
+Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
Name | Description
------------------------|--------------
Check command object for the `check_vmware_esx` plugin. Receive in KBps(Kilobytes per Second).
-Custom Attributes:
+Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
Name | Description
------------------------|--------------
Check command object for the `check_vmware_esx` plugin. Send in KBps(Kilobytes per Second).
-Custom Attributes:
+Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
Name | Description
------------------------|--------------
Check command object for the `check_vmware_esx` plugin. SShows 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 Attributes:
+Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
Name | Description
------------------------|--------------
Check command object for the `check_vmware_esx` plugin. Average number of kilobytes read from the disk each second.
-Custom Attributes:
+Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
Name | Description
------------------------|--------------
Check command object for the `check_vmware_esx` plugin. Average number of kilobytes written to disk each second.
-Custom Attributes:
+Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
Name | Description
------------------------|--------------
Check command object for the `check_vmware_esx` plugin. Aggregated disk I/O rate.
-Custom Attributes:
+Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
Name | Description
------------------------|--------------
Check command object for the `check_vmware_esx` plugin. Shows virtual machine runtime info.
-Custom Attributes:
+Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
Name | Description
------------------------|--------------
Check command object for the `check_vmware_esx` plugin. Shows the connection state.
-Custom Attributes:
+Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
Name | Description
------------------------|--------------
Check command object for the `check_vmware_esx` plugin. Shows virtual machine power state: poweredOn, poweredOff or suspended.
-Custom Attributes:
+Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
Name | Description
------------------------|--------------
Check command object for the `check_vmware_esx` plugin. Overall object status (gray/green/red/yellow).
-Custom Attributes:
+Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
Name | Description
------------------------|--------------
Check command object for the `check_vmware_esx` plugin. Console connections to virtual machine.
-Custom Attributes:
+Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
Name | Description
------------------------|--------------
Check command object for the `check_vmware_esx` plugin. Guest OS status. Needs VMware Tools installed and running.
-Custom Attributes:
+Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
Name | Description
------------------------|--------------
Check command object for the `check_vmware_esx` plugin. Guest OS status. VMware tools status.
-Custom Attributes:
+Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
Name | Description
------------------------|--------------
Check command object for the `check_vmware_esx` plugin. All issues for the virtual machine.
-Custom Attributes:
+Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
Name | Description
------------------------|--------------
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 <br> **Autentication file content:** <br> username=vmuser <br> 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.
-
projects / icinga2 / blobdiff