1# Icinga Template Library <a id="icinga-template-library"></a> 2 3The Icinga Template Library (ITL) implements standard templates 4and object definitions. 5 6There is a subset of templates and object definitions available: 7 8* [Generic ITL templates](10-icinga-template-library.md#itl-generic-templates) 9* [CheckCommand definitions for Icinga 2](10-icinga-template-library.md#itl-check-commands) (this includes [icinga](10-icinga-template-library.md#itl-icinga), 10[cluster](10-icinga-template-library.md#itl-icinga-cluster), [cluster-zone](10-icinga-template-library.md#itl-icinga-cluster-zone), [ido](10-icinga-template-library.md#itl-icinga-ido), etc.) 11* [CheckCommand definitions for Monitoring Plugins](10-icinga-template-library.md#plugin-check-commands-monitoring-plugins) 12* [CheckCommand definitions for Icinga 2 Windows Plugins](10-icinga-template-library.md#windows-plugins) 13* [CheckCommand definitions for NSClient++](10-icinga-template-library.md#nscp-plugin-check-commands) 14* [CheckCommand definitions for Manubulon SNMP](10-icinga-template-library.md#snmp-manubulon-plugin-check-commands) 15* [Contributed CheckCommand definitions](10-icinga-template-library.md#plugin-contrib) 16 17The ITL content is updated with new releases. Please do not modify 18templates and/or objects as changes will be overridden without 19further notice. 20 21You are advised to create your own CheckCommand definitions in 22`/etc/icinga2`. 23 24## Generic Templates <a id="itl-generic-templates"></a> 25 26By default the generic templates are included in the [icinga2.conf](04-configuration.md#icinga2-conf) configuration file: 27 28``` 29include <itl> 30``` 31 32These templates are imported by the provided example configuration. 33 34> **Note**: 35> 36> These templates are built into the binaries. By convention 37> all command and timeperiod objects should import these templates. 38 39### plugin-check-command <a id="itl-plugin-check-command"></a> 40 41Command template for check plugins executed by Icinga 2. 42 43The `plugin-check-command` command does not support any vars. 44 45By default this template is automatically imported into all [CheckCommand](09-object-types.md#objecttype-checkcommand) definitions. 46 47### plugin-notification-command <a id="itl-plugin-notification-command"></a> 48 49Command template for notification scripts executed by Icinga 2. 50 51The `plugin-notification-command` command does not support any vars. 52 53By default this template is automatically imported into all [NotificationCommand](09-object-types.md#objecttype-notificationcommand) definitions. 54 55### plugin-event-command <a id="itl-plugin-event-command"></a> 56 57Command template for event handler scripts executed by Icinga 2. 58 59The `plugin-event-command` command does not support any vars. 60 61By default this template is automatically imported into all [EventCommand](09-object-types.md#objecttype-eventcommand) definitions. 62 63### legacy-timeperiod <a id="itl-legacy-timeperiod"></a> 64 65Timeperiod template for [TimePeriod objects](09-object-types.md#objecttype-timeperiod). 66 67The `legacy-timeperiod` timeperiod does not support any vars. 68 69By default this template is automatically imported into all [TimePeriod](09-object-types.md#objecttype-timeperiod) definitions. 70 71## Check Commands <a id="itl-check-commands"></a> 72 73These check commands are embedded into Icinga 2 and do not require any external 74plugin scripts. 75 76### icinga <a id="itl-icinga"></a> 77 78Check command for the built-in `icinga` check. This check returns performance 79data for the current Icinga instance, reports as warning if the last reload failed and optionally allows for minimum version checks. 80 81Custom variables passed as [command parameters](03-monitoring-basics.md#command-passing-parameters): 82 83Name | Description 84-----------------------|--------------- 85icinga\_min\_version | **Optional.** Required minimum Icinga 2 version, e.g. `2.8.0`. If not satisfied, the state changes to `Critical`. Release packages only. 86 87### cluster <a id="itl-icinga-cluster"></a> 88 89Check command for the built-in `cluster` check. This check returns performance 90data for the current Icinga instance and connected endpoints. 91 92The `cluster` check command does not support any vars. 93 94### cluster-zone <a id="itl-icinga-cluster-zone"></a> 95 96Check command for the built-in `cluster-zone` check. 97 98Custom variables passed as [command parameters](03-monitoring-basics.md#command-passing-parameters): 99 100Name | Description 101-----------------------|--------------- 102cluster\_zone | **Required.** The zone name. Defaults to `$host.name$`. 103cluster\_lag\_warning | **Optional.** Warning threshold for log lag in seconds. Applies if the log lag is greater than the threshold. 104cluster\_lag\_critical | **Optional.** Critical threshold for log lag in seconds. Applies if the log lag is greater than the threshold. 105 106### ido <a id="itl-icinga-ido"></a> 107 108Check command for the built-in `ido` check. 109 110Custom variables passed as [command parameters](03-monitoring-basics.md#command-passing-parameters): 111 112Name | Description 113--------------------------------|----------------------------- 114ido\_type | **Required.** The type of the IDO connection object. Can be either "IdoMysqlConnection" or "IdoPgsqlConnection". 115ido\_name | **Required.** The name of the IDO connection object. 116ido\_queries\_warning | **Optional.** Warning threshold for queries/s. Applies if the rate is lower than the threshold. 117ido\_queries\_critical | **Optional.** Critical threshold for queries/s. Applies if the rate is lower than the threshold. 118ido\_pending\_queries\_warning | **Optional.** Warning threshold for pending queries. Applies if pending queries are higher than the threshold. Supersedes the `ido_queries` thresholds above. 119ido\_pending\_queries\_critical | **Optional.** Critical threshold for pending queries. Applies if pending queries are higher than the threshold. Supersedes the `ido_queries` thresholds above. 120 121 122### dummy <a id="itl-dummy"></a> 123 124Check command for the built-in `dummy` check. This allows to set 125a check result state and output and can be used in [freshness checks](08-advanced-topics.md#check-result-freshness) 126or [runtime object checks](08-advanced-topics.md#access-object-attributes-at-runtime). 127In contrast to the [check_dummy](https://www.monitoring-plugins.org/doc/man/check_dummy.html) 128plugin, Icinga 2 implements a light-weight in memory check with 2.9+. 129 130Custom variables passed as [command parameters](03-monitoring-basics.md#command-passing-parameters): 131 132Name | Description 133----------------|-------------- 134dummy\_state | **Optional.** The state. Can be one of 0 (ok), 1 (warning), 2 (critical) and 3 (unknown). Defaults to 0. 135dummy\_text | **Optional.** Plugin output. Defaults to "Check was successful.". 136 137### passive <a id="itl-check-command-passive"></a> 138 139Specialised check command object for passive checks which uses the functionality of the "dummy" check command with appropriate default values. 140 141Custom variables passed as [command parameters](03-monitoring-basics.md#command-passing-parameters): 142 143Name | Description 144----------------|-------------- 145dummy_state | **Optional.** The state. Can be one of 0 (ok), 1 (warning), 2 (critical) and 3 (unknown). Defaults to 3. 146dummy_text | **Optional.** Plugin output. Defaults to "No Passive Check Result Received.". 147 148### random <a id="itl-random"></a> 149 150Check command for the built-in `random` check. This check returns random states 151and adds the check source to the check output. 152 153For test and demo purposes only. The `random` check command does not support 154any vars. 155 156### exception <a id="itl-exception"></a> 157 158Check command for the built-in `exception` check. This check throws an exception. 159 160For test and demo purposes only. The `exception` check command does not support 161any vars. 162 163### sleep <a id="itl-sleep"></a> 164 165Check command for the built-in `sleep` check. This allows to use sleep for testing 166and debugging only. 167 168Name | Description 169----------------|-------------- 170sleep\_time | **Optional.** The duration of the sleep in seconds. Defaults to 1s. 171 172<!-- keep this anchor for URL link history only --> 173<a id="plugin-check-commands"></a> 174 175## Plugin Check Commands for Monitoring Plugins <a id="plugin-check-commands-monitoring-plugins"></a> 176 177The Plugin Check Commands provides example configuration for plugin check commands 178provided by the [Monitoring Plugins](https://www.monitoring-plugins.org) project. 179 180By default the Plugin Check Commands are included in the [icinga2.conf](04-configuration.md#icinga2-conf) configuration 181file: 182 183 include <plugins> 184 185The plugin check commands assume that there's a global constant named `PluginDir` 186which contains the path of the plugins from the Monitoring Plugins project. 187 188> **Note**: 189> 190> Please be aware that the CheckCommand definitions are based on the [Monitoring Plugins](https://www.monitoring-plugins.org), other Plugin collections might not support 191> all parameters. If there are command parameters missing for the provided CheckCommand definitions please kindly send a patch upstream. 192> This should include an update for the ITL CheckCommand itself and this documentation section. 193 194### apt <a id="plugin-check-command-apt"></a> 195 196The plugin [apt](https://www.monitoring-plugins.org/doc/man/check_apt.html) checks for software updates on systems that use 197package management systems based on the apt-get(8) command found in Debian based systems. 198 199Custom variables passed as [command parameters](03-monitoring-basics.md#command-passing-parameters): 200 201Name | Description 202------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- 203apt_extra_opts | **Optional.** Read options from an ini file. 204apt_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. 205apt_dist_upgrade | **Optional.** Perform a dist-upgrade instead of normal upgrade. Like with -U OPTS can be provided to override the default options. 206apt_include | **Optional.** Include only packages matching REGEXP. Can be specified multiple times the values will be combined together. 207apt_exclude | **Optional.** Exclude packages matching REGEXP from the list of packages that would otherwise be included. Can be specified multiple times. 208apt_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. 209apt_timeout | **Optional.** Seconds before plugin times out (default: 10). 210apt_only_critical | **Optional.** Only warn about critical upgrades. 211apt_list | **Optional.** List packages available for upgrade. 212 213 214### breeze <a id="plugin-check-command-breeze"></a> 215 216The [check_breeze](https://www.monitoring-plugins.org/doc/man/check_breeze.html) plugin reports the signal 217strength of a Breezecom wireless equipment. 218 219Custom variables passed as [command parameters](03-monitoring-basics.md#command-passing-parameters): 220 221Name | Description 222-----------------|--------------------------------- 223breeze_hostname | **Required.** Name or IP address of host to check. Defaults to "$address$" if the host's `address` attribute is set, "$address6$" otherwise. 224breeze_community | **Optional.** SNMPv1 community. Defaults to "public". 225breeze_warning | **Required.** Percentage strength below which a WARNING status will result. Defaults to 50. 226breeze_critical | **Required.** Percentage strength below which a WARNING status will result. Defaults to 20. 227 228 229### by_ssh <a id="plugin-check-command-by-ssh"></a> 230 231The [check_by_ssh](https://www.monitoring-plugins.org/doc/man/check_by_ssh.html) plugin uses SSH to execute 232commands on a remote host. 233 234Custom variables passed as [command parameters](03-monitoring-basics.md#command-passing-parameters): 235 236Name | Description 237---------------- | -------------- 238by_ssh_address | **Optional.** The host's address. Defaults to "$address$" if the host's `address` attribute is set, "$address6$" otherwise. 239by_ssh_port | **Optional.** The SSH port. Defaults to 22. 240by_ssh_command | **Required.** The command that should be executed. Can be an array if multiple arguments should be passed to `check_by_ssh`. 241by_ssh_arguments | **Optional.** A dictionary with arguments for the command. This works exactly like the 'arguments' dictionary for ordinary CheckCommands. 242by_ssh_logname | **Optional.** The SSH username. 243by_ssh_identity | **Optional.** The SSH identity. 244by_ssh_quiet | **Optional.** Whether to suppress SSH warnings. Defaults to false. 245by_ssh_warn | **Optional.** The warning threshold. 246by_ssh_crit | **Optional.** The critical threshold. 247by_ssh_timeout | **Optional.** The timeout in seconds. 248by_ssh_options | **Optional.** Call ssh with '-o OPTION' (multiple options may be specified as an array). 249by_ssh_ipv4 | **Optional.** Use IPv4 connection. Defaults to false. 250by_ssh_ipv6 | **Optional.** Use IPv6 connection. Defaults to false. 251by_ssh_skip_stderr | **Optional.** Ignore all or (if specified) first n lines on STDERR. 252 253 254### clamd <a id="plugin-check-command-clamd"></a> 255 256The [check_clamd](https://www.monitoring-plugins.org/doc/man/check_clamd.html) plugin tests CLAMD 257connections with the specified host (or unix socket). 258 259Custom variables passed as [command parameters](03-monitoring-basics.md#command-passing-parameters): 260 261Name | Description 262-------------------|-------------- 263clamd_address | **Required.** The host's address or unix socket (must be an absolute path). 264clamd_port | **Optional.** Port number (default: none). 265clamd_expect | **Optional.** String to expect in server response. Multiple strings must be defined as array. 266clamd_all | **Optional.** All expect strings need to occur in server response. Defaults to false. 267clamd_escape_send | **Optional.** Enable usage of \\n, \\r, \\t or \\\\ in send string. 268clamd_send | **Optional.** String to send to the server. 269clamd_escape_quit | **Optional.** Enable usage of \\n, \\r, \\t or \\\\ in quit string. 270clamd_quit | **Optional.** String to send server to initiate a clean close of the connection. 271clamd_refuse | **Optional.** Accept TCP refusals with states ok, warn, crit. Defaults to crit. 272clamd_mismatch | **Optional.** Accept expected string mismatches with states ok, warn, crit. Defaults to warn. 273clamd_jail | **Optional.** Hide output from TCP socket. 274clamd_maxbytes | **Optional.** Close connection once more than this number of bytes are received. 275clamd_delay | **Optional.** Seconds to wait between sending string and polling for response. 276clamd_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. 277clamd_ssl | **Optional.** Use SSL for the connection. Defaults to false. 278clamd_wtime | **Optional.** Response time to result in warning status (seconds). 279clamd_ctime | **Optional.** Response time to result in critical status (seconds). 280clamd_timeout | **Optional.** Seconds before connection times out. Defaults to 10. 281clamd_ipv4 | **Optional.** Use IPv4 connection. Defaults to false. 282clamd_ipv6 | **Optional.** Use IPv6 connection. Defaults to false. 283 284 285### dhcp <a id="plugin-check-command-dhcp"></a> 286 287The [check_dhcp](https://www.monitoring-plugins.org/doc/man/check_dhcp.html) plugin 288tests the availability of DHCP servers on a network. 289 290Custom variables passed as [command parameters](03-monitoring-basics.md#command-passing-parameters): 291 292Name | Description 293----------------|-------------- 294dhcp_serverip | **Optional.** The IP address of the DHCP server which we should get a response from. 295dhcp_requestedip| **Optional.** The IP address which we should be offered by a DHCP server. 296dhcp_timeout | **Optional.** The timeout in seconds. 297dhcp_interface | **Optional.** The interface to use. 298dhcp_mac | **Optional.** The MAC address to use in the DHCP request. 299dhcp_unicast | **Optional.** Whether to use unicast requests. Defaults to false. 300 301 302### dig <a id="plugin-check-command-dig"></a> 303 304The [check_dig](https://www.monitoring-plugins.org/doc/man/check_dig.html) plugin 305test the DNS service on the specified host using dig. 306 307Custom variables passed as [command parameters](03-monitoring-basics.md#command-passing-parameters): 308 309Name | Description 310---------------------|-------------- 311dig_server | **Optional.** The DNS server to query. Defaults to "127.0.0.1". 312dig_port | **Optional.** Port number (default: 53). 313dig_lookup | **Required.** The address that should be looked up. 314dig_record_type | **Optional.** Record type to lookup (default: A). 315dig_expected_address | **Optional.** An address expected to be in the answer section. If not set, uses whatever was in -l. 316dig_arguments | **Optional.** Pass STRING as argument(s) to dig. 317dig_retries | **Optional.** Number of retries passed to dig, timeout is divided by this value (Default: 3). 318dig_warning | **Optional.** Response time to result in warning status (seconds). 319dig_critical | **Optional.** Response time to result in critical status (seconds). 320dig_timeout | **Optional.** Seconds before connection times out (default: 10). 321dig_ipv4 | **Optional.** Force dig to only use IPv4 query transport. Defaults to false. 322dig_ipv6 | **Optional.** Force dig to only use IPv6 query transport. Defaults to false. 323 324 325### disk <a id="plugin-check-command-disk"></a> 326 327The [check_disk](https://www.monitoring-plugins.org/doc/man/check_disk.html) plugin 328checks the amount of used disk space on a mounted file system and generates an alert 329if free space is less than one of the threshold values. 330 331Custom variables passed as [command parameters](03-monitoring-basics.md#command-passing-parameters): 332 333Name | Description 334--------------------|------------------------ 335disk\_wfree | **Optional.** The free space warning threshold. Defaults to "20%". If the percent sign is omitted, units from `disk_units` are used. 336disk\_cfree | **Optional.** The free space critical threshold. Defaults to "10%". If the percent sign is omitted, units from `disk_units` are used. 337disk\_inode\_wfree | **Optional.** The free inode warning threshold. 338disk\_inode\_cfree | **Optional.** The free inode critical threshold. 339disk\_partition | **Optional.** The partition. **Deprecated in 2.3.** 340disk\_partition\_excluded | **Optional.** The excluded partition. **Deprecated in 2.3.** 341disk\_partitions | **Optional.** The partition(s). Multiple partitions must be defined as array. 342disk\_partitions\_excluded | **Optional.** The excluded partition(s). Multiple partitions must be defined as array. 343disk\_clear | **Optional.** Clear thresholds. May be true or false. 344disk\_exact\_match | **Optional.** For paths or partitions specified with -p, only check for exact paths. May be true or false. 345disk\_errors\_only | **Optional.** Display only devices/mountpoints with errors. May be true or false. 346disk\_ignore\_reserved | **Optional.** If set, account root-reserved blocks are not accounted for freespace in perfdata. May be true or false. 347disk\_group | **Optional.** Group paths. Thresholds apply to (free-)space of all partitions together. 348disk\_kilobytes | **Optional.** Same as --units kB. May be true or false. 349disk\_local | **Optional.** Only check local filesystems. May be true or false. 350disk\_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. 351disk\_mountpoint | **Optional.** Display the mountpoint instead of the partition. May be true or false. 352disk\_megabytes | **Optional.** Same as --units MB. May be true or false. 353disk\_all | **Optional.** Explicitly select all paths. This is equivalent to -R '.\*'. May be true or false. 354disk\_eregi\_path | **Optional.** Case insensitive regular expression for path/partition. Multiple regular expression strings must be defined as array. 355disk\_ereg\_path | **Optional.** Regular expression for path or partition. Multiple regular expression strings must be defined as array. 356disk\_ignore\_eregi\_path | **Optional.** Regular expression to ignore selected path/partition (case insensitive). Multiple regular expression strings must be defined as array. 357disk\_ignore\_ereg\_path | **Optional.** Regular expression to ignore selected path or partition. Multiple regular expression strings must be defined as array. 358disk\_timeout | **Optional.** Seconds before connection times out (default: 10). 359disk\_units | **Optional.** Choose bytes, kB, MB, GB, TB (default: MB). 360disk\_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". 361disk\_include\_type | **Optional.** Check only filesystems of indicated type. Multiple regular expression strings must be defined as array. 362 363### disk_smb <a id="plugin-check-command-disk-smb"></a> 364 365The [check_disk_smb](https://www.monitoring-plugins.org/doc/man/check_disk_smb.html) plugin 366uses the `smbclient` binary to check SMB shares. 367 368Custom variables passed as [command parameters](03-monitoring-basics.md#command-passing-parameters): 369 370Name | Description 371------------------------|------------------------ 372disk_smb_hostname | **Required.** NetBIOS name of the server. 373disk_smb_share | **Required.** Share name being queried. 374disk_smb_workgroup | **Optional.** Workgroup or Domain used (defaults to 'WORKGROUP' if omitted). 375disk_smb_address | **Optional.** IP address of the host (only necessary if host belongs to another network). 376disk_smb_username | **Optional.** Username for server log-in (defaults to 'guest' if omitted). 377disk_smb_password | **Optional.** Password for server log-in (defaults to an empty password if omitted). 378disk_smb_wused | **Optional.** The used space warning threshold. Defaults to "85%". If the percent sign is omitted, use optional disk units. 379disk_smb_cused | **Optional.** The used space critical threshold. Defaults to "95%". If the percent sign is omitted, use optional disk units. 380disk_smb_port | **Optional.** Connection port, e.g. `139` or `445`. Defaults to `smbclient` default if omitted. 381 382### dns <a id="plugin-check-command-dns"></a> 383 384The [check_dns](https://www.monitoring-plugins.org/doc/man/check_dns.html) plugin 385uses the nslookup program to obtain the IP address for the given host/domain query. 386An optional DNS server to use may be specified. If no DNS server is specified, the 387default server(s) specified in `/etc/resolv.conf` will be used. 388 389Custom variables passed as [command parameters](03-monitoring-basics.md#command-passing-parameters): 390 391Name | Description 392---------------------|-------------- 393dns_lookup | **Optional.** The hostname or IP to query the DNS for. Defaults to "$host_name$". 394dns_server | **Optional.** The DNS server to query. Defaults to the server configured in the OS. 395dns_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.** 396dns_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. 397dns_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. 398dns_authoritative | **Optional.** Expect the server to send an authoritative answer. 399dns_accept_cname | **Optional.** Accept cname responses as a valid result to a query. 400dns_wtime | **Optional.** Return warning if elapsed time exceeds value. 401dns_ctime | **Optional.** Return critical if elapsed time exceeds value. 402dns_timeout | **Optional.** Seconds before connection times out. Defaults to 10. 403 404 405 406### file_age <a id="plugin-check-command-file-age"></a> 407 408The [check_file_age](https://www.monitoring-plugins.org/doc/man/check_file_age.html) plugin 409checks a file's size and modification time to make sure it's not empty and that it's sufficiently recent. 410 411Custom variables passed as [command parameters](03-monitoring-basics.md#command-passing-parameters): 412 413Name | Description 414-----------------------|-------------------------------------------------------------------------------------------------------- 415file_age_file | **Required.** File to monitor. 416file_age_warning_time | **Optional.** File must be no more than this many seconds old as warning threshold. Defaults to "240s". 417file_age_critical_time | **Optional.** File must be no more than this many seconds old as critical threshold. Defaults to "600s". 418file_age_warning_size | **Optional.** File must be at least this many bytes long as warning threshold. No default given. 419file_age_critical_size | **Optional.** File must be at least this many bytes long as critical threshold. Defaults to "0B". 420file_age_ignoremissing | **Optional.** Return OK if the file does not exist. Defaults to false. 421 422 423### flexlm <a id="plugin-check-command-flexlm"></a> 424 425The [check_flexlm](https://www.monitoring-plugins.org/doc/man/check_flexlm.html) plugin 426checks available flexlm license managers. Requires the `lmstat` command. 427 428Custom variables passed as [command parameters](03-monitoring-basics.md#command-passing-parameters): 429 430Name | Description 431-------------------|---------------------------------------------------------- 432flexlm_licensefile | **Required.** Name of license file (usually license.dat). 433flexlm_timeout | **Optional.** Plugin time out in seconds. Defaults to 15. 434 435 436### fping4 <a id="plugin-check-command-fping4"></a> 437 438The [check_fping](https://www.monitoring-plugins.org/doc/man/check_fping.html) plugin 439uses the `fping` command to ping the specified host for a fast check. Note that it is 440necessary to set the `suid` flag on `fping`. 441 442This CheckCommand expects an IPv4 address. 443 444Custom variables passed as [command parameters](03-monitoring-basics.md#command-passing-parameters): 445 446Name | Description 447----------------|-------------- 448fping_address | **Optional.** The host's IPv4 address. Defaults to "$address$". 449fping_wrta | **Optional.** The RTA warning threshold in milliseconds. Defaults to 100. 450fping_wpl | **Optional.** The packet loss warning threshold in %. Defaults to 5. 451fping_crta | **Optional.** The RTA critical threshold in milliseconds. Defaults to 200. 452fping_cpl | **Optional.** The packet loss critical threshold in %. Defaults to 15. 453fping_number | **Optional.** The number of packets to send. Defaults to 5. 454fping_interval | **Optional.** The interval between packets in milli-seconds. Defaults to 500. 455fping_bytes | **Optional.** The size of ICMP packet. 456fping_target_timeout | **Optional.** The target timeout in milli-seconds. 457fping_source_ip | **Optional.** The name or ip address of the source ip. 458fping_source_interface | **Optional.** The source interface name. 459 460 461### fping6 <a id="plugin-check-command-fping6"></a> 462 463The [check_fping](https://www.monitoring-plugins.org/doc/man/check_fping.html) plugin 464will use the `fping` command to ping the specified host for a fast check. Note that it is 465necessary to set the `suid` flag on `fping`. 466 467This CheckCommand expects an IPv6 address. 468 469Custom variables passed as [command parameters](03-monitoring-basics.md#command-passing-parameters): 470 471Name | Description 472----------------|-------------- 473fping_address | **Optional.** The host's IPv6 address. Defaults to "$address6$". 474fping_wrta | **Optional.** The RTA warning threshold in milliseconds. Defaults to 100. 475fping_wpl | **Optional.** The packet loss warning threshold in %. Defaults to 5. 476fping_crta | **Optional.** The RTA critical threshold in milliseconds. Defaults to 200. 477fping_cpl | **Optional.** The packet loss critical threshold in %. Defaults to 15. 478fping_number | **Optional.** The number of packets to send. Defaults to 5. 479fping_interval | **Optional.** The interval between packets in milli-seconds. Defaults to 500. 480fping_bytes | **Optional.** The size of ICMP packet. 481fping_target_timeout | **Optional.** The target timeout in milli-seconds. 482fping_source_ip | **Optional.** The name or ip address of the source ip. 483fping_source_interface | **Optional.** The source interface name. 484 485 486### ftp <a id="plugin-check-command-ftp"></a> 487 488The [check_ftp](https://www.monitoring-plugins.org/doc/man/check_ftp.html) plugin 489tests FTP connections with the specified host (or unix socket). 490 491Custom variables passed as [command parameters](03-monitoring-basics.md#command-passing-parameters): 492 493Name | Description 494-------------------|-------------- 495ftp_address | **Optional.** The host's address. Defaults to "$address$" if the host's `address` attribute is set, "$address6$" otherwise. 496ftp_port | **Optional.** The FTP port number. 497ftp_expect | **Optional.** String to expect in server response. Multiple strings must be defined as array. 498ftp_all | **Optional.** All expect strings need to occur in server response. Defaults to false. 499ftp_escape_send | **Optional.** Enable usage of \\n, \\r, \\t or \\\\ in send string. 500ftp_send | **Optional.** String to send to the server. 501ftp_escape_quit | **Optional.** Enable usage of \\n, \\r, \\t or \\\\ in quit string. 502ftp_quit | **Optional.** String to send server to initiate a clean close of the connection. 503ftp_refuse | **Optional.** Accept TCP refusals with states ok, warn, crit. Defaults to crit. 504ftp_mismatch | **Optional.** Accept expected string mismatches with states ok, warn, crit. Defaults to warn. 505ftp_jail | **Optional.** Hide output from TCP socket. 506ftp_maxbytes | **Optional.** Close connection once more than this number of bytes are received. 507ftp_delay | **Optional.** Seconds to wait between sending string and polling for response. 508ftp_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. 509ftp_ssl | **Optional.** Use SSL for the connection. Defaults to false. 510ftp_wtime | **Optional.** Response time to result in warning status (seconds). 511ftp_ctime | **Optional.** Response time to result in critical status (seconds). 512ftp_timeout | **Optional.** Seconds before connection times out. Defaults to 10. 513ftp_ipv4 | **Optional.** Use IPv4 connection. Defaults to false. 514ftp_ipv6 | **Optional.** Use IPv6 connection. Defaults to false. 515 516 517### game <a id="plugin-check-command-game"></a> 518 519The [check_game](https://www.monitoring-plugins.org/doc/man/check_game.html) plugin 520tests game server connections with the specified host. 521This plugin uses the 'qstat' command, the popular game server status query tool. 522If you don't have the package installed, you will need to [download](http://www.activesw.com/people/steve/qstat.html) 523or install the package `quakestat` before you can use this plugin. 524 525Custom variables passed as [command parameters](03-monitoring-basics.md#command-passing-parameters): 526 527Name | Description 528-------------------|------------------- 529game_game | **Required.** Name of the game. 530game_ipaddress | **Required.** Ipaddress of the game server to query. 531game_timeout | **Optional.** Seconds before connection times out. Defaults to 10. 532game_port | **Optional.** Port to connect to. 533game_gamefield | **Optional.** Field number in raw qstat output that contains game name. 534game_mapfield | **Optional.** Field number in raw qstat output that contains map name. 535game_pingfield | **Optional.** Field number in raw qstat output that contains ping time. 536game_gametime | **Optional.** Field number in raw qstat output that contains game time. 537game_hostname | **Optional.** Name of the host running the game. 538 539 540### hostalive <a id="plugin-check-command-hostalive"></a> 541 542Check command object for the [check_ping](https://www.monitoring-plugins.org/doc/man/check_ping.html) 543plugin with host check default values. This variant uses the host's `address` attribute 544if available and falls back to using the `address6` attribute if the `address` attribute is not set. 545 546Custom variables passed as [command parameters](03-monitoring-basics.md#command-passing-parameters): 547 548Name | Description 549----------------|-------------- 550ping_address | **Optional.** The host's address. Defaults to "$address$" if the host's `address` attribute is set, "$address6$" otherwise. 551ping_wrta | **Optional.** The RTA warning threshold in milliseconds. Defaults to 3000. 552ping_wpl | **Optional.** The packet loss warning threshold in %. Defaults to 80. 553ping_crta | **Optional.** The RTA critical threshold in milliseconds. Defaults to 5000. 554ping_cpl | **Optional.** The packet loss critical threshold in %. Defaults to 100. 555ping_packets | **Optional.** The number of packets to send. Defaults to 5. 556ping_timeout | **Optional.** The plugin timeout in seconds. Defaults to 0 (no timeout). 557 558 559### hostalive4 <a id="plugin-check-command-hostalive4"></a> 560 561Check command object for the [check_ping](https://www.monitoring-plugins.org/doc/man/check_ping.html) 562plugin with host check default values. This variant uses the host's `address` attribute. 563 564Custom variables passed as [command parameters](03-monitoring-basics.md#command-passing-parameters): 565 566Name | Description 567----------------|-------------- 568ping_address | **Optional.** The host's IPv4 address. Defaults to "$address$". 569ping_wrta | **Optional.** The RTA warning threshold in milliseconds. Defaults to 3000. 570ping_wpl | **Optional.** The packet loss warning threshold in %. Defaults to 80. 571ping_crta | **Optional.** The RTA critical threshold in milliseconds. Defaults to 5000. 572ping_cpl | **Optional.** The packet loss critical threshold in %. Defaults to 100. 573ping_packets | **Optional.** The number of packets to send. Defaults to 5. 574ping_timeout | **Optional.** The plugin timeout in seconds. Defaults to 0 (no timeout). 575 576 577### hostalive6 <a id="plugin-check-command-hostalive6"></a> 578 579Check command object for the [check_ping](https://www.monitoring-plugins.org/doc/man/check_ping.html) 580plugin with host check default values. This variant uses the host's `address6` attribute. 581 582Custom variables passed as [command parameters](03-monitoring-basics.md#command-passing-parameters): 583 584Name | Description 585----------------|-------------- 586ping_address | **Optional.** The host's IPv6 address. Defaults to "$address6$". 587ping_wrta | **Optional.** The RTA warning threshold in milliseconds. Defaults to 3000. 588ping_wpl | **Optional.** The packet loss warning threshold in %. Defaults to 80. 589ping_crta | **Optional.** The RTA critical threshold in milliseconds. Defaults to 5000. 590ping_cpl | **Optional.** The packet loss critical threshold in %. Defaults to 100. 591ping_packets | **Optional.** The number of packets to send. Defaults to 5. 592ping_timeout | **Optional.** The plugin timeout in seconds. Defaults to 0 (no timeout). 593 594 595### hpjd <a id="plugin-check-command-hpjd"></a> 596 597The [check_hpjd](https://www.monitoring-plugins.org/doc/man/check_hpjd.html) plugin 598tests the state of an HP printer with a JetDirect card. Net-snmp must be installed 599on the computer running the plugin. 600 601Custom variables passed as [command parameters](03-monitoring-basics.md#command-passing-parameters): 602 603Name | Description 604----------------|-------------- 605hpjd_address | **Optional.** The host's address. Defaults to "$address$" if the host's `address` attribute is set, "$address6$" otherwise. 606hpjd_port | **Optional.** The host's SNMP port. Defaults to 161. 607hpjd_community | **Optional.** The SNMP community. Defaults to "public". 608 609 610### http <a id="plugin-check-command-http"></a> 611 612The [check_http](https://www.monitoring-plugins.org/doc/man/check_http.html) plugin 613tests the HTTP service on the specified host. It can test normal (http) and secure 614(https) servers, follow redirects, search for strings and regular expressions, 615check connection times, and report on certificate expiration times. 616 617The 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. 618 619Custom variables passed as [command parameters](03-monitoring-basics.md#command-passing-parameters): 620 621Name | Description 622---------------------------------|--------------------------------- 623http_address | **Optional.** The host's address. Defaults to "$address$" if the host's `address` attribute is set, "$address6$" otherwise. 624http_vhost | **Optional.** The virtual host that should be sent in the "Host" header. 625http_uri | **Optional.** The request URI for GET or POST. Defaults to `/`. 626http_port | **Optional.** The TCP port. Defaults to 80 when not using SSL, 443 otherwise. 627http_ssl | **Optional.** Whether to use SSL. Defaults to false. 628http_ssl_force_tlsv1 | **Optional.** Whether to force TLSv1. 629http_ssl_force_tlsv1_1 | **Optional.** Whether to force TLSv1.1. 630http_ssl_force_tlsv1_2 | **Optional.** Whether to force TLSv1.2. 631http_ssl_force_sslv2 | **Optional.** Whether to force SSLv2. 632http_ssl_force_sslv3 | **Optional.** Whether to force SSLv3. 633http_ssl_force_tlsv1_or_higher | **Optional.** Whether to force TLSv1 or higher. 634http_ssl_force_tlsv1_1_or_higher | **Optional.** Whether to force TLSv1.1 or higher. 635http_ssl_force_tlsv1_2_or_higher | **Optional.** Whether to force TLSv1.2 or higher. 636http_ssl_force_sslv2_or_higher | **Optional.** Whether to force SSLv2 or higher. 637http_ssl_force_sslv3_or_higher | **Optional.** Whether to force SSLv3 or higher. 638http_sni | **Optional.** Whether to use SNI. Defaults to false. 639http_auth_pair | **Optional.** Add 'username:password' authorization pair. 640http_proxy_auth_pair | **Optional.** Add 'username:password' authorization pair for proxy. 641http_ignore_body | **Optional.** Don't download the body, just the headers. 642http_linespan | **Optional.** Allow regex to span newline. 643http_expect_body_regex | **Optional.** A regular expression which the body must match against. Incompatible with http_ignore_body. 644http_expect_body_eregi | **Optional.** A case-insensitive expression which the body must match against. Incompatible with http_ignore_body. 645http_invertregex | **Optional.** Changes behavior of http_expect_body_regex and http_expect_body_eregi to return CRITICAL if found, OK if not. 646http_warn_time | **Optional.** The warning threshold. 647http_critical_time | **Optional.** The critical threshold. 648http_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. 649http_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"`). 650http_clientcert | **Optional.** Name of file contains the client certificate (PEM format). 651http_privatekey | **Optional.** Name of file contains the private key (PEM format). 652http_headerstring | **Optional.** String to expect in the response headers. 653http_string | **Optional.** String to expect in the content. 654http_post | **Optional.** URL encoded http POST data. 655http_method | **Optional.** Set http method (for example: HEAD, OPTIONS, TRACE, PUT, DELETE). 656http_maxage | **Optional.** Warn if document is more than seconds old. 657http_contenttype | **Optional.** Specify Content-Type header when POSTing. 658http_useragent | **Optional.** String to be sent in http header as User Agent. 659http_header | **Optional.** Any other tags to be sent in http header. 660http_extendedperfdata | **Optional.** Print additional perfdata. Defaults to false. 661http_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) 662http_pagesize | **Optional.** Minimum page size required:Maximum page size required. 663http_timeout | **Optional.** Seconds before connection times out. 664http_ipv4 | **Optional.** Use IPv4 connection. Defaults to false. 665http_ipv6 | **Optional.** Use IPv6 connection. Defaults to false. 666http_link | **Optional.** Wrap output in HTML link. Defaults to false. 667http_verbose | **Optional.** Show details for command-line debugging. Defaults to false. 668 669 670### icmp <a id="plugin-check-command-icmp"></a> 671 672The [check_icmp](https://www.monitoring-plugins.org/doc/man/check_icmp.html) plugin 673check_icmp allows for checking multiple hosts at once compared to `check_ping`. 674The main difference is that check_ping executes the system's ping(1) command and 675parses its output while `check_icmp` talks ICMP itself. `check_icmp` must be installed with 676`setuid` root. 677 678Custom variables passed as [command parameters](03-monitoring-basics.md#command-passing-parameters): 679 680Name | Description 681----------------|-------------- 682icmp_address | **Optional.** The host's address. This can either be a single address or an array of addresses. Defaults to "$address$". 683icmp_wrta | **Optional.** The RTA warning threshold in milliseconds. Defaults to 100. 684icmp_wpl | **Optional.** The packet loss warning threshold in %. Defaults to 5. 685icmp_crta | **Optional.** The RTA critical threshold in milliseconds. Defaults to 200. 686icmp_cpl | **Optional.** The packet loss critical threshold in %. Defaults to 15. 687icmp_source | **Optional.** The source IP address to send packets from. 688icmp_packets | **Optional.** The number of packets to send. Defaults to 5. 689icmp_packet_interval | **Optional** The maximum packet interval. Defaults to 80 (milliseconds). 690icmp_target_interval | **Optional.** The maximum target interval. 691icmp_hosts_alive | **Optional.** The number of hosts which have to be alive for the check to succeed. 692icmp_data_bytes | **Optional.** Payload size for each ICMP request. Defaults to 8. 693icmp_timeout | **Optional.** The plugin timeout in seconds. Defaults to 10 (seconds). 694icmp_ttl | **Optional.** The TTL on outgoing packets. 695 696 697### imap <a id="plugin-check-command-imap"></a> 698 699The [check_imap](https://www.monitoring-plugins.org/doc/man/check_imap.html) plugin 700tests IMAP connections with the specified host (or unix socket). 701 702Custom variables passed as [command parameters](03-monitoring-basics.md#command-passing-parameters): 703 704Name | Description 705----------------------|-------------- 706imap_address | **Optional.** The host's address. Defaults to "$address$" if the host's `address` attribute is set, "$address6$" otherwise. 707imap_port | **Optional.** The port that should be checked. Defaults to 143. 708imap_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. 709imap_send | **Optional.** String to send to the server. 710imap_expect | **Optional.** String to expect in server response. Multiple strings must be defined as array. 711imap_all | **Optional.** All expect strings need to occur in server response. Default is any. 712imap_quit | **Optional.** String to send server to initiate a clean close of the connection. 713imap_refuse | **Optional.** Accept TCP refusals with states ok, warn, crit (default: crit). 714imap_mismatch | **Optional.** Accept expected string mismatches with states ok, warn, crit (default: warn). 715imap_jail | **Optional.** Hide output from TCP socket. 716imap_maxbytes | **Optional.** Close connection once more than this number of bytes are received. 717imap_delay | **Optional.** Seconds to wait between sending string and polling for response. 718imap_certificate_age | **Optional.** Minimum number of days a certificate has to be valid. 719imap_ssl | **Optional.** Use SSL for the connection. 720imap_warning | **Optional.** Response time to result in warning status (seconds). 721imap_critical | **Optional.** Response time to result in critical status (seconds). 722imap_timeout | **Optional.** Seconds before connection times out (default: 10). 723imap_ipv4 | **Optional.** Use IPv4 connection. Defaults to false. 724imap_ipv6 | **Optional.** Use IPv6 connection. Defaults to false. 725 726 727### ldap <a id="plugin-check-command-ldap"></a> 728 729The [check_ldap](https://www.monitoring-plugins.org/doc/man/check_ldap.html) plugin 730can be used to check LDAP servers. 731 732The plugin can also be used for monitoring ldaps connections instead of the deprecated `check_ldaps`. 733This can be ensured by enabling `ldap_starttls` or `ldap_ssl`. 734 735Custom variables passed as [command parameters](03-monitoring-basics.md#command-passing-parameters): 736 737Name | Description 738------------------------|-------------- 739ldap_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. 740ldap_port | **Optional.** Port number. Defaults to 389. 741ldap_attr | **Optional.** LDAP attribute to search for (default: "(objectclass=*)") 742ldap_base | **Required.** LDAP base (eg. ou=myunit,o=myorg,c=at). 743ldap_bind | **Optional.** LDAP bind DN (if required). 744ldap_pass | **Optional.** LDAP password (if required). 745ldap_starttls | **Optional.** Use STARTSSL mechanism introduced in protocol version 3. 746ldap_ssl | **Optional.** Use LDAPS (LDAP v2 SSL method). This also sets the default port to 636. 747ldap_v2 | **Optional.** Use LDAP protocol version 2 (enabled by default). 748ldap_v3 | **Optional.** Use LDAP protocol version 3 (disabled by default) 749ldap_warning | **Optional.** Response time to result in warning status (seconds). 750ldap_critical | **Optional.** Response time to result in critical status (seconds). 751ldap_warning_entries | **Optional.** Number of found entries to result in warning status. 752ldap_critical_entries | **Optional.** Number of found entries to result in critical status. 753ldap_timeout | **Optional.** Seconds before connection times out (default: 10). 754ldap_verbose | **Optional.** Show details for command-line debugging (disabled by default) 755 756### load <a id="plugin-check-command-load"></a> 757 758The [check_load](https://www.monitoring-plugins.org/doc/man/check_load.html) plugin 759tests the current system load average. 760 761Custom variables passed as [command parameters](03-monitoring-basics.md#command-passing-parameters): 762 763Name | Description 764----------------|-------------- 765load_wload1 | **Optional.** The 1-minute warning threshold. Defaults to 5. 766load_wload5 | **Optional.** The 5-minute warning threshold. Defaults to 4. 767load_wload15 | **Optional.** The 15-minute warning threshold. Defaults to 3. 768load_cload1 | **Optional.** The 1-minute critical threshold. Defaults to 10. 769load_cload5 | **Optional.** The 5-minute critical threshold. Defaults to 6. 770load_cload15 | **Optional.** The 15-minute critical threshold. Defaults to 4. 771load_percpu | **Optional.** Divide the load averages by the number of CPUs (when possible). Defaults to false. 772 773### mailq <a id="plugin-check-command-mailq"></a> 774 775The [check_mailq](https://www.monitoring-plugins.org/doc/man/check_mailq.html) plugin 776checks the number of messages in the mail queue (supports multiple sendmail queues, qmail). 777 778Custom variables passed as [command parameters](03-monitoring-basics.md#command-passing-parameters): 779 780Name | Description 781------------------------|-------------- 782mailq_warning | **Required.** Min. number of messages in queue to generate warning. 783mailq_critical | **Required.** Min. number of messages in queue to generate critical alert ( w < c ). 784mailq_domain_warning | **Optional.** Min. number of messages for same domain in queue to generate warning 785mailq_domain_critical | **Optional.** Min. number of messages for same domain in queue to generate critical alert ( W < C ). 786mailq_timeout | **Optional.** Plugin timeout in seconds (default = 15). 787mailq_servertype | **Optional.** [ sendmail \| qmail \| postfix \| exim \| nullmailer ] (default = autodetect). 788mailq_sudo | **Optional.** Use sudo to execute the mailq command. 789 790### mysql <a id="plugin-check-command-mysql"></a> 791 792The [check_mysql](https://www.monitoring-plugins.org/doc/man/check_mysql.html) plugin 793tests connections to a MySQL server. 794 795Custom variables passed as [command parameters](03-monitoring-basics.md#command-passing-parameters): 796 797Name | Description 798------------------------|--------------------------------------------------------------- 799mysql_hostname | **Optional.** Host name, IP Address, or unix socket (must be an absolute path). 800mysql_port | **Optional.** Port number (default: 3306). 801mysql_socket | **Optional.** Use the specified socket (has no effect if `mysql_hostname` is used). 802mysql_ignore_auth | **Optional.** Ignore authentication failure and check for mysql connectivity only. 803mysql_database | **Optional.** Check database with indicated name. 804mysql_file | **Optional.** Read from the specified client options file. 805mysql_group | **Optional.** Use a client options group. 806mysql_username | **Optional.** Connect using the indicated username. 807mysql_password | **Optional.** Use the indicated password to authenticate the connection. 808mysql_check_slave | **Optional.** Check if the slave thread is running properly. 809mysql_warning | **Optional.** Exit with WARNING status if slave server is more than INTEGER seconds behind master. 810mysql_critical | **Optional.** Exit with CRITICAL status if slave server is more then INTEGER seconds behind master. 811mysql_ssl | **Optional.** Use ssl encryption. 812mysql_cacert | **Optional.** Path to CA signing the cert. 813mysql_cert | **Optional.** Path to SSL certificate. 814mysql_key | **Optional.** Path to private SSL key. 815mysql_cadir | **Optional.** Path to CA directory. 816mysql_ciphers | **Optional.** List of valid SSL ciphers. 817 818 819### mysql_query <a id="plugin-check-command-mysql-query"></a> 820 821The [check_mysql_query](https://www.monitoring-plugins.org/doc/man/check_mysql_query.html) plugin 822checks a query result against threshold levels. 823The result from the query should be numeric. For extra security, create a user with minimal access. 824 825**Note**: You must specify `mysql_query_password` with an empty string to force an empty password, 826overriding any my.cnf settings. 827 828Custom variables passed as [command parameters](03-monitoring-basics.md#command-passing-parameters): 829 830Name | Description 831------------------------|--------------------------------------------------------------- 832mysql_query_hostname | **Optional.** Host name, IP Address, or unix socket (must be an absolute path). 833mysql_query_port | **Optional.** Port number (default: 3306). 834mysql_query_database | **Optional.** Check database with indicated name. 835mysql_query_file | **Optional.** Read from the specified client options file. 836mysql_query_group | **Optional.** Use a client options group. 837mysql_query_username | **Optional.** Connect using the indicated username. 838mysql_query_password | **Optional.** Use the indicated password to authenticate the connection. 839mysql_query_execute | **Required.** SQL Query to run on the MySQL Server. 840mysql_query_warning | **Optional.** Exit with WARNING status if query is outside of the range (format: start:end). 841mysql_query_critical | **Optional.** Exit with CRITICAL status if query is outside of the range. 842 843 844### negate <a id="plugin-check-command-negate"></a> 845 846The [negate](https://www.monitoring-plugins.org/doc/man/negate.html) plugin 847negates the status of a plugin (returns OK for CRITICAL and vice-versa). 848Additional switches can be used to control which state becomes what. 849 850Custom variables passed as [command parameters](03-monitoring-basics.md#command-passing-parameters): 851 852Name | Description 853----------------------|--------------------------------------------------------------- 854negate_timeout | **Optional.** Seconds before plugin times out (default: 11). 855negate_timeout_result | **Optional.** Custom result on Negate timeouts, default to UNKNOWN. 856negate_ok | **Optional.** OK, WARNING, CRITICAL or UNKNOWN. 857negate_warning | Numeric values are accepted. 858negate_critical | If nothing is specified, 859negate_unknown | permutes OK and CRITICAL. 860negate_substitute | **Optional.** Substitute output text as well. Will only substitute text in CAPITALS. 861negate_command | **Required.** Command to be negated. 862negate_arguments | **Optional.** Arguments for the negated command. 863 864### nrpe <a id="plugin-check-command-nrpe"></a> 865 866The `check_nrpe` plugin can be used to query an [NRPE](https://icinga.com/docs/icinga1/latest/en/nrpe.html) 867server or [NSClient++](https://www.nsclient.org). **Note**: This plugin 868is considered insecure/deprecated. 869 870Custom variables passed as [command parameters](03-monitoring-basics.md#command-passing-parameters): 871 872Name | Description 873----------------|-------------- 874nrpe_address | **Optional.** The host's address. Defaults to "$address$" if the host's `address` attribute is set, "$address6$" otherwise. 875nrpe_port | **Optional.** The NRPE port. Defaults to 5666. 876nrpe_command | **Optional.** The command that should be executed. 877nrpe_no_ssl | **Optional.** Whether to disable SSL or not. Defaults to `false`. 878nrpe_timeout_unknown | **Optional.** Whether to set timeouts to unknown instead of critical state. Defaults to `false`. 879nrpe_timeout | **Optional.** The timeout in seconds. 880nrpe_arguments | **Optional.** Arguments that should be passed to the command. Multiple arguments must be defined as array. 881nrpe_ipv4 | **Optional.** Use IPv4 connection. Defaults to false. 882nrpe_ipv6 | **Optional.** Use IPv6 connection. Defaults to false. 883nrpe_version_2 | **Optional.** Use this if you want to connect using NRPE v2 protocol. Defaults to false. 884nrpe_ca | **Optional.** The CA file to use for PKI. Defaults to none. 885nrpe_cert | **Optional.** The client cert file to use for PKI. Defaults to none. 886nrpe_key | **Optional.** The client key file to use for PKI. Defaults to none. 887nrpe_ssl_version | **Optional.** The SSL/TLS version to use. Defaults to TLSv1+. 888nrpe_cipher_list | **Optional.** The list of SSL ciphers to use. Default depends on check_nrpe version. 889nrpe_dh_opt | **Optional.** Anonymous Diffie Hellman use: 0 = deny, 1 = allow, 2 = force. Default depends on check_nrpe version. 890 891 892### nscp <a id="plugin-check-command-nscp"></a> 893 894The [check_nt](https://www.monitoring-plugins.org/doc/man/check_nt.html) plugin 895collects data from the [NSClient++](https://www.nsclient.org) service. 896 897Custom variables passed as [command parameters](03-monitoring-basics.md#command-passing-parameters): 898 899Name | Description 900----------------|-------------- 901nscp_address | **Optional.** The host's address. Defaults to "$address$" if the host's `address` attribute is set, "$address6$" otherwise. 902nscp_port | **Optional.** The NSClient++ port. Defaults to 12489. 903nscp_password | **Optional.** The NSClient++ password. 904nscp_variable | **Required.** The variable that should be checked. 905nscp_params | **Optional.** Parameters for the query. Multiple parameters must be defined as array. 906nscp_warn | **Optional.** The warning threshold. 907nscp_crit | **Optional.** The critical threshold. 908nscp_timeout | **Optional.** The query timeout in seconds. 909nscp_showall | **Optional.** Use with SERVICESTATE to see working services or PROCSTATE for running processes. Defaults to false. 910 911 912### ntp_time <a id="plugin-check-command-ntp-time"></a> 913 914The [check_ntp_time](https://www.monitoring-plugins.org/doc/man/check_ntp_time.html) plugin 915checks the clock offset between the local host and a remote NTP server. 916 917**Note**: If you want to monitor an NTP server, please use `ntp_peer`. 918 919Custom variables passed as [command parameters](03-monitoring-basics.md#command-passing-parameters): 920 921Name | Description 922----------------|-------------- 923ntp_address | **Optional.** The host's address. Defaults to "$address$" if the host's `address` attribute is set, "$address6$" otherwise. 924ntp_port | **Optional.** Port number (default: 123). 925ntp_quiet | **Optional.** Returns UNKNOWN instead of CRITICAL if offset cannot be found. 926ntp_warning | **Optional.** Offset to result in warning status (seconds). 927ntp_critical | **Optional.** Offset to result in critical status (seconds). 928ntp_timeoffset | **Optional.** Expected offset of the ntp server relative to local server (seconds). 929ntp_timeout | **Optional.** Seconds before connection times out (default: 10). 930ntp_ipv4 | **Optional.** Use IPv4 connection. Defaults to false. 931ntp_ipv6 | **Optional.** Use IPv6 connection. Defaults to false. 932 933 934### ntp_peer <a id="plugin-check-command-ntp-peer"></a> 935 936The [check_ntp_peer](https://www.monitoring-plugins.org/doc/man/check_ntp_peer.html) plugin 937checks the health of an NTP server. It supports checking the offset with the sync peer, the 938jitter and stratum. This plugin will not check the clock offset between the local host and NTP 939 server; please use `ntp_time` for that purpose. 940 941Custom variables passed as [command parameters](03-monitoring-basics.md#command-passing-parameters): 942 943Name | Description 944----------------|-------------- 945ntp_address | **Optional.** The host's address. Defaults to "$address$" if the host's `address` attribute is set, "$address6$" otherwise. 946ntp_port | **Optional.** The port to use. Default to 123. 947ntp_quiet | **Optional.** Returns UNKNOWN instead of CRITICAL or WARNING if server isn't synchronized. 948ntp_warning | **Optional.** Offset to result in warning status (seconds). 949ntp_critical | **Optional.** Offset to result in critical status (seconds). 950ntp_wstratum | **Optional.** Warning threshold for stratum of server's synchronization peer. 951ntp_cstratum | **Optional.** Critical threshold for stratum of server's synchronization peer. 952ntp_wjitter | **Optional.** Warning threshold for jitter. 953ntp_cjitter | **Optional.** Critical threshold for jitter. 954ntp_wsource | **Optional.** Warning threshold for number of usable time sources. 955ntp_csource | **Optional.** Critical threshold for number of usable time sources. 956ntp_timeout | **Optional.** Seconds before connection times out (default: 10). 957ntp_ipv4 | **Optional.** Use IPv4 connection. Defaults to false. 958ntp_ipv6 | **Optional.** Use IPv6 connection. Defaults to false. 959 960 961### pgsql <a id="plugin-check-command-pgsql"></a> 962 963The [check_pgsql](https://www.monitoring-plugins.org/doc/man/check_pgsql.html) plugin 964tests a PostgreSQL DBMS to determine whether it is active and accepting queries. 965If a query is specified using the `pgsql_query` attribute, it will be executed after 966connecting to the server. The result from the query has to be numeric in order 967to compare it against the query thresholds if set. 968 969Custom variables passed as [command parameters](03-monitoring-basics.md#command-passing-parameters): 970 971Name | Description 972------------------------|--------------------------------------------------------------- 973pgsql_hostname | **Optional.** Host name, IP Address, or unix socket (must be an absolute path). 974pgsql_port | **Optional.** Port number (default: 5432). 975pgsql_database | **Optional.** Database to check (default: template1). 976pgsql_username | **Optional.** Login name of user. 977pgsql_password | **Optional.** Password (BIG SECURITY ISSUE). 978pgsql_options | **Optional.** Connection parameters (keyword = value), see below. 979pgsql_warning | **Optional.** Response time to result in warning status (seconds). 980pgsql_critical | **Optional.** Response time to result in critical status (seconds). 981pgsql_timeout | **Optional.** Seconds before connection times out (default: 10). 982pgsql_query | **Optional.** SQL query to run. Only first column in first row will be read. 983pgsql_query_warning | **Optional.** SQL query value to result in warning status (double). 984pgsql_query_critical | **Optional.** SQL query value to result in critical status (double). 985 986### ping <a id="plugin-check-command-ping"></a> 987 988The [check_ping](https://www.monitoring-plugins.org/doc/man/check_ping.html) plugin 989uses the ping command to probe the specified host for packet loss (percentage) and 990round trip average (milliseconds). 991 992This command uses the host's `address` attribute if available and falls back to using 993the `address6` attribute if the `address` attribute is not set. 994 995Custom variables passed as [command parameters](03-monitoring-basics.md#command-passing-parameters): 996 997Name | Description 998----------------|-------------- 999ping_address | **Optional.** The host's address. Defaults to "$address$" if the host's `address` attribute is set, "$address6$" otherwise. 1000ping_wrta | **Optional.** The RTA warning threshold in milliseconds. Defaults to 100. 1001ping_wpl | **Optional.** The packet loss warning threshold in %. Defaults to 5. 1002ping_crta | **Optional.** The RTA critical threshold in milliseconds. Defaults to 200. 1003ping_cpl | **Optional.** The packet loss critical threshold in %. Defaults to 15. 1004ping_packets | **Optional.** The number of packets to send. Defaults to 5. 1005ping_timeout | **Optional.** The plugin timeout in seconds. Defaults to 0 (no timeout). 1006 1007 1008### ping4 <a id="plugin-check-command-ping4"></a> 1009 1010The [check_ping](https://www.monitoring-plugins.org/doc/man/check_ping.html) plugin 1011uses the ping command to probe the specified host for packet loss (percentage) and 1012round trip average (milliseconds). 1013 1014This command uses the host's `address` attribute if not explicitly specified using 1015the `ping_address` attribute. 1016 1017Custom variables passed as [command parameters](03-monitoring-basics.md#command-passing-parameters): 1018 1019Name | Description 1020----------------|-------------- 1021ping_address | **Optional.** The host's IPv4 address. Defaults to "$address$". 1022ping_wrta | **Optional.** The RTA warning threshold in milliseconds. Defaults to 100. 1023ping_wpl | **Optional.** The packet loss warning threshold in %. Defaults to 5. 1024ping_crta | **Optional.** The RTA critical threshold in milliseconds. Defaults to 200. 1025ping_cpl | **Optional.** The packet loss critical threshold in %. Defaults to 15. 1026ping_packets | **Optional.** The number of packets to send. Defaults to 5. 1027ping_timeout | **Optional.** The plugin timeout in seconds. Defaults to 0 (no timeout). 1028 1029### ping6 <a id="plugin-check-command-ping6"></a> 1030 1031The [check_ping](https://www.monitoring-plugins.org/doc/man/check_ping.html) plugin 1032uses the ping command to probe the specified host for packet loss (percentage) and 1033round trip average (milliseconds). 1034 1035This command uses the host's `address6` attribute if not explicitly specified using 1036the `ping_address` attribute. 1037 1038Custom variables passed as [command parameters](03-monitoring-basics.md#command-passing-parameters): 1039 1040Name | Description 1041----------------|-------------- 1042ping_address | **Optional.** The host's IPv6 address. Defaults to "$address6$". 1043ping_wrta | **Optional.** The RTA warning threshold in milliseconds. Defaults to 100. 1044ping_wpl | **Optional.** The packet loss warning threshold in %. Defaults to 5. 1045ping_crta | **Optional.** The RTA critical threshold in milliseconds. Defaults to 200. 1046ping_cpl | **Optional.** The packet loss critical threshold in %. Defaults to 15. 1047ping_packets | **Optional.** The number of packets to send. Defaults to 5. 1048ping_timeout | **Optional.** The plugin timeout in seconds. Defaults to 0 (no timeout). 1049 1050 1051### pop <a id="plugin-check-command-pop"></a> 1052 1053The [check_pop](https://www.monitoring-plugins.org/doc/man/check_pop.html) plugin 1054tests POP connections with the specified host (or unix socket). 1055 1056Custom variables passed as [command parameters](03-monitoring-basics.md#command-passing-parameters): 1057 1058Name | Description 1059---------------------|-------------- 1060pop_address | **Optional.** The host's address. Defaults to "$address$" if the host's `address` attribute is set, "$address6$" otherwise. 1061pop_port | **Optional.** The port that should be checked. Defaults to 110. 1062pop_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. 1063pop_send | **Optional.** String to send to the server. 1064pop_expect | **Optional.** String to expect in server response. Multiple strings must be defined as array. 1065pop_all | **Optional.** All expect strings need to occur in server response. Default is any. 1066pop_quit | **Optional.** String to send server to initiate a clean close of the connection. 1067pop_refuse | **Optional.** Accept TCP refusals with states ok, warn, crit (default: crit). 1068pop_mismatch | **Optional.** Accept expected string mismatches with states ok, warn, crit (default: warn). 1069pop_jail | **Optional.** Hide output from TCP socket. 1070pop_maxbytes | **Optional.** Close connection once more than this number of bytes are received. 1071pop_delay | **Optional.** Seconds to wait between sending string and polling for response. 1072pop_certificate_age | **Optional.** Minimum number of days a certificate has to be valid. 1073pop_ssl | **Optional.** Use SSL for the connection. 1074pop_warning | **Optional.** Response time to result in warning status (seconds). 1075pop_critical | **Optional.** Response time to result in critical status (seconds). 1076pop_timeout | **Optional.** Seconds before connection times out (default: 10). 1077pop_ipv4 | **Optional.** Use IPv4 connection. Defaults to false. 1078pop_ipv6 | **Optional.** Use IPv6 connection. Defaults to false. 1079 1080 1081### procs <a id="plugin-check-command-processes"></a> 1082 1083The [check_procs](https://www.monitoring-plugins.org/doc/man/check_procs.html) plugin 1084checks all processes and generates WARNING or CRITICAL states if the specified 1085metric is outside the required threshold ranges. The metric defaults to number 1086of processes. Search filters can be applied to limit the processes to check. 1087 1088Custom variables passed as [command parameters](03-monitoring-basics.md#command-passing-parameters): 1089 1090Name | Description 1091---------------------|-------------- 1092procs_warning | **Optional.** The process count warning threshold. Defaults to 250. 1093procs_critical | **Optional.** The process count critical threshold. Defaults to 400. 1094procs_metric | **Optional.** Check thresholds against metric. 1095procs_timeout | **Optional.** Seconds before plugin times out. 1096procs_traditional | **Optional.** Filter own process the traditional way by PID instead of /proc/pid/exe. Defaults to false. 1097procs_state | **Optional.** Only scan for processes that have one or more of the status flags you specify. 1098procs_ppid | **Optional.** Only scan for children of the parent process ID indicated. 1099procs_vsz | **Optional.** Only scan for processes with VSZ higher than indicated. 1100procs_rss | **Optional.** Only scan for processes with RSS higher than indicated. 1101procs_pcpu | **Optional.** Only scan for processes with PCPU higher than indicated. 1102procs_user | **Optional.** Only scan for processes with user name or ID indicated. 1103procs_argument | **Optional.** Only scan for processes with args that contain STRING. 1104procs_argument_regex | **Optional.** Only scan for processes with args that contain the regex STRING. 1105procs_command | **Optional.** Only scan for exact matches of COMMAND (without path). 1106procs_nokthreads | **Optional.** Only scan for non kernel threads. Defaults to false. 1107 1108 1109### radius <a id="plugin-check-command-radius"></a> 1110 1111The [check_radius](https://www.monitoring-plugins.org/doc/man/check_radius.html) plugin 1112checks a RADIUS server to see if it is accepting connections. The server to test 1113must be specified in the invocation, as well as a user name and password. A configuration 1114file may also be present. The format of the configuration file is described in the 1115radiusclient library sources. The password option presents a substantial security 1116issue because the password can possibly be determined by careful watching of the 1117command line in a process listing. This risk is exacerbated because the plugin will 1118typically be executed at regular predictable intervals. Please be sure that the 1119password used does not allow access to sensitive system resources. 1120 1121 1122Custom variables passed as [command parameters](03-monitoring-basics.md#command-passing-parameters): 1123 1124Name | Description 1125-------------------|-------------- 1126radius_address | **Optional.** The radius server's address. Defaults to "$address$" if the host's `address` attribute is set, "$address6$" otherwise. 1127radius_config_file | **Required.** The radius configuration file. 1128radius_username | **Required.** The radius username to test. 1129radius_password | **Required.** The radius password to test. 1130radius_port | **Optional.** The radius port number (default 1645). 1131radius_nas_id | **Optional.** The NAS identifier. 1132radius_nas_address | **Optional.** The NAS IP address. 1133radius_expect | **Optional.** The response string to expect from the server. 1134radius_retries | **Optional.** The number of times to retry a failed connection. 1135radius_timeout | **Optional.** The number of seconds before connection times out (default: 10). 1136 1137### rpc <a id="plugin-check-command-rpc"></a> 1138 1139The [check_rpc](https://www.monitoring-plugins.org/doc/man/check_rpc.html) 1140plugin tests if a service is registered and running using `rpcinfo -H host -C rpc_command`. 1141 1142Custom variables passed as [command parameters](03-monitoring-basics.md#command-passing-parameters): 1143 1144Name | Description 1145--- | --- 1146rpc_address | **Optional.** The rpc host address. Defaults to "$address$ if the host `address` attribute is set, "$address6$" otherwise. 1147rpc_command | **Required.** The programm name (or number). 1148rpc_port | **Optional.** The port that should be checked. 1149rpc_version | **Optional.** The version you want to check for (one or more). 1150rpc_udp | **Optional.** Use UDP test. Defaults to false. 1151rpc_tcp | **Optional.** Use TCP test. Defaults to false. 1152rpc_verbose | **Optional.** Show verbose output. Defaults to false. 1153 1154### simap <a id="plugin-check-command-simap"></a> 1155 1156The [check_simap](https://www.monitoring-plugins.org/doc/man/check_simap.html) plugin 1157tests SIMAP connections with the specified host (or unix socket). 1158 1159Custom variables passed as [command parameters](03-monitoring-basics.md#command-passing-parameters): 1160 1161Name | Description 1162-----------------------|-------------- 1163simap_address | **Optional.** The host's address. Defaults to "$address$" if the host's `address` attribute is set, "$address6$" otherwise. 1164simap_port | **Optional.** The port that should be checked. Defaults to 993. 1165simap_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. 1166simap_send | **Optional.** String to send to the server. 1167simap_expect | **Optional.** String to expect in server response. Multiple strings must be defined as array. 1168simap_all | **Optional.** All expect strings need to occur in server response. Default is any. 1169simap_quit | **Optional.** String to send server to initiate a clean close of the connection. 1170simap_refuse | **Optional.** Accept TCP refusals with states ok, warn, crit (default: crit). 1171simap_mismatch | **Optional.** Accept expected string mismatches with states ok, warn, crit (default: warn). 1172simap_jail | **Optional.** Hide output from TCP socket. 1173simap_maxbytes | **Optional.** Close connection once more than this number of bytes are received. 1174simap_delay | **Optional.** Seconds to wait between sending string and polling for response. 1175simap_certificate_age | **Optional.** Minimum number of days a certificate has to be valid. 1176simap_ssl | **Optional.** Use SSL for the connection. 1177simap_warning | **Optional.** Response time to result in warning status (seconds). 1178simap_critical | **Optional.** Response time to result in critical status (seconds). 1179simap_timeout | **Optional.** Seconds before connection times out (default: 10). 1180simap_ipv4 | **Optional.** Use IPv4 connection. Defaults to false. 1181simap_ipv6 | **Optional.** Use IPv6 connection. Defaults to false. 1182 1183### smart <a id="plugin-check-command-smart"></a> 1184 1185The [check_ide_smart](https://www.monitoring-plugins.org/doc/man/check_ide_smart.html) plugin 1186checks a local hard drive with the (Linux specific) SMART interface. Requires installation of `smartctl`. 1187 1188Custom variables passed as [command parameters](03-monitoring-basics.md#command-passing-parameters): 1189 1190Name | Description 1191----------------|-------------- 1192smart_device | **Required.** The name of a local hard drive to monitor. 1193 1194 1195### smtp <a id="plugin-check-command-smtp"></a> 1196 1197The [check_smtp](https://www.monitoring-plugins.org/doc/man/check_smtp.html) plugin 1198will attempt to open an SMTP connection with the host. 1199 1200Custom variables passed as [command parameters](03-monitoring-basics.md#command-passing-parameters): 1201 1202Name | Description 1203----------------------|-------------- 1204smtp_address | **Optional.** The host's address. Defaults to "$address$" if the host's `address` attribute is set, "$address6$" otherwise. 1205smtp_port | **Optional.** The port that should be checked. Defaults to 25. 1206smtp_mail_from | **Optional.** Test a MAIL FROM command with the given email address. 1207smtp_expect | **Optional.** String to expect in first line of server response (default: '220'). 1208smtp_command | **Optional.** SMTP command (may be used repeatedly). 1209smtp_response | **Optional.** Expected response to command (may be used repeatedly). 1210smtp_helo_fqdn | **Optional.** FQDN used for HELO 1211smtp_certificate_age | **Optional.** Minimum number of days a certificate has to be valid. 1212smtp_starttls | **Optional.** Use STARTTLS for the connection. 1213smtp_authtype | **Optional.** SMTP AUTH type to check (default none, only LOGIN supported). 1214smtp_authuser | **Optional.** SMTP AUTH username. 1215smtp_authpass | **Optional.** SMTP AUTH password. 1216smtp_ignore_quit | **Optional.** Ignore failure when sending QUIT command to server. 1217smtp_warning | **Optional.** Response time to result in warning status (seconds). 1218smtp_critical | **Optional.** Response time to result in critical status (seconds). 1219smtp_timeout | **Optional.** Seconds before connection times out (default: 10). 1220smtp_ipv4 | **Optional.** Use IPv4 connection. Defaults to false. 1221smtp_ipv6 | **Optional.** Use IPv6 connection. Defaults to false. 1222 1223 1224### snmp <a id="plugin-check-command-snmp"></a> 1225 1226The [check_snmp](https://www.monitoring-plugins.org/doc/man/check_snmp.html) plugin 1227checks the status of remote machines and obtains system information via SNMP. 1228 1229**Note**: This plugin uses the `snmpget` command included with the NET-SNMP package. 1230 1231Custom variables passed as [command parameters](03-monitoring-basics.md#command-passing-parameters): 1232 1233Name | Description 1234--------------------|-------------- 1235snmp_address | **Optional.** The host's address. Defaults to "$address$" if the host's `address` attribute is set, "$address6$" otherwise. 1236snmp_oid | **Required.** The SNMP OID. 1237snmp_community | **Optional.** The SNMP community. Defaults to "public". 1238snmp_port | **Optional.** The SNMP port. Defaults to "161". 1239snmp_retries | **Optional.** Number of retries to be used in the SNMP requests. 1240snmp_warn | **Optional.** The warning threshold. 1241snmp_crit | **Optional.** The critical threshold. 1242snmp_string | **Optional.** Return OK state if the string matches exactly with the output value 1243snmp_ereg | **Optional.** Return OK state if extended regular expression REGEX matches with the output value 1244snmp_eregi | **Optional.** Return OK state if case-insensitive extended REGEX matches with the output value 1245snmp_label | **Optional.** Prefix label for output value 1246snmp_invert_search | **Optional.** Invert search result and return CRITICAL state if found 1247snmp_units | **Optional.** Units label(s) for output value (e.g., 'sec.'). 1248snmp_version | **Optional.** Version to use. E.g. 1, 2, 2c or 3. 1249snmp_miblist | **Optional.** MIB's to use, comma separated. Defaults to "ALL". 1250snmp_rate_multiplier | **Optional.** Converts rate per second. For example, set to 60 to convert to per minute. 1251snmp_rate | **Optional.** Boolean. Enable rate calculation. 1252snmp_getnext | **Optional.** Boolean. Use SNMP GETNEXT. Defaults to false. 1253snmp_timeout | **Optional.** The command timeout in seconds. Defaults to 10 seconds. 1254snmp_offset | **Optional.** Add/subtract the specified OFFSET to numeric sensor data. 1255snmp_output_delimiter | **Optional.** Separates output on multiple OID requests. 1256snmp_perf_oids | **Optional.** Label performance data with OIDs instead of --label's. 1257 1258### snmpv3 <a id="plugin-check-command-snmpv3"></a> 1259 1260Check command object for the [check_snmp](https://www.monitoring-plugins.org/doc/man/check_snmp.html) 1261plugin, using SNMPv3 authentication and encryption options. 1262 1263Custom variables passed as [command parameters](03-monitoring-basics.md#command-passing-parameters): 1264 1265Name | Description 1266---------------------|-------------- 1267snmpv3_address | **Optional.** The host's address. Defaults to "$address$" if the host's `address` attribute is set, "$address6$" otherwise. 1268snmpv3_getnext | **Optional.** Use SNMP GETNEXT instead of SNMP GET. 1269snmpv3_seclevel | **Optional.** The security level. Defaults to authPriv. 1270snmpv3_auth_alg | **Optional.** The authentication algorithm. Defaults to SHA. 1271snmpv3_user | **Required.** The username to log in with. 1272snmpv3_context | **Optional.** The SNMPv3 context. 1273snmpv3_auth_key | **Required,** The authentication key. Required if `snmpv3_seclevel` is set to `authPriv` otherwise optional. 1274snmpv3_priv_key | **Required.** The encryption key. 1275snmpv3_oid | **Required.** The SNMP OID. 1276snmpv3_priv_alg | **Optional.** The encryption algorithm. Defaults to AES. 1277snmpv3_warn | **Optional.** The warning threshold. 1278snmpv3_crit | **Optional.** The critical threshold. 1279snmpv3_string | **Optional.** Return OK state (for that OID) if STRING is an exact match. 1280snmpv3_ereg | **Optional.** Return OK state (for that OID) if extended regular expression REGEX matches. 1281snmpv3_eregi | **Optional.** Return OK state (for that OID) if case-insensitive extended REGEX matches. 1282snmpv3_invert_search | **Optional.** Invert search result and return CRITICAL if found 1283snmpv3_label | **Optional.** Prefix label for output value. 1284snmpv3_units | **Optional.** Units label(s) for output value (e.g., 'sec.'). 1285snmpv3_rate_multiplier | **Optional.** Converts rate per second. For example, set to 60 to convert to per minute. 1286snmpv3_rate | **Optional.** Boolean. Enable rate calculation. 1287snmpv3_timeout | **Optional.** The command timeout in seconds. Defaults to 10 seconds. 1288 1289### snmp-uptime <a id="plugin-check-command-snmp-uptime"></a> 1290 1291Check command object for the [check_snmp](https://www.monitoring-plugins.org/doc/man/check_snmp.html) 1292plugin, using the uptime OID by default. 1293 1294Custom variables passed as [command parameters](03-monitoring-basics.md#command-passing-parameters): 1295 1296Name | Description 1297----------------|-------------- 1298snmp_address | **Optional.** The host's address. Defaults to "$address$" if the host's `address` attribute is set, "$address6$" otherwise. 1299snmp_oid | **Optional.** The SNMP OID. Defaults to "1.3.6.1.2.1.1.3.0". 1300snmp_community | **Optional.** The SNMP community. Defaults to "public". 1301 1302 1303### spop <a id="plugin-check-command-spop"></a> 1304 1305The [check_spop](https://www.monitoring-plugins.org/doc/man/check_spop.html) plugin 1306tests SPOP connections with the specified host (or unix socket). 1307 1308Custom variables passed as [command parameters](03-monitoring-basics.md#command-passing-parameters): 1309 1310Name | Description 1311----------------------|-------------- 1312spop_address | **Optional.** The host's address. Defaults to "$address$" if the host's `address` attribute is set, "$address6$" otherwise. 1313spop_port | **Optional.** The port that should be checked. Defaults to 995. 1314spop_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. 1315spop_send | **Optional.** String to send to the server. 1316spop_expect | **Optional.** String to expect in server response. Multiple strings must be defined as array. 1317spop_all | **Optional.** All expect strings need to occur in server response. Default is any. 1318spop_quit | **Optional.** String to send server to initiate a clean close of the connection. 1319spop_refuse | **Optional.** Accept TCP refusals with states ok, warn, crit (default: crit). 1320spop_mismatch | **Optional.** Accept expected string mismatches with states ok, warn, crit (default: warn). 1321spop_jail | **Optional.** Hide output from TCP socket. 1322spop_maxbytes | **Optional.** Close connection once more than this number of bytes are received. 1323spop_delay | **Optional.** Seconds to wait between sending string and polling for response. 1324spop_certificate_age | **Optional.** Minimum number of days a certificate has to be valid. 1325spop_ssl | **Optional.** Use SSL for the connection. 1326spop_warning | **Optional.** Response time to result in warning status (seconds). 1327spop_critical | **Optional.** Response time to result in critical status (seconds). 1328spop_timeout | **Optional.** Seconds before connection times out (default: 10). 1329spop_ipv4 | **Optional.** Use IPv4 connection. Defaults to false. 1330spop_ipv6 | **Optional.** Use IPv6 connection. Defaults to false. 1331 1332 1333### ssh <a id="plugin-check-command-ssh"></a> 1334 1335The [check_ssh](https://www.monitoring-plugins.org/doc/man/check_ssh.html) plugin 1336connects to an SSH server at a specified host and port. 1337 1338Custom variables passed as [command parameters](03-monitoring-basics.md#command-passing-parameters): 1339 1340Name | Description 1341----------------|-------------- 1342ssh_address | **Optional.** The host's address. Defaults to "$address$" if the host's `address` attribute is set, "$address6$" otherwise. 1343ssh_port | **Optional.** The port that should be checked. Defaults to 22. 1344ssh_timeout | **Optional.** Seconds before connection times out. Defaults to 10. 1345ssh_ipv4 | **Optional.** Use IPv4 connection. Defaults to false. 1346ssh_ipv6 | **Optional.** Use IPv6 connection. Defaults to false. 1347 1348 1349### ssl <a id="plugin-check-command-ssl"></a> 1350 1351Check command object for the [check_tcp](https://www.monitoring-plugins.org/doc/man/check_tcp.html) plugin, 1352using ssl-related options. 1353 1354Custom variables passed as [command parameters](03-monitoring-basics.md#command-passing-parameters): 1355 1356Name | Description 1357------------------------------|-------------- 1358ssl_address | **Optional.** The host's address. Defaults to "$address$" if the host's `address` attribute is set, "$address6$" otherwise. 1359ssl_port | **Optional.** The port that should be checked. Defaults to 443. 1360ssl_timeout | **Optional.** Timeout in seconds for the connect and handshake. The plugin default is 10 seconds. 1361ssl_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. 1362ssl_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. 1363ssl_sni | **Optional.** The `server_name` that is send to select the SSL certificate to check. Important if SNI is used. 1364 1365 1366### ssmtp <a id="plugin-check-command-ssmtp"></a> 1367 1368The [check_ssmtp](https://www.monitoring-plugins.org/doc/man/check_ssmtp.html) plugin 1369tests SSMTP connections with the specified host (or unix socket). 1370 1371Custom variables passed as [command parameters](03-monitoring-basics.md#command-passing-parameters): 1372 1373Name | Description 1374-----------------------|-------------- 1375ssmtp_address | **Optional.** The host's address. Defaults to "$address$" if the host's `address` attribute is set, "$address6$" otherwise. 1376ssmtp_port | **Optional.** The port that should be checked. Defaults to 465. 1377ssmtp_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. 1378ssmtp_send | **Optional.** String to send to the server. 1379ssmtp_expect | **Optional.** String to expect in server response. Multiple strings must be defined as array. 1380ssmtp_all | **Optional.** All expect strings need to occur in server response. Default is any. 1381ssmtp_quit | **Optional.** String to send server to initiate a clean close of the connection. 1382ssmtp_refuse | **Optional.** Accept TCP refusals with states ok, warn, crit (default: crit). 1383ssmtp_mismatch | **Optional.** Accept expected string mismatches with states ok, warn, crit (default: warn). 1384ssmtp_jail | **Optional.** Hide output from TCP socket. 1385ssmtp_maxbytes | **Optional.** Close connection once more than this number of bytes are received. 1386ssmtp_delay | **Optional.** Seconds to wait between sending string and polling for response. 1387ssmtp_certificate_age | **Optional.** Minimum number of days a certificate has to be valid. 1388ssmtp_ssl | **Optional.** Use SSL for the connection. 1389ssmtp_warning | **Optional.** Response time to result in warning status (seconds). 1390ssmtp_critical | **Optional.** Response time to result in critical status (seconds). 1391ssmtp_timeout | **Optional.** Seconds before connection times out (default: 10). 1392ssmtp_ipv4 | **Optional.** Use IPv4 connection. Defaults to false. 1393ssmtp_ipv6 | **Optional.** Use IPv6 connection. Defaults to false. 1394 1395 1396### swap <a id="plugin-check-command-swap"></a> 1397 1398The [check_swap](https://www.monitoring-plugins.org/doc/man/check_swap.html) plugin 1399checks the swap space on a local machine. 1400 1401Custom variables passed as [command parameters](03-monitoring-basics.md#command-passing-parameters): 1402 1403Name | Description 1404----------------|-------------- 1405swap_wfree | **Optional.** The free swap space warning threshold in % (enable `swap_integer` for number values). Defaults to `50%`. 1406swap_cfree | **Optional.** The free swap space critical threshold in % (enable `swap_integer` for number values). Defaults to `25%`. 1407swap_integer | **Optional.** Specifies whether the thresholds are passed as number or percent value. Defaults to false (percent values). 1408swap_allswaps | **Optional.** Conduct comparisons for all swap partitions, one by one. Defaults to false. 1409swap_noswap | **Optional.** Resulting state when there is no swap regardless of thresholds. Possible values are "ok", "warning", "critical", "unknown". Defaults to "critical". 1410 1411 1412### tcp <a id="plugin-check-command-tcp"></a> 1413 1414The [check_tcp](https://www.monitoring-plugins.org/doc/man/check_tcp.html) plugin 1415tests TCP connections with the specified host (or unix socket). 1416 1417Custom variables passed as [command parameters](03-monitoring-basics.md#command-passing-parameters): 1418 1419Name | Description 1420----------------|-------------- 1421tcp_address | **Optional.** The host's address. Defaults to "$address$" if the host's `address` attribute is set, "$address6$" otherwise. 1422tcp_port | **Required.** The port that should be checked. 1423tcp_expect | **Optional.** String to expect in server response. Multiple strings must be defined as array. 1424tcp_all | **Optional.** All expect strings need to occur in server response. Defaults to false. 1425tcp_escape_send | **Optional.** Enable usage of \\n, \\r, \\t or \\\\ in send string. 1426tcp_send | **Optional.** String to send to the server. 1427tcp_escape_quit | **Optional.** Enable usage of \\n, \\r, \\t or \\\\ in quit string. 1428tcp_quit | **Optional.** String to send server to initiate a clean close of the connection. 1429tcp_refuse | **Optional.** Accept TCP refusals with states ok, warn, crit. Defaults to crit. 1430tcp_mismatch | **Optional.** Accept expected string mismatches with states ok, warn, crit. Defaults to warn. 1431tcp_jail | **Optional.** Hide output from TCP socket. 1432tcp_maxbytes | **Optional.** Close connection once more than this number of bytes are received. 1433tcp_delay | **Optional.** Seconds to wait between sending string and polling for response. 1434tcp_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. 1435tcp_ssl | **Optional.** Use SSL for the connection. Defaults to false. 1436tcp_wtime | **Optional.** Response time to result in warning status (seconds). 1437tcp_ctime | **Optional.** Response time to result in critical status (seconds). 1438tcp_timeout | **Optional.** Seconds before connection times out. Defaults to 10. 1439tcp_ipv4 | **Optional.** Use IPv4 connection. Defaults to false. 1440tcp_ipv6 | **Optional.** Use IPv6 connection. Defaults to false. 1441 1442 1443### udp <a id="plugin-check-command-udp"></a> 1444 1445The [check_udp](https://www.monitoring-plugins.org/doc/man/check_udp.html) plugin 1446tests UDP connections with the specified host (or unix socket). 1447 1448Custom variables passed as [command parameters](03-monitoring-basics.md#command-passing-parameters): 1449 1450Name | Description 1451----------------|-------------- 1452udp_address | **Optional.** The host's address. Defaults to "$address$" if the host's `address` attribute is set, "$address6$" otherwise. 1453udp_port | **Required.** The port that should be checked. 1454udp_send | **Required.** The payload to send in the UDP datagram. 1455udp_expect | **Required.** The payload to expect in the response datagram. 1456udp_quit | **Optional.** The payload to send to 'close' the session. 1457udp_ipv4 | **Optional.** Use IPv4 connection. Defaults to false. 1458udp_ipv6 | **Optional.** Use IPv6 connection. Defaults to false. 1459 1460 1461### ups <a id="plugin-check-command-ups"></a> 1462 1463The [check_ups](https://www.monitoring-plugins.org/doc/man/check_ups.html) plugin 1464tests the UPS service on the specified host. [Network UPS Tools](http://www.networkupstools.org) 1465 must be running for this plugin to work. 1466 1467Custom variables passed as [command parameters](03-monitoring-basics.md#command-passing-parameters): 1468 1469Name | Description 1470----------------|-------------- 1471ups_address | **Required.** The address of the host running upsd. Defaults to "$address$" if the host's `address` attribute is set, "$address6$" otherwise. 1472ups_name | **Required.** The UPS name. Defaults to `ups`. 1473ups_port | **Optional.** The port to which to connect. Defaults to 3493. 1474ups_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`. 1475ups_warning | **Optional.** The warning threshold for the selected variable. 1476ups_critical | **Optional.** The critical threshold for the selected variable. 1477ups_celsius | **Optional.** Display the temperature in degrees Celsius instead of Fahrenheit. Defaults to `false`. 1478ups_timeout | **Optional.** The number of seconds before the connection times out. Defaults to 10. 1479 1480 1481### users <a id="plugin-check-command-users"></a> 1482 1483The [check_users](https://www.monitoring-plugins.org/doc/man/check_users.html) plugin 1484checks the number of users currently logged in on the local system and generates an 1485error if the number exceeds the thresholds specified. 1486 1487Custom variables passed as [command parameters](03-monitoring-basics.md#command-passing-parameters): 1488 1489Name | Description 1490----------------|-------------- 1491users_wgreater | **Optional.** The user count warning threshold. Defaults to 20. 1492users_cgreater | **Optional.** The user count critical threshold. Defaults to 50. 1493 1494 1495### uptime <a id="plugin-check-command-uptime"></a> 1496 1497The [check_uptime](https://www.monitoring-plugins.org/doc/man/check_uptime.html) plugin 1498checks the uptime of the system using /proc/uptime. 1499 1500Custom variables passed as [command parameters](03-monitoring-basics.md#command-passing-parameters): 1501 1502Name | Description 1503----------------|-------------- 1504uptime_warning | **Required.** Min. number of uptime to generate warning (-w 30m). Defaults to 30m. 1505uptime_critical | **Required.** Min. number of uptime to generate critical alert (-c 15m). Defaults to 15m. 1506uptime_for | **Optional.** Show uptime in a pretty format (Running for x weeks, x days, ...). Defaults to false. 1507uptime_since | **Optional.** Show last boot in yyyy-mm-dd HH:MM:SS format (output from 'uptime -s'). Defaults to false. 1508 1509 1510 1511## Windows Plugins for Icinga 2 <a id="windows-plugins"></a> 1512 1513> **Note** 1514> 1515> These plugins are DEPRECATED in favor of our 1516> [PowerShell Plugins](https://github.com/Icinga/icinga-powershell-plugins) 1517> and may be removed in a future release. 1518> Check the [roadmap](https://github.com/Icinga/icinga2/milestones). 1519 1520To 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. 1521 1522A 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: 1523 1524 include <windows-plugins> 1525 1526One 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. 1527 1528 1529### Threshold syntax <a id="windows-plugins-thresholds"></a> 1530 1531So not specified differently the thresholds for the plugins all follow the same pattern 1532 1533Threshold | Meaning 1534:------------|:---------- 1535"29" | The threshold is 29. 1536"!29" | The threshold is 29, but the negative of the result is returned. 1537"[10-40]" | The threshold is a range from (including) 10 to 40, a value inside means the threshold has been exceeded. 1538"![10-40]" | Same as above, but the result is inverted. 1539 1540 1541### disk-windows <a id="windows-plugins-disk-windows"></a> 1542 1543Check command object for the `check_disk.exe` plugin. 1544Aggregates 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.). 1545The data collection is instant and free disk space (default, see `disk_win_show_used`) is used for threshold computation. 1546 1547> **Note** 1548> 1549> Percentage based thresholds can be used by adding a '%' to the threshold 1550> value. 1551 1552Custom variables: 1553 1554Name | Description 1555:---------------------|:------------ 1556disk\_win\_warn | **Optional**. The warning threshold. Defaults to "20%". 1557disk\_win\_crit | **Optional**. The critical threshold. Defaults to "10%". 1558disk\_win\_path | **Optional**. Check only these paths, default checks all. 1559disk\_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. 1560disk\_win\_exclude | **Optional**. Exclude these drives from check. 1561disk\_win\_show\_used | **Optional**. Use used instead of free space. 1562 1563### load-windows <a id="windows-plugins-load-windows"></a> 1564 1565Check command object for the `check_load.exe` plugin. 1566This 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`](10-icinga-template-library.md#windows-plugins-load-windows). 1567 1568Custom variables: 1569 1570Name | Description 1571:---------------|:------------ 1572load\_win\_warn | **Optional**. The warning threshold. 1573load\_win\_crit | **Optional**. The critical threshold. 1574 1575 1576### memory-windows <a id="windows-plugins-memory-windows"></a> 1577 1578Check command object for the `check_memory.exe` plugin. 1579The memory collection is instant and free memory is used for threshold computation. 1580 1581> **Note** 1582> 1583> Percentage based thresholds can be used by adding a '%' to the threshold 1584> value. Keep in mind that memory\_win\_unit is applied before the 1585> value is calculated. 1586 1587Custom variables: 1588 1589Name | Description 1590:-----------------|:------------ 1591memory\_win\_warn | **Optional**. The warning threshold. Defaults to "10%". 1592memory\_win\_crit | **Optional**. The critical threshold. Defaults to "5%". 1593memory\_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. 1594memory\_win\_show\_used | **Optional**. Show used memory instead of the free memory. 1595 1596 1597### network-windows <a id="windows-plugins-network-windows"></a> 1598 1599Check command object for the `check_network.exe` plugin. 1600Collects the total Bytes inbound and outbound for all interfaces in one second, to itemise interfaces or use a different collection interval use [`perfmon-windows`](10-icinga-template-library.md#windows-plugins-load-windows). 1601 1602Custom variables: 1603 1604Name | Description 1605:-------------------|:------------ 1606network\_win\_warn | **Optional**. The warning threshold. 1607network\_win\_crit | **Optional**. The critical threshold. 1608network\_no\_isatap | **Optional**. Do not print ISATAP interfaces. 1609 1610 1611### perfmon-windows <a id="windows-plugins-perfmon-windows"></a> 1612 1613Check command object for the `check_perfmon.exe` plugin. 1614This 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`. 1615 1616To 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"` 1617 1618Custom variables: 1619 1620Name | Description 1621:---------------------|:------------ 1622perfmon\_win\_warn | **Optional**. The warning threshold. 1623perfmon\_win\_crit | **Optional**. The critical threshold. 1624perfmon\_win\_counter | **Required**. The Performance Counter to use. Ex. `\Processor(_Total)\% Idle Time`. 1625perfmon\_win\_wait | **Optional**. Time in milliseconds to wait between data collection (default: 1000). 1626perfmon\_win\_type | **Optional**. Format in which to expect performance values. Possible are: long, int64 and double (default). 1627perfmon\_win\_syntax | **Optional**. Use this in the performance output instead of `perfmon\_win\_counter`. Exists for graphics compatibility reasons. 1628 1629 1630### ping-windows <a id="windows-plugins-ping-windows"></a> 1631 1632Check command object for the `check_ping.exe` plugin. 1633ping-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. 1634 1635Custom variables: 1636 1637Name | Description 1638:------------------|:------------ 1639ping\_win\_warn | **Optional**. The warning threshold. RTA and package loss separated by comma. 1640ping\_win\_crit | **Optional**. The critical threshold. RTA and package loss separated by comma. 1641ping\_win\_address | **Required**. An IPv4 or IPv6 address. 1642ping\_win\_packets | **Optional**. Number of packages to send. Default: 5. 1643ping\_win\_timeout | **Optional**. The timeout in milliseconds. Default: 1000 1644 1645 1646### procs-windows <a id="windows-plugins-procs-windows"></a> 1647 1648Check command object for `check_procs.exe` plugin. 1649When 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. 1650 1651Custom variables: 1652 1653Name | Description 1654:----------------|:------------ 1655procs\_win\_warn | **Optional**. The warning threshold. 1656procs\_win\_crit | **Optional**. The critical threshold. 1657procs\_win\_user | **Optional**. Count this users processes. 1658 1659 1660### service-windows <a id="windows-plugins-service-windows"></a> 1661 1662Check command object for `check_service.exe` plugin. 1663This 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. 1664 1665Custom variables: 1666 1667Name | Description 1668:-------------------------|:------------ 1669service\_win\_warn | **Optional**. Warn when service is not running. 1670service\_win\_description | **Optional**. If this is set, `service\_win\_service` looks at the service description. 1671service\_win\_service | **Required**. Name of the service to check. 1672 1673 1674### swap-windows <a id="windows-plugins-swap-windows"></a> 1675 1676Check command object for `check_swap.exe` plugin. 1677The data collection is instant. 1678 1679Custom variables: 1680 1681Name | Description 1682:--------------- | :------------ 1683swap\_win\_warn | **Optional**. The warning threshold. Defaults to "10%". 1684swap\_win\_crit | **Optional**. The critical threshold. Defaults to "5%". 1685swap\_win\_unit | **Optional**. The unit to display the received value in, thresholds are interpreted in this unit. Defaults to "mb" (megabyte). 1686swap\_win\_show\_used | **Optional**. Show used swap instead of the free swap. 1687 1688### update-windows <a id="windows-plugins-update-windows"></a> 1689 1690Check command object for `check_update.exe` plugin. 1691Querying 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. 1692 1693> **Note** 1694> 1695> The Network Services Account which runs Icinga 2 by default does not have the required 1696> permissions to run this check. 1697 1698Custom variables: 1699 1700Name | Description 1701:-------------------|:------------ 1702update\_win\_warn | **Optional**. The warning threshold. 1703update\_win\_crit | **Optional**. The critical threshold. 1704update\_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. 1705ignore\_reboot | **Optional**. Set to disable behavior of returning critical if any updates require a reboot. 1706 1707 1708If a warning threshold is set but not a critical threshold, the critical threshold will be set to one greater than the set warning threshold. 1709Unless the `ignore_reboot` flag is set, if any updates require a reboot the plugin will return critical. 1710 1711> **Note** 1712> 1713> If they are enabled, performance data will be shown in the web interface. 1714> If run without the optional parameters, the plugin will output critical if any important updates are available. 1715 1716 1717### uptime-windows <a id="windows-plugins-uptime-windows"></a> 1718 1719Check command object for `check_uptime.exe` plugin. 1720Uses GetTickCount64 to get the uptime, so boot time is not included. 1721 1722Custom variables: 1723 1724Name | Description 1725:-----------------|:------------ 1726uptime\_win\_warn | **Optional**. The warning threshold. 1727uptime\_win\_crit | **Optional**. The critical threshold. 1728uptime\_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). 1729 1730 1731### users-windows <a id="windows-plugins-users-windows"></a> 1732 1733Check command object for `check_users.exe` plugin. 1734 1735Custom variables: 1736 1737Name | Description 1738:----------------|:------------ 1739users\_win\_warn | **Optional**. The warning threshold. 1740users\_win\_crit | **Optional**. The critical threshold. 1741 1742### file-age-windows <a id="windows-plugins-file-age-windows"></a> 1743 1744Check command object for `check_file_age.cmd` command file and `check_file_age.cmd.ps1` plugin. 1745 1746Custom variables: 1747 1748Name | Description 1749:---------------------|:------------ 1750file_age_win_file | **Required**. File name and location 1751file_age_win_warning | **Required**. The warning threshold of file age in seconds. 1752file_age_win_critical | **Required**. The critical threshold of file age in seconds. 1753 1754All variables are required and all variables are positional. The variable order is: file warning critical. 1755 1756The check_file_age.cmd and the check_file_age.cmd.ps1 files are available for [download](https://github.com/KAMI911/icinga2-basic/tree/master/plugins). 1757 1758## Plugin Check Commands for NSClient++ <a id="nscp-plugin-check-commands"></a> 1759 1760There are two methods available for querying NSClient++: 1761 1762* Query the [HTTP API](06-distributed-monitoring.md#distributed-monitoring-windows-nscp-check-api) locally from an Icinga 2 client (requires a running NSClient++ service) 1763* Run a [local CLI check](10-icinga-template-library.md#nscp-check-local) (does not require NSClient++ as a service) 1764 1765Both methods have their advantages and disadvantages. One thing to 1766note: If you rely on performance counter delta calculations such as 1767CPU utilization, please use the HTTP API instead of the CLI sample call. 1768 1769For security reasons, it is advised to enable the NSClient++ HTTP API for local 1770connection from the Icinga 2 client only. Remote connections to the HTTP API 1771are not recommended with using the legacy HTTP API. 1772 1773### nscp_api <a id="nscp-check-api"></a> 1774 1775`check_nscp_api` is part of the Icinga 2 plugins. This plugin is available for 1776both, Windows and Linux/Unix. 1777 1778Verify that the ITL CheckCommand is included in the [icinga2.conf](04-configuration.md#icinga2-conf) configuration file: 1779 1780 vim /etc/icinga2/icinga2.conf 1781 1782 include <plugins> 1783 1784`check_nscp_api` runs queries against the NSClient++ API. Therefore NSClient++ needs to have 1785the `webserver` module enabled, configured and loaded. 1786 1787You can install the webserver using the following CLI commands: 1788 1789 ./nscp.exe web install 1790 ./nscp.exe web password — –set icinga 1791 1792Now you can define specific [queries](https://docs.nsclient.org/reference/check/CheckHelpers.html#queries) 1793and integrate them into Icinga 2. 1794 1795The check plugin `check_nscp_api` can be integrated with the `nscp_api` CheckCommand object: 1796 1797Custom variables: 1798 1799Name | Description 1800:----------------------|:---------------------- 1801nscp\_api\_host | **Required**. NSCP API host address. Defaults to "$address$" if the host's `address` attribute is set, "$address6$" otherwise. 1802nscp\_api\_port | **Optional**. NSCP API port. Defaults to `8443`. 1803nscp\_api\_password | **Required**. NSCP API password. Please check the NSCP documentation for setup details. 1804nscp\_api\_query | **Required**. NSCP API query endpoint. Refer to the NSCP documentation for possible values. 1805nscp\_api\_arguments | **Optional**. NSCP API arguments dictionary either as single strings or key-value pairs using `=`. Refer to the NSCP documentation. 1806 1807`nscp_api_arguments` can be used to pass required thresholds to the executed check. The example below 1808checks the CPU utilization and specifies warning and critical thresholds. 1809 1810``` 1811check_nscp_api --host 10.0.10.148 --password icinga --query check_cpu --arguments show-all warning='load>40' critical='load>30' 1812check_cpu CRITICAL: critical(5m: 48%, 1m: 36%), 5s: 0% | 'total 5m'=48%;40;30 'total 1m'=36%;40;30 'total 5s'=0%;40;30 1813``` 1814 1815 1816### nscp-local <a id="nscp-check-local"></a> 1817 1818Icinga 2 can use the `nscp client` command to run arbitrary NSClient++ checks locally on the client. 1819 1820You can enable these check commands by adding the following the include directive in your 1821[icinga2.conf](04-configuration.md#icinga2-conf) configuration file: 1822 1823 include <nscp> 1824 1825You can also optionally specify an alternative installation directory for NSClient++ by adding 1826the NscpPath constant in your [constants.conf](04-configuration.md#constants-conf) configuration 1827file: 1828 1829 const NscpPath = "C:\\Program Files (x86)\\NSClient++" 1830 1831By default Icinga 2 uses the Microsoft Installer API to determine where NSClient++ is installed. It should 1832not be necessary to manually set this constant. 1833 1834Note that it is not necessary to run NSClient++ as a Windows service for these commands to work. 1835 1836The check command object for NSClient++ is available as `nscp-local`. 1837 1838Custom variables passed as [command parameters](03-monitoring-basics.md#command-passing-parameters): 1839 1840Name | Description 1841----------------|-------------- 1842nscp_log_level | **Optional.** The log level. Defaults to "critical". 1843nscp_load_all | **Optional.** Whether to load all modules. Defaults to false. 1844nscp_modules | **Optional.** An array of NSClient++ modules to load. Defaults to `[ "CheckSystem" ]`. 1845nscp_boot | **Optional.** Whether to use the --boot option. Defaults to true. 1846nscp_query | **Required.** The NSClient++ query. Try `nscp client -q x` for a list. 1847nscp_arguments | **Optional.** An array of query arguments. 1848nscp_showall | **Optional.** Shows more details in plugin output, default to false. 1849 1850> **Tip** 1851> 1852> In order to measure CPU load, you'll need a running NSClient++ service. 1853> Therefore it is advised to use a local [nscp-api](06-distributed-monitoring.md#distributed-monitoring-windows-nscp-check-api) 1854> check against its REST API. 1855 1856### nscp-local-cpu <a id="nscp-check-local-cpu"></a> 1857 1858Check command object for the `check_cpu` NSClient++ plugin. 1859 1860Name | Description 1861--------------------|------------------ 1862nscp_cpu_time | **Optional.** Calculate average usage for the given time intervals. Value has to be an array, default to [ "1m", "5m", "15m" ]. 1863nscp_cpu_warning | **Optional.** Threshold for WARNING state in percent, default to 80. 1864nscp_cpu_critical | **Optional.** Threshold for CRITICAL state in percent, default to 90. 1865nscp_cpu_arguments | **Optional.** Additional arguments. 1866nscp_cpu_showall | **Optional.** Shows more details in plugin output, default to false. 1867 1868### nscp-local-memory <a id="nscp-check-local-memory"></a> 1869 1870Check command object for the `check_memory` NSClient++ plugin. 1871 1872Name | Description 1873----------------------|------------------ 1874nscp_memory_committed | **Optional.** Check for committed memory, default to false. 1875nscp_memory_physical | **Optional.** Check for physical memory, default to true. 1876nscp_memory_free | **Optional.** Switch between checking free (true) or used memory (false), default to false. 1877nscp_memory_warning | **Optional.** Threshold for WARNING state in percent or absolute (use MB, GB, ...), default to 80 (free=false) or 20 (free=true). 1878nscp_memory_critical | **Optional.** Threshold for CRITICAL state in percent or absolute (use MB, GB, ...), default to 90 (free=false) or 10 (free=true). 1879nscp_memory_arguments | **Optional.** Additional arguments. 1880nscp_memory_showall | **Optional.** Shows more details in plugin output, default to false. 1881 1882### nscp-local-os-version <a id="nscp-check-local-os-version"></a> 1883 1884Check command object for the `check_os_version` NSClient++ plugin. 1885 1886This command has the same custom variables like the `nscp-local` check command. 1887 1888### nscp-local-pagefile <a id="nscp-check-local-pagefile"></a> 1889 1890Check command object for the `check_pagefile` NSClient++ plugin. 1891 1892This command has the same custom variables like the `nscp-local` check command. 1893 1894### nscp-local-process <a id="nscp-check-local-process"></a> 1895 1896Check command object for the `check_process` NSClient++ plugin. 1897 1898This command has the same custom variables like the `nscp-local` check command. 1899 1900### nscp-local-service <a id="nscp-check-local-service"></a> 1901 1902Check command object for the `check_service` NSClient++ plugin. 1903 1904Name | Description 1905-----------------------|------------------ 1906nscp_service_name | **Required.** Name of service to check. 1907nscp_service_type | **Optional.** Type to check, default to state. 1908nscp_service_ok | **Optional.** State for return an OK, i.e. for type=state running, stopped, ... 1909nscp_service_otype | **Optional.** Dedicate type for nscp_service_ok, default to nscp_service_state. 1910nscp_service_warning | **Optional.** State for return an WARNING. 1911nscp_service_wtype | **Optional.** Dedicate type for nscp_service_warning, default to nscp_service_state. 1912nscp_service_critical | **Optional.** State for return an CRITICAL. 1913nscp_service_ctype | **Optional.** Dedicate type for nscp_service_critical, default to nscp_service_state. 1914nscp_service_arguments | **Optional.** Additional arguments. 1915nscp_service_showall | **Optional.** Shows more details in plugin output, default to true. 1916 1917### nscp-local-uptime <a id="nscp-check-local-uptime"></a> 1918 1919Check command object for the `check_uptime` NSClient++ plugin. 1920 1921This command has the same custom variables like the `nscp-local` check command. 1922 1923### nscp-local-version <a id="nscp-check-local-version"></a> 1924 1925Check command object for the `check_version` NSClient++ plugin. 1926 1927This command has the same custom variables like the `nscp-local` check command. 1928In addition to that the default value for `nscp_modules` is set to `[ "CheckHelpers" ]`. 1929 1930### nscp-local-disk <a id="nscp-check-local-disk"></a> 1931 1932Check command object for the `check_drivesize` NSClient++ plugin. 1933 1934Name | Description 1935-----------------------|------------------ 1936nscp_disk_drive | **Optional.** Drive character, default to all drives. Can be an array if multiple drives should be monitored. 1937nscp_disk_exclude | **Optional.** Drive character, default to none. Can be an array of drive characters if multiple drives should be excluded. 1938nscp_disk_free | **Optional.** Switch between checking free space (free=true) or used space (free=false), default to false. 1939nscp_disk_warning | **Optional.** Threshold for WARNING in percent or absolute (use MB, GB, ...), default to 80 (used) or 20 percent (free). 1940nscp_disk_critical | **Optional.** Threshold for CRITICAL in percent or absolute (use MB, GB, ...), default to 90 (used) or 10 percent (free). 1941nscp_disk_arguments | **Optional.** Additional arguments. 1942nscp_disk_showall | **Optional.** Shows more details in plugin output, default to true. 1943nscp_modules | **Optional.** An array of NSClient++ modules to load. Defaults to `[ "CheckDisk" ]`. 1944 1945### nscp-local-counter <a id="nscp-check-local-counter"></a> 1946 1947Check command object for the `check_pdh` NSClient++ plugin. 1948 1949Name | Description 1950-----------------------|------------------ 1951nscp_counter_name | **Required.** Performance counter name. 1952nscp_counter_warning | **Optional.** WARNING Threshold. 1953nscp_counter_critical | **Optional.** CRITICAL Threshold. 1954nscp_counter_arguments | **Optional.** Additional arguments. 1955nscp_counter_showall | **Optional.** Shows more details in plugin output, default to false. 1956nscp_counter_perfsyntax | **Optional.** Apply performance data label, e.g. `Total Processor Time` to avoid special character problems. Defaults to `nscp_counter_name`. 1957 1958### nscp-local-tasksched <a id="nscp-check-local-tasksched"></a> 1959 1960Check Command object for the `check_tasksched` NSClient++ plugin. 1961You can check for a single task or for a complete folder (and sub folders) of tasks. 1962 1963Name | Description 1964-----------------------|------------------ 1965nscp_tasksched_name | **Optional.** Name of the task to check. 1966nscp_tasksched_folder | **Optional.** The folder in which the tasks to check reside. 1967nscp_tasksched_recursive | **Optional.** Recurse sub folder, defaults to true. 1968nscp_tasksched_hidden | **Optional.** Look for hidden tasks, defaults to false. 1969nscp_tasksched_warning | **Optional.** Filter which marks items which generates a warning state, defaults to `exit_code != 0`. 1970nscp_tasksched_critical | **Optional.** Filter which marks items which generates a critical state, defaults to `exit_code < 0`. 1971nscp_tasksched_emptystate | **Optional.** Return status to use when nothing matched filter, defaults to warning. 1972nscp_tasksched_perfsyntax | **Optional.** Performance alias syntax., defaults to `%(title)` 1973nscp_tasksched_detailsyntax | **Optional.** Detail level syntax, defaults to `%(folder)/%(title): %(exit_code) != 0` 1974nscp_tasksched_arguments | **Optional.** Additional arguments. 1975nscp_tasksched_showall | **Optional.** Shows more details in plugin output, default to false. 1976nscp_modules | **Optional.** An array of NSClient++ modules to load. Defaults to `[ "CheckTaskSched" ]`. 1977 1978 1979## Plugin Check Commands for Manubulon SNMP <a id="snmp-manubulon-plugin-check-commands"></a> 1980 1981The `SNMP Manubulon Plugin Check Commands` provide configuration for plugin check 1982commands provided by the [SNMP Manubulon project](http://nagios.manubulon.com/index_snmp.html). 1983 1984**Note:** Some plugin parameters are only available in Debian packages or in a 1985[forked repository](https://github.com/dnsmichi/manubulon-snmp) with patches applied. 1986 1987The SNMP manubulon plugin check commands assume that the global constant named `ManubulonPluginDir` 1988is set to the path where the Manubublon SNMP plugins are installed. 1989 1990You can enable these plugin check commands by adding the following the include directive in your 1991[icinga2.conf](04-configuration.md#icinga2-conf) configuration file: 1992 1993 include <manubulon> 1994 1995### Checks by Host Type 1996 1997**N/A** : Not available for this type. 1998 1999**SNMP** : Available for simple SNMP query. 2000 2001**??** : Untested. 2002 2003**Specific** : Script name for platform specific checks. 2004 2005 2006 Host type | Interface | storage | load/cpu | mem | process | env | specific 2007 ------------------------|------------|----------|-----------|-----|----------|-----|------------------------- 2008 Linux | Yes | Yes | Yes | Yes | Yes | No | 2009 Windows | Yes | Yes | Yes | Yes | Yes | No | check_snmp_win.pl 2010 Cisco router/switch | Yes | N/A | Yes | Yes | N/A | Yes | 2011 HP router/switch | Yes | N/A | Yes | Yes | N/A | No | 2012 Bluecoat proxy | Yes | SNMP | Yes | SNMP| No | Yes | 2013 CheckPoint on SPLAT | Yes | Yes | Yes | Yes | Yes | No | check_snmp_cpfw.pl 2014 CheckPoint on Nokia IP | Yes | Yes | Yes | No | ?? | No | check_snmp_vrrp.pl 2015 Boostedge | Yes | Yes | Yes | Yes | ?? | No | check_snmp_boostedge.pl 2016 AS400 | Yes | Yes | Yes | Yes | No | No | 2017 NetsecureOne Netbox | Yes | Yes | Yes | ?? | Yes | No | 2018 Radware Linkproof | Yes | N/A | SNMP | SNMP| No | No | check_snmp_linkproof_nhr <br> check_snmp_vrrp.pl 2019 IronPort | Yes | SNMP | SNMP | SNMP| No | Yes | 2020 Cisco CSS | Yes | ?? | Yes | Yes | No | ?? | check_snmp_css.pl 2021 2022 2023### snmp-env <a id="plugin-check-command-snmp-env"></a> 2024 2025Check command object for the [check_snmp_env.pl](http://nagios.manubulon.com/snmp_env.html) plugin. 2026 2027Custom variables passed as [command parameters](03-monitoring-basics.md#command-passing-parameters): 2028 2029 2030Name | Description 2031------------------------|-------------- 2032snmp_address | **Optional.** The host's address. Defaults to "$address$" if the host's `address` attribute is set, "$address6$" otherwise. 2033snmp_nocrypt | **Optional.** Define SNMP encryption. If set to `false`, `snmp_v3` needs to be enabled. Defaults to `true` (no encryption). 2034snmp_community | **Optional.** The SNMP community. Defaults to "public". 2035snmp_port | **Optional.** The SNMP port connection. 2036snmp_v2 | **Optional.** SNMP version to 2c. Defaults to false. 2037snmp_v3 | **Optional.** SNMP version to 3. Defaults to false. 2038snmp_login | **Optional.** SNMP version 3 username. Defaults to "snmpuser". 2039snmp_password | **Required.** SNMP version 3 password. No value defined as default. 2040snmp_v3_use_privpass | **Optional.** Define to use SNMP version 3 priv password. Defaults to false. 2041snmp_v3_use_authprotocol| **Optional.** Define to use SNMP version 3 authentication protocol. Defaults to false. 2042snmp_authprotocol | **Optional.** SNMP version 3 authentication protocol. Defaults to "md5,des". 2043snmp_privpass | **Required.** SNMP version 3 priv password. No value defined as default. 2044snmp_env_type | **Optional.** Environment Type [cisco|nokia|bc|iron|foundry|linux]. Defaults to "cisco". 2045snmp_env_fan | **Optional.** Minimum fan rpm value (only needed for 'iron' & 'linux') 2046snmp_env_celsius | **Optional.** Maximum temp in degrees celsius (only needed for 'iron' & 'linux') 2047snmp_perf | **Optional.** Enable perfdata values. Defaults to true. 2048snmp_timeout | **Optional.** The command timeout in seconds. Defaults to 5 seconds. 2049 2050### snmp-load <a id="plugin-check-command-snmp-load"></a> 2051 2052Check command object for the [check_snmp_load.pl](http://nagios.manubulon.com/snmp_load.html) plugin. 2053 2054Custom variables passed as [command parameters](03-monitoring-basics.md#command-passing-parameters): 2055 2056 2057Name | Description 2058------------------------|-------------- 2059snmp_address | **Optional.** The host's address. Defaults to "$address$" if the host's `address` attribute is set, "$address6$" otherwise. 2060snmp_nocrypt | **Optional.** Define SNMP encryption. If set to `false`, `snmp_v3` needs to be enabled. Defaults to `true` (no encryption). 2061snmp_community | **Optional.** The SNMP community. Defaults to "public". 2062snmp_port | **Optional.** The SNMP port connection. 2063snmp_v2 | **Optional.** SNMP version to 2c. Defaults to false. 2064snmp_v3 | **Optional.** SNMP version to 3. Defaults to false. 2065snmp_login | **Optional.** SNMP version 3 username. Defaults to "snmpuser". 2066snmp_password | **Required.** SNMP version 3 password. No value defined as default. 2067snmp_v3_use_privpass | **Optional.** Define to use SNMP version 3 priv password. Defaults to false. 2068snmp_v3_use_authprotocol| **Optional.** Define to use SNMP version 3 authentication protocol. Defaults to false. 2069snmp_authprotocol | **Optional.** SNMP version 3 authentication protocol. Defaults to "md5,des". 2070snmp_privpass | **Required.** SNMP version 3 priv password. No value defined as default. 2071snmp_warn | **Optional.** The warning threshold. Change the `snmp_load_type` var to "netsl" for using 3 values. 2072snmp_crit | **Optional.** The critical threshold. Change the `snmp_load_type` var to "netsl" for using 3 values. 2073snmp_load_type | **Optional.** Load type. Defaults to "stand". Check all available types in the [snmp load](http://nagios.manubulon.com/snmp_load.html) documentation. 2074snmp_perf | **Optional.** Enable perfdata values. Defaults to true. 2075snmp_timeout | **Optional.** The command timeout in seconds. Defaults to 5 seconds. 2076 2077### snmp-memory <a id="plugin-check-command-snmp-memory"></a> 2078 2079Check command object for the [check_snmp_mem.pl](http://nagios.manubulon.com/snmp_mem.html) plugin. 2080 2081Custom variables passed as [command parameters](03-monitoring-basics.md#command-passing-parameters): 2082 2083Name | Description 2084------------------------|-------------- 2085snmp_address | **Optional.** The host's address. Defaults to "$address$" if the host's `address` attribute is set, "$address6$" otherwise. 2086snmp_nocrypt | **Optional.** Define SNMP encryption. If set to `false`, `snmp_v3` needs to be enabled. Defaults to `true` (no encryption). 2087snmp_community | **Optional.** The SNMP community. Defaults to "public". 2088snmp_port | **Optional.** The SNMP port connection. 2089snmp_v2 | **Optional.** SNMP version to 2c. Defaults to false. 2090snmp_v3 | **Optional.** SNMP version to 3. Defaults to false. 2091snmp_login | **Optional.** SNMP version 3 username. Defaults to "snmpuser". 2092snmp_password | **Required.** SNMP version 3 password. No value defined as default. 2093snmp_v3_use_privpass | **Optional.** Define to use SNMP version 3 priv password. Defaults to false. 2094snmp_v3_use_authprotocol| **Optional.** Define to use SNMP version 3 authentication protocol. Defaults to false. 2095snmp_authprotocol | **Optional.** SNMP version 3 authentication protocol. Defaults to "md5,des". 2096snmp_privpass | **Required.** SNMP version 3 priv password. No value defined as default. 2097snmp_warn | **Optional.** The warning threshold. 2098snmp_crit | **Optional.** The critical threshold. 2099snmp_is_cisco | **Optional.** Change OIDs for Cisco switches. Defaults to false. 2100snmp_is_hp | **Optional.** Change OIDs for HP/Procurve switches. Defaults to false. 2101snmp_perf | **Optional.** Enable perfdata values. Defaults to true. 2102snmp_memcached | **Optional.** Include cached memory in used memory, Defaults to false. 2103snmp_membuffer | **Optional.** Exclude buffered memory in used memory, Defaults to false. 2104snmp_timeout | **Optional.** The command timeout in seconds. Defaults to 5 seconds. 2105 2106### snmp-storage <a id="plugin-check-command-snmp-storage"></a> 2107 2108Check command object for the [check_snmp_storage.pl](http://nagios.manubulon.com/snmp_storage.html) plugin. 2109 2110Custom variables passed as [command parameters](03-monitoring-basics.md#command-passing-parameters): 2111 2112Name | Description 2113------------------------|-------------- 2114snmp_address | **Optional.** The host's address. Defaults to "$address$" if the host's `address` attribute is set, "$address6$" otherwise. 2115snmp_nocrypt | **Optional.** Define SNMP encryption. If set to `false`, `snmp_v3` needs to be enabled. Defaults to `true` (no encryption). 2116snmp_community | **Optional.** The SNMP community. Defaults to "public". 2117snmp_port | **Optional.** The SNMP port connection. 2118snmp_v2 | **Optional.** SNMP version to 2c. Defaults to false. 2119snmp_v3 | **Optional.** SNMP version to 3. Defaults to false. 2120snmp_login | **Optional.** SNMP version 3 username. Defaults to "snmpuser". 2121snmp_password | **Required.** SNMP version 3 password. No value defined as default. 2122snmp_v3_use_privpass | **Optional.** Define to use SNMP version 3 priv password. Defaults to false. 2123snmp_v3_use_authprotocol| **Optional.** Define to use SNMP version 3 authentication protocol. Defaults to false. 2124snmp_authprotocol | **Optional.** SNMP version 3 authentication protocol. Defaults to "md5,des". 2125snmp_privpass | **Required.** SNMP version 3 priv password. No value defined as default. 2126snmp_warn | **Optional.** The warning threshold. 2127snmp_crit | **Optional.** The critical threshold. 2128snmp_storage_name | **Optional.** Storage name. Default to regex "^/$$". More options available in the [snmp storage](http://nagios.manubulon.com/snmp_storage.html) documentation. 2129snmp_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. 2130snmp_perf | **Optional.** Enable perfdata values. Defaults to true. 2131snmp_exclude | **Optional.** Select all storages except the one(s) selected by -m. No action on storage type selection. 2132snmp_timeout | **Optional.** The command timeout in seconds. Defaults to 5 seconds. 2133snmp_storage_olength | **Optional.** Max-size of the SNMP message, usefull in case of Too Long responses. 2134 2135### snmp-interface <a id="plugin-check-command-snmp-interface"></a> 2136 2137Check command object for the [check_snmp_int.pl](http://nagios.manubulon.com/snmp_int.html) plugin. 2138 2139Custom variables passed as [command parameters](03-monitoring-basics.md#command-passing-parameters): 2140 2141Name | Description 2142----------------------------|-------------- 2143snmp_address | **Optional.** The host's address. Defaults to "$address$" if the host's `address` attribute is set, "$address6$" otherwise. 2144snmp_nocrypt | **Optional.** Define SNMP encryption. If set to `false`, `snmp_v3` needs to be enabled. Defaults to `true` (no encryption). 2145snmp_community | **Optional.** The SNMP community. Defaults to "public". 2146snmp_port | **Optional.** The SNMP port connection. 2147snmp_v2 | **Optional.** SNMP version to 2c. Defaults to false. 2148snmp_v3 | **Optional.** SNMP version to 3. Defaults to false. 2149snmp_login | **Optional.** SNMP version 3 username. Defaults to "snmpuser". 2150snmp_password | **Required.** SNMP version 3 password. No value defined as default. 2151snmp_v3_use_privpass | **Optional.** Define to use SNMP version 3 priv password. Defaults to false. 2152snmp_v3_use_authprotocol | **Optional.** Define to use SNMP version 3 authentication protocol. Defaults to false. 2153snmp_authprotocol | **Optional.** SNMP version 3 authentication protocol. Defaults to "md5,des". 2154snmp_privpass | **Required.** SNMP version 3 priv password. No value defined as default. 2155snmp_warn | **Optional.** The warning threshold. 2156snmp_crit | **Optional.** The critical threshold. 2157snmp_interface | **Optional.** Network interface name. Default to regex "eth0". 2158snmp_interface_inverse | **Optional.** Inverse Interface check, down is ok. Defaults to false as it is missing. 2159snmp_interface_perf | **Optional.** Check the input/output bandwidth of the interface. Defaults to true. 2160snmp_interface_label | **Optional.** Add label before speed in output: in=, out=, errors-out=, etc. 2161snmp_interface_bits_bytes | **Optional.** Output performance data in bits/s or Bytes/s. **Depends** on snmp_interface_kbits set to true. Defaults to true. 2162snmp_interface_percent | **Optional.** Output performance data in % of max speed. Defaults to false. 2163snmp_interface_kbits | **Optional.** Make the warning and critical levels in KBits/s. Defaults to true. 2164snmp_interface_megabytes | **Optional.** Make the warning and critical levels in Mbps or MBps. **Depends** on snmp_interface_kbits set to true. Defaults to true. 2165snmp_interface_64bit | **Optional.** Use 64 bits counters instead of the standard counters when checking bandwidth & performance data for interface >= 1Gbps. Defaults to false. 2166snmp_interface_errors | **Optional.** Add error & discard to Perfparse output. Defaults to true. 2167snmp_interface_extended_checks | **Optional.** Also check the error and discard input/output. When enabled format of `snmp_warn` and `snmp_crit` changes to <In bytes>,<Out bytes>,<In error>,<Out error>,<In disc>,<Out disc>. More options available in the [snmp interface](http://nagios.manubulon.com/snmp_int.html) documentation. Defaults to false. 2168snmp_interface_noregexp | **Optional.** Do not use regexp to match interface name in description OID. Defaults to false. 2169snmp_interface_delta | **Optional.** Delta time of perfcheck. Defaults to "300" (5 min). 2170snmp_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. 2171snmp_interface_ifname | **Optional.** Switch from IF-MIB::ifDescr to IF-MIB::ifName when looking up the interface's name. 2172snmp_interface_ifalias | **Optional.** Switch from IF-MIB::ifDescr to IF-MIB::ifAlias when looking up the interface's name. 2173snmp_interface_weathermap | **Optional.** Output data for ["weathermap" lines](http://docs.nagvis.org/1.9/en_US/lines_weathermap_style.html) in NagVis. **Depends** on `snmp_interface_perf` set to true. Defaults to `false`. **Note**: Available in `check_snmp_int.pl v2.1.0`. 2174snmp_perf | **Optional.** Enable perfdata values. Defaults to true. 2175snmp_timeout | **Optional.** The command timeout in seconds. Defaults to 5 seconds. 2176snmp_interface_admin | **Optional.** Use administrative status instead of operational. Defaults to false. 2177 2178### snmp-process <a id="plugin-check-command-snmp-process"></a> 2179 2180Check command object for the [check_snmp_process.pl](http://nagios.manubulon.com/snmp_process.html) plugin. 2181 2182Custom variables passed as [command parameters](03-monitoring-basics.md#command-passing-parameters): 2183 2184Name | Description 2185---------------------------|-------------- 2186snmp_address | **Optional.** The host's address. Defaults to "$address$" if the host's `address` attribute is set, "$address6$" otherwise. 2187snmp_nocrypt | **Optional.** Define SNMP encryption. If set to `false`, `snmp_v3` needs to be enabled. Defaults to `true` (no encryption). 2188snmp_community | **Optional.** The SNMP community. Defaults to "public". 2189snmp_port | **Optional.** The SNMP port connection. 2190snmp_v2 | **Optional.** SNMP version to 2c. Defaults to false. 2191snmp_v3 | **Optional.** SNMP version to 3. Defaults to false. 2192snmp_login | **Optional.** SNMP version 3 username. Defaults to "snmpuser". 2193snmp_password | **Required.** SNMP version 3 password. No value defined as default. 2194snmp_v3_use_privpass | **Optional.** Define to use SNMP version 3 priv password. Defaults to false. 2195snmp_v3_use_authprotocol | **Optional.** Define to use SNMP version 3 authentication protocol. Defaults to false. 2196snmp_authprotocol | **Optional.** SNMP version 3 authentication protocol. Defaults to "md5,des". 2197snmp_privpass | **Required.** SNMP version 3 priv password. No value defined as default.. 2198snmp_warn | **Optional.** The warning threshold. 2199snmp_crit | **Optional.** The critical threshold. 2200snmp_process_name | **Optional.** Name of the process (regexp). No trailing slash!. Defaults to ".*". 2201snmp_perf | **Optional.** Enable perfdata values. Defaults to true. 2202snmp_timeout | **Optional.** The command timeout in seconds. Defaults to 5 seconds. 2203snmp_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. 2204snmp_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. 2205snmp_process_mem_usage | **Optional.** Define to check memory usage for the process. Defaults to false. 2206snmp_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". 2207snmp_process_cpu_usage | **Optional.** Define to check CPU usage for the process. Defaults to false. 2208snmp_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". 2209 2210### snmp-service <a id="plugin-check-command-snmp-service"></a> 2211 2212Check command object for the [check_snmp_win.pl](http://nagios.manubulon.com/snmp_windows.html) plugin. 2213 2214Custom variables passed as [command parameters](03-monitoring-basics.md#command-passing-parameters): 2215 2216Name | Description 2217---------------------------|-------------- 2218snmp_address | **Optional.** The host's address. Defaults to "$address$" if the host's `address` attribute is set, "$address6$" otherwise. 2219snmp_nocrypt | **Optional.** Define SNMP encryption. If set to `false`, `snmp_v3` needs to be enabled. Defaults to `true` (no encryption). 2220snmp_community | **Optional.** The SNMP community. Defaults to "public". 2221snmp_port | **Optional.** The SNMP port connection. 2222snmp_v2 | **Optional.** SNMP version to 2c. Defaults to false. 2223snmp_v3 | **Optional.** SNMP version to 3. Defaults to false. 2224snmp_login | **Optional.** SNMP version 3 username. Defaults to "snmpuser". 2225snmp_password | **Required.** SNMP version 3 password. No value defined as default. 2226snmp_v3_use_privpass | **Optional.** Define to use SNMP version 3 priv password. Defaults to false. 2227snmp_v3_use_authprotocol | **Optional.** Define to use SNMP version 3 authentication protocol. Defaults to false. 2228snmp_authprotocol | **Optional.** SNMP version 3 authentication protocol. Defaults to "md5,des". 2229snmp_privpass | **Required.** SNMP version 3 priv password. No value defined as default. 2230snmp_timeout | **Optional.** The command timeout in seconds. Defaults to 5 seconds. 2231snmp_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 ".*". 2232snmp_service_count | **Optional.** Compare matching services with a specified number instead of the number of names provided. 2233snmp_service_showall | **Optional.** Show all services in the output, instead of only the non-active ones. Defaults to false. 2234snmp_service_noregexp | **Optional.** Do not use regexp to match NAME in service description. Defaults to false. 2235 2236 2237## Contributed Plugin Check Commands <a id="plugin-contrib"></a> 2238 2239The contributed Plugin Check Commands provides various additional command definitions 2240contributed by community members. 2241 2242These check commands assume that the global constant named `PluginContribDir` 2243is set to the path where the user installs custom plugins and can be enabled by 2244uncommenting the corresponding line in [icinga2.conf](04-configuration.md#icinga2-conf): 2245 2246``` 2247vim /etc/icinga2/icinga2.conf 2248 2249include <plugin-contrib> 2250``` 2251 2252This is enabled by default since Icinga 2 2.5.0. 2253 2254### Big Data <a id="plugin-contrib-big-data"></a> 2255 2256This category contains plugins for various Big Data systems. 2257 2258#### cloudera_service_status <a id="plugin-contrib-command-cloudera_service_status"></a> 2259 2260The [cloudera_service_status](https://github.com/miso231/icinga2-cloudera-plugin) plugin 2261uses Cloudera Manager API to monitor cluster services 2262 2263Custom variables passed as [command parameters](03-monitoring-basics.md#command-passing-parameters): 2264 2265Name | Description 2266----------------------|----------------------------------------------------------------- 2267cloudera_host | **Required.** Hostname of cloudera server. 2268cloudera_port | **Optional.** Port where cloudera is listening. Defaults to 443. 2269cloudera_user | **Required.** The username for the API connection. 2270cloudera_pass | **Required.** The password for the API connection. 2271cloudera_api_version | **Required.** API version of cloudera. 2272cloudera_cluster | **Required.** The cluster name in cloudera manager. 2273cloudera_service | **Required.** Name of cluster service to be checked. 2274cloudera_verify_ssl | **Optional.** Verify SSL. Defaults to true. 2275 2276#### cloudera_hdfs_space <a id="plugin-contrib-command-cloudera_hdfs_space"></a> 2277 2278The [cloudera_hdfs_space](https://github.com/miso231/icinga2-cloudera-plugin) plugin 2279connects to Hadoop Namenode and gets used capacity of selected disk 2280 2281Custom variables passed as [command parameters](03-monitoring-basics.md#command-passing-parameters): 2282 2283Name | Description 2284--------------------------|----------------------------------------------------------------- 2285cloudera_hdfs_space_host | **Required.** Namenode host to connect to. 2286cloudera_hdfs_space_port | **Optional.** Namenode port (default 50070). 2287cloudera_hdfs_space_disk | **Required.** HDFS disk to check. 2288cloudera_hdfs_space_warn | **Required.** Warning threshold in percent. 2289cloudera_hdfs_space_crit | **Required.** Critical threshold in percent. 2290 2291#### cloudera_hdfs_files <a id="plugin-contrib-command-cloudera_hdfs_files"></a> 2292 2293The [cloudera_hdfs_files](https://github.com/miso231/icinga2-cloudera-plugin) plugin 2294connects to Hadoop Namenode and gets total number of files on HDFS 2295 2296Custom variables passed as [command parameters](03-monitoring-basics.md#command-passing-parameters): 2297 2298Name | Description 2299--------------------------|----------------------------------------------------------------- 2300cloudera_hdfs_files_host | **Required.** Namenode host to connect to. 2301cloudera_hdfs_files_port | **Optional.** Namenode port (default 50070). 2302cloudera_hdfs_files_warn | **Required.** Warning threshold. 2303cloudera_hdfs_files_crit | **Required.** Critical threshold. 2304cloudera_hdfs_files_max | **Required.** Max files count that causes problems (default 140,000,000). 2305 2306### Databases <a id="plugin-contrib-databases"></a> 2307 2308This category contains plugins for various database servers. 2309 2310#### db2_health <a id="plugin-contrib-command-db2_health"></a> 2311 2312The [check_db2_health](https://labs.consol.de/nagios/check_db2_health/) plugin 2313uses the `DBD::DB2` Perl library to monitor a [DB2](https://www.ibm.com/support/knowledgecenter/SSEPGG_11.1.0/) 2314database. 2315 2316The Git repository is located on [GitHub](https://github.com/lausser/check_db2_health). 2317 2318Custom variables passed as [command parameters](03-monitoring-basics.md#command-passing-parameters): 2319 2320Name | Description 2321---------------------------------|------------------------------------------------------------------------------------------------------------------------------ 2322db2_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) 2323db2_health_username | **Optional.** The username for the database connection. 2324db2_health_password | **Optional.** The password for the database connection. 2325db2_health_port | **Optional.** The port where DB2 is listening. 2326db2_health_warning | **Optional.** The warning threshold depending on the mode. 2327db2_health_critical | **Optional.** The critical threshold depending on the mode. 2328db2_health_mode | **Required.** The mode uses predefined keywords for the different checks. For example "connection-time", "database-usage" or "sql". 2329db2_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). 2330db2_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. 2331db2_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. 2332db2_health_regexp | **Optional.** If set to true, "db2_health_name" will be interpreted as a regular expression. Defaults to false. 2333db2_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". 2334db2_health_maxinactivity | **Optional.** Used for the maximum amount of time a certain event has not happened. 2335db2_health_mitigation | **Optional.** Classifies the severity of an offline tablespace. 2336db2_health_lookback | **Optional.** How many days in the past db2_health check should look back to calculate exitcode. 2337db2_health_report | **Optional.** Report can be used to output only the bad news. Possible values are "short", "long", "html". Defaults to `short`. 2338db2_health_not_catalogued | **Optional.** Set this variable to false if you want to use a catalogued locally database. Defaults to `true`. 2339db2_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". 2340db2_health_env_db2_version | **Optional.** Specifies the DB2 version as environment variable `DB2_VERSION`. 2341 2342#### mssql_health <a id="plugin-contrib-command-mssql_health"></a> 2343 2344The [check_mssql_health](https://labs.consol.de/nagios/check_mssql_health/index.html) plugin 2345uses the `DBD::Sybase` Perl library based on [FreeTDS](https://www.freetds.org/) to monitor a 2346[MS SQL](https://www.microsoft.com/en-us/sql-server/) server. 2347 2348The Git repository is located on [GitHub](https://github.com/lausser/check_mssql_health). 2349 2350Custom variables passed as [command parameters](03-monitoring-basics.md#command-passing-parameters): 2351 2352Name | Description 2353---------------------------------|------------------------------------------------------------------------------------------------------------------------------ 2354mssql_health_hostname | **Optional.** Specifies the database hostname or address. No default because you typically use "mssql_health_server". 2355mssql_health_username | **Optional.** The username for the database connection. 2356mssql_health_password | **Optional.** The password for the database connection. 2357mssql_health_port | **Optional.** Specifies the database port. No default because you typically use "mssql_health_server". 2358mssql_health_server | **Optional.** The name of a predefined connection (in freetds.conf). 2359mssql_health_currentdb | **Optional.** The name of a database which is used as the current database for the connection. 2360mssql_health_offlineok | **Optional.** Set this to true if offline databases are perfectly ok for you. Defaults to false. 2361mssql_health_nooffline | **Optional.** Set this to true to ignore offline databases. Defaults to false. 2362mssql_health_dbthresholds | **Optional.** With this parameter thresholds are read from the database table check_mssql_health_thresholds. 2363mssql_health_notemp | **Optional.** Set this to true to ignore temporary databases/tablespaces. Defaults to false. 2364mssql_health_commit | **Optional.** Set this to true to turn on autocommit for the dbd::sybase module. Defaults to false. 2365mssql_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). 2366mssql_health_mode | **Required.** The mode uses predefined keywords for the different checks. For example "connection-time", "database-free" or "sql". 2367mssql_health_regexp | **Optional.** If set to true, "mssql_health_name" will be interpreted as a regular expression. Defaults to false. 2368mssql_health_warning | **Optional.** The warning threshold depending on the mode. 2369mssql_health_critical | **Optional.** The critical threshold depending on the mode. 2370mssql_health_warningx | **Optional.** A possible override for the warning threshold. 2371mssql_health_criticalx | **Optional.** A possible override for the critical threshold. 2372mssql_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". 2373mssql_health_name | **Optional.** Depending on the mode this could be the database name or a SQL statement. 2374mssql_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. 2375mssql_health_name3 | **Optional.** Additional argument used for 'database-file-free' mode for example. 2376mssql_health_extraopts | **Optional.** Read command line arguments from an external file. 2377mssql_health_blacklist | **Optional.** Blacklist some (missing/failed) components 2378mssql_health_mitigation | **Optional.** The parameter allows you to change a critical error to a warning. 2379mssql_health_lookback | **Optional.** The amount of time you want to look back when calculating average rates. 2380mssql_health_environment | **Optional.** Add a variable to the plugin's environment. 2381mssql_health_negate | **Optional.** Emulate the negate plugin. --negate warning=critical --negate unknown=critical. 2382mssql_health_morphmessage | **Optional.** Modify the final output message. 2383mssql_health_morphperfdata | **Optional.** The parameter allows you to change performance data labels. 2384mssql_health_selectedperfdata | **Optional.** The parameter allows you to limit the list of performance data. 2385mssql_health_report | **Optional.** Report can be used to output only the bad news. Possible values are "short", "long", "html". Defaults to `short`. 2386mssql_health_multiline | **Optional.** Multiline output. 2387mssql_health_withmymodulesdyndir | **Optional.** Add-on modules for the my-modes will be searched in this directory. 2388mssql_health_statefilesdir | **Optional.** An alternate directory where the plugin can save files. 2389mssql_health_isvalidtime | **Optional.** Signals the plugin to return OK if now is not a valid check time. 2390mssql_health_timeout | **Optional.** Plugin timeout. Defaults to 15s. 2391 2392#### mysql_health <a id="plugin-contrib-command-mysql_health"></a> 2393 2394The [check_mysql_health](https://labs.consol.de/nagios/check_mysql_health/index.html) plugin 2395uses the `DBD::MySQL` Perl library to monitor a 2396[MySQL](https://dev.mysql.com/downloads/mysql/) or [MariaDB](https://mariadb.org/about/) database. 2397 2398The Git repository is located on [GitHub](https://github.com/lausser/check_mysql_health). 2399 2400Custom variables passed as [command parameters](03-monitoring-basics.md#command-passing-parameters): 2401 2402Name | Description 2403---------------------------------|------------------------------------------------------------------------------------------------------------------------------ 2404mysql_health_hostname | **Required.** Specifies the database hostname or address. Defaults to "$address$" or "$address6$" if the `address` attribute is not set. 2405mysql_health_port | **Optional.** Specifies the database port. Defaults to 3306 (or 1186 for "mysql_health_mode" cluster). 2406mysql_health_socket | **Optional.** Specifies the database unix socket. No default. 2407mysql_health_username | **Optional.** The username for the database connection. 2408mysql_health_password | **Optional.** The password for the database connection. 2409mysql_health_database | **Optional.** The database to connect to. Defaults to information_schema. 2410mysql_health_warning | **Optional.** The warning threshold depending on the mode. 2411mysql_health_critical | **Optional.** The critical threshold depending on the mode. 2412mysql_health_warningx | **Optional.** The extended warning thresholds depending on the mode. 2413mysql_health_criticalx | **Optional.** The extended critical thresholds depending on the mode. 2414mysql_health_mode | **Required.** The mode uses predefined keywords for the different checks. For example "connection-time", "slave-lag" or "sql". 2415mysql_health_method | **Optional.** How the plugin should connect to the database (`dbi` for using DBD::Mysql (default), `mysql` for using the mysql-Tool). 2416mysql_health_commit | **Optional.** Turns on autocommit for the dbd::\* module. 2417mysql_health_notemp | **Optional.** Ignore temporary databases/tablespaces. 2418mysql_health_nooffline | **Optional.** Skip the offline databases. 2419mysql_health_regexp | **Optional.** Parameter name/name2/name3 will be interpreted as (perl) regular expression. 2420mysql_health_name | **Optional.** The name of a specific component to check. 2421mysql_health_name2 | **Optional.** The secondary name of a component. 2422mysql_health_name3 | **Optional.** The tertiary name of a component. 2423mysql_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". 2424mysql_health_labelformat | **Optional.** One of those formats pnp4nagios or groundwork. Defaults to pnp4nagios. 2425mysql_health_extraopts | **Optional.** Read command line arguments from an external file. 2426mysql_health_blacklist | **Optional.** Blacklist some (missing/failed) components 2427mysql_health_mitigation | **Optional.** The parameter allows you to change a critical error to a warning. 2428mysql_health_lookback | **Optional.** The amount of time you want to look back when calculating average rates. 2429mysql_health_environment | **Optional.** Add a variable to the plugin's environment. 2430mysql_health_morphmessage | **Optional.** Modify the final output message. 2431mysql_health_morphperfdata | **Optional.** The parameter allows you to change performance data labels. 2432mysql_health_selectedperfdata | **Optional.** The parameter allows you to limit the list of performance data. 2433mysql_health_report | **Optional.** Can be used to shorten the output. 2434mysql_health_multiline | **Optional.** Multiline output. 2435mysql_health_negate | **Optional.** Emulate the negate plugin. --negate warning=critical --negate unknown=critical. 2436mysql_health_withmymodulesdyndir | **Optional.** Add-on modules for the my-modes will be searched in this directory. 2437mysql_health_statefilesdir | **Optional.** An alternate directory where the plugin can save files. 2438mysql_health_isvalidtime | **Optional.** Signals the plugin to return OK if now is not a valid check time. 2439mysql_health_timeout | **Optional.** Plugin timeout. Defaults to 60s. 2440 2441#### oracle_health <a id="plugin-contrib-command-oracle_health"></a> 2442 2443The [check_oracle_health](https://labs.consol.de/nagios/check_oracle_health/index.html) plugin 2444uses the `DBD::Oracle` Perl library to monitor an [Oracle](https://www.oracle.com/database/) database. 2445 2446The Git repository is located on [GitHub](https://github.com/lausser/check_oracle_health). 2447 2448Custom variables passed as [command parameters](03-monitoring-basics.md#command-passing-parameters): 2449 2450Name | Description 2451---------------------------------|------------------------------------------------------------------------------------------------------------------------------ 2452oracle_health_connect | **Required.** Specifies the database connection string (from tnsnames.ora). 2453oracle_health_username | **Optional.** The username for the database connection. 2454oracle_health_password | **Optional.** The password for the database connection. 2455oracle_health_warning | **Optional.** The warning threshold depending on the mode. 2456oracle_health_critical | **Optional.** The critical threshold depending on the mode. 2457oracle_health_mode | **Required.** The mode uses predefined keywords for the different checks. For example "connection-time", "flash-recovery-area-usage" or "sql". 2458oracle_health_method | **Optional.** How the plugin should connect to the database (`dbi` for using DBD::Oracle (default), `sqlplus` for using the sqlplus-Tool). 2459oracle_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. 2460oracle_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. 2461oracle_health_regexp | **Optional.** If set to true, "oracle_health_name" will be interpreted as a regular expression. Defaults to false. 2462oracle_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". 2463oracle_health_ident | **Optional.** If set to true, outputs instance and database names. Defaults to false. 2464oracle_health_commit | **Optional.** Set this to true to turn on autocommit for the dbd::oracle module. Defaults to false. 2465oracle_health_noperfdata | **Optional.** Set this to true if you want to disable perfdata. Defaults to false. 2466oracle_health_timeout | **Optional.** Plugin timeout. Defaults to 60s. 2467oracle_health_report | **Optional.** Select the plugin output format. Can be short or long. Defaults to long. 2468oracle_health_notemp | **Optional.** Set this to true to hide temporary and system tablespaces. Defaults to false. 2469 2470Environment Macros: 2471 2472Name | Description 2473--------------------|------------------------------------------------------------------------------------------------------------------------------------------ 2474ORACLE\_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`. 2475LD\_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`. 2476TNS\_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`. 2477 2478#### postgres <a id="plugin-contrib-command-postgres"></a> 2479 2480The [check_postgres](https://bucardo.org/wiki/Check_postgres) plugin 2481uses the `psql` binary to monitor a [PostgreSQL](https://www.postgresql.org/about/) database. 2482 2483The Git repository is located on [GitHub](https://github.com/bucardo/check_postgres). 2484 2485Custom variables passed as [command parameters](03-monitoring-basics.md#command-passing-parameters): 2486 2487Name | Description 2488---------------------------------|------------------------------------------------------------------------------------------------------------------------------ 2489postgres_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. 2490postgres_port | **Optional.** Specifies the database port. Defaults to 5432. 2491postgres_dbname | **Optional.** Specifies the database name to connect to. Defaults to "postgres" or "template1". 2492postgres_dbuser | **Optional.** The username for the database connection. Defaults to "postgres". 2493postgres_dbpass | **Optional.** The password for the database connection. You can use a .pgpass file instead. 2494postgres_dbservice | **Optional.** Specifies the service name to use inside of pg_service.conf. 2495postgres_warning | **Optional.** Specifies the warning threshold, range depends on the action. 2496postgres_critical | **Optional.** Specifies the critical threshold, range depends on the action. 2497postgres_include | **Optional.** Specifies name(s) items to specifically include (e.g. tables), depends on the action. 2498postgres_exclude | **Optional.** Specifies name(s) items to specifically exclude (e.g. tables), depends on the action. 2499postgres_includeuser | **Optional.** Include objects owned by certain users. 2500postgres_excludeuser | **Optional.** Exclude objects owned by certain users. 2501postgres_standby | **Optional.** Assume that the server is in continuous WAL recovery mode if set to true. Defaults to false. 2502postgres_production | **Optional.** Assume that the server is in production mode if set to true. Defaults to false. 2503postgres_action | **Required.** Determines the test executed. 2504postgres_unixsocket | **Optional.** If "postgres_unixsocket" is set to true, the unix socket is used instead of an address. Defaults to false. 2505postgres_query | **Optional.** Query for "custom_query" action. 2506postgres_valtype | **Optional.** Value type of query result for "custom_query". 2507postgres_reverse | **Optional.** If "postgres_reverse" is set, warning and critical values are reversed for "custom_query" action. 2508postgres_tempdir | **Optional.** Specify directory for temporary files. The default directory is dependent on the OS. More details [here](https://perldoc.perl.org/File/Spec.html). 2509 2510#### mongodb <a id="plugin-contrib-command-mongodb"></a> 2511 2512The [check_mongodb.py](https://github.com/mzupan/nagios-plugin-mongodb) plugin 2513uses the `pymongo` Python library to monitor a [MongoDB](https://docs.mongodb.com/manual/) instance. 2514 2515Custom variables passed as [command parameters](03-monitoring-basics.md#command-passing-parameters): 2516 2517Name | Description 2518---------------------------------|------------------------------------------------------------------------------------------------------------------------------ 2519mongodb_host | **Required.** Specifies the hostname or address. Defaults to "$address$" if the host's `address` attribute is set, "$address6$" otherwise. 2520mongodb_port | **Required.** The port mongodb is running on. 2521mongodb_user | **Optional.** The username you want to login as. 2522mongodb_passwd | **Optional.** The password you want to use for that user. 2523mongodb_authdb | **Optional.** The database you want to authenticate against. 2524mongodb_warning | **Optional.** The warning threshold we want to set. 2525mongodb_critical | **Optional.** The critical threshold we want to set. 2526mongodb_action | **Required.** The action you want to take. 2527mongodb_maxlag | **Optional.** Get max replication lag (for replication_lag action only). 2528mongodb_mappedmemory | **Optional.** Get mapped memory instead of resident (if resident memory can not be read). 2529mongodb_perfdata | **Optional.** Enable output of Nagios performance data. 2530mongodb_database | **Optional.** Specify the database to check. 2531mongodb_alldatabases | **Optional.** Check all databases (action database_size). 2532mongodb_ssl | **Optional.** Connect using SSL. 2533mongodb_replicaset | **Optional.** Connect to replicaset. 2534mongodb_replcheck | **Optional.** If set to true, will enable the mongodb_replicaset value needed for "replica_primary" check. 2535mongodb_querytype | **Optional.** The query type to check [query\|insert\|update\|delete\|getmore\|command] from queries_per_second. 2536mongodb_collection | **Optional.** Specify the collection to check. 2537mongodb_sampletime | **Optional.** Time used to sample number of pages faults. 2538 2539#### elasticsearch <a id="plugin-contrib-command-elasticsearch"></a> 2540 2541The [check_elasticsearch](https://github.com/anchor/nagios-plugin-elasticsearch) plugin 2542uses the HTTP API to monitor an [Elasticsearch](https://www.elastic.co/products/elasticsearch) node. 2543 2544Custom variables passed as [command parameters](03-monitoring-basics.md#command-passing-parameters): 2545 2546Name | Description 2547-----------------------------|------------------------------------------------------------------------------------------------------- 2548elasticsearch_host | **Optional.** Hostname or network address to probe. Defaults to "$address$" if the host's `address` attribute is set, "$address6$" otherwise. 2549elasticsearch_failuredomain | **Optional.** A comma-separated list of ElasticSearch attributes that make up your cluster's failure domain. 2550elasticsearch_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. 2551elasticsearch_port | **Optional.** TCP port to probe. The ElasticSearch API should be listening here. Defaults to 9200. 2552elasticsearch_prefix | **Optional.** Optional prefix (e.g. 'es') for the ElasticSearch API. Defaults to ''. 2553elasticsearch_yellowcritical | **Optional.** Instead of issuing a 'warning' for a yellow cluster state, issue a 'critical' alert. Defaults to false. 2554 2555#### redis <a id="plugin-contrib-command-redis"></a> 2556 2557The [check_redis.pl](https://github.com/willixix/naglio-plugins/blob/master/check_redis.pl) plugin 2558uses the `Redis` Perl library to monitor a [Redis](https://redis.io/) instance. The plugin can 2559measure response time, hitrate, memory utilization, check replication synchronization, etc. It is 2560also possible to test data in a specified key and calculate averages or summaries on ranges. 2561 2562Custom variables passed as [command parameters](03-monitoring-basics.md#command-passing-parameters): 2563 2564Name | Description 2565-------------------------|-------------------------------------------------------------------------------------------------------------- 2566redis_hostname | **Required.** Hostname or IP Address to check. Defaults to "$address$" if the host's `address` attribute is set, "$address6$" otherwise. 2567redis_port | **Optional.** Port number to query. Default to "6379". 2568redis_database | **Optional.** Database name (usually a number) to query, needed for **redis_query**. 2569redis_password | **Optional.** Password for Redis authentication. Safer alternative is to put them in a file and use **redis_credentials**. 2570redis_credentials | **Optional.** Credentials file to read for Redis authentication. 2571redis_timeout | **Optional.** Allows to set timeout for execution of this plugin. 2572redis_variables | **Optional.** List of variables from info data to do threshold checks on. 2573redis_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. 2574redis_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. 2575redis_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. 2576redis_perfvars | **Optional.** This allows to list variables which values will go only into perfparse output (and not for threshold checking). 2577redis_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. 2578redis_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". 2579redis_query | **Optional.** Option specifies key to query and optional variable name to assign the results to after. 2580redis_option | **Optional.** Specifiers are separated by "," and must include NAME or PATTERN. 2581redis_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. 2582redis_hitrate | **Optional.** Calculates Hitrate and specify values are interpreted as WARNING and CRITICAL thresholds. 2583redis_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. 2584redis_total_memory | **Optional.** Amount of memory on a system for memory utilization calculation. Use system memory or max_memory setting of redis. 2585redis_replication_delay | **Optional.** Allows to set threshold on replication delay info. 2586 2587#### proxysql <a id="plugin-contrib-command-proxysql"></a> 2588 2589The [check_proxysql](https://github.com/sysown/proxysql-nagios) plugin, 2590uses the `proxysql` binary to monitor [proxysql](https://proxysql.com/). 2591 2592Custom variables passed as [command parameters](03-monitoring-basics.md#command-passing-parameters): 2593 2594Name | Description 2595-----------------------------|---------------------------------------------------------------------------------- 2596proxysql_user | **Optional.** ProxySQL admin username (default=admin) 2597proxysql_password | **Optional.** ProxySQL admin password (default=admin) 2598proxysql_host | **Optional.** ProxySQL hostname / IP (default=127.0.0.1) 2599proxysql_port | **Optional.** ProxySQL admin port (default=6032) 2600proxysql_defaultfile | **Optional.** ProxySQL defaults file 2601proxysql_type | **Required.** ProxySQL check type (one of conns,hg,rules,status,var) 2602proxysql_name | **Optional.** ProxySQL variable name to check 2603proxysql_lower | **Optional.** Alert if ProxySQL value are LOWER than defined WARN / CRIT thresholds (only applies to 'var' check type) 2604proxysql_runtime | **Optional.** Force ProxySQL Nagios check to query the runtime_mysql_XXX tables rather than the mysql_XXX tables 2605proxysql_warning | **Optional.** Warning threshold 2606proxysql_critical | **Optional.** Critical threshold 2607proxysql\_include\_hostgroup | **Optional.** ProxySQL hostgroup(s) to include (only applies to '--type hg' checks, accepts comma-separated list) 2608proxysql\_ignore\_hostgroup | **Optional.** ProxySQL hostgroup(s) to ignore (only applies to '--type hg' checks, accepts comma-separated list) 2609 2610#### memcached <a id="plugin-contrib-command-memcached"></a> 2611 2612The [check_memcached](https://exchange.icinga.com/exchange/check_memcached) plugin 2613checks the health of a running [memcached](https://memcached.org/) service. 2614 2615On Debian/Ubuntu, it is provided with the `nagios-plugin-contrib` package. 2616 2617Custom variables passed as [command parameters](03-monitoring-basics.md#command-passing-parameters): 2618 2619Name | Description 2620--------------------------------|---------------------------------------------------------------------------------- 2621memcached_hostname | **Required.** Hostname or IP address (required) optional ':port' overrides -p 2622memcached_port | **Optional.** Port number (default: 11211) 2623memcached_verbose | **Optional.** verbose messages 2624memcached_keep | **Optional.** Keep up to this many items in the history object in memcached (default: 30) 2625memcached_minimum_stat_interval | **Optional.** Minimum time interval (in minutes) to use to analyse stats. (default: 30) 2626memcached_warning_hits_misses | **Optional.** Generate warning if quotient of hits/misses falls below this value (default: 2.0) 2627memcached_warning_evictions | **Optional.** Generate warning if number of evictions exceeds this threshold. 0=disable. (default: 10) 2628memcached_timeout | **Optional.** timeout in seconds (default: 1.0) 2629memcached_key | **Optional.** key name for history object (default: check_memcached) 2630memcached_expiry | **Optional.** expiry time in seconds for history object (default: 7200) 2631memcached_performance_output | **Optional.** output performance statistics as rate-per-minute figures (better suited to pnp4nagios) 2632 2633### Hardware <a id="plugin-contrib-hardware"></a> 2634 2635This category includes all plugin check commands for various hardware checks. 2636 2637#### hpasm <a id="plugin-contrib-command-hpasm"></a> 2638 2639The [check_hpasm](https://labs.consol.de/de/nagios/check_hpasm/index.html) plugin 2640monitors the hardware health of HP Proliant Servers, provided that the `hpasm` 2641(HP Advanced Server Management) software is installed. It is also able to monitor 2642the system health of HP Bladesystems and storage systems. 2643 2644The plugin can run in two different ways: 2645 26461. Local execution using the `hpasmcli` command line tool. 26472. Remote SNMP query which invokes the HP Insight Tools on the remote node. 2648 2649You can either set or omit `hpasm_hostname` custom variable and select the corresponding node. 2650 2651The `hpasm_remote` attribute enables the plugin to execute remote SNMP queries if set to `true`. 2652For compatibility reasons this attribute uses `true` as default value, and ensures that 2653specifying the `hpasm_hostname` always enables remote checks. 2654 2655Custom variables passed as [command parameters](03-monitoring-basics.md#command-passing-parameters): 2656 2657Name | Description 2658--------------------------------|----------------------------------------------------------------------- 2659hpasm_hostname | **Optional.** The host's address. Defaults to "$address$" if the host's `address` attribute is set, "$address6$" otherwise. 2660hpasm_community | **Optional.** SNMP community of the server (SNMP v1/2 only). 2661hpasm_protocol | **Optional.** The SNMP protocol to use (default: 2c, other possibilities: 1,3). 2662hpasm_port | **Optional.** The SNMP port to use (default: 161). 2663hpasm_blacklist | **Optional.** Blacklist some (missing/failed) components. 2664hpasm_ignore-dimms | **Optional.** Ignore "N/A"-DIMM status on misc. servers (e.g. older DL320). 2665hpasm_ignore-fan-redundancy | **Optional.** Ignore missing redundancy partners. 2666hpasm_customthresholds | **Optional.** Use custom thresholds for certain temperatures. 2667hpasm_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. 2668hpasm_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. 2669hpasm_username | **Optional.** The securityName for the USM security model (SNMPv3 only). 2670hpasm_authpassword | **Optional.** The authentication password for SNMPv3. 2671hpasm_authprotocol | **Optional.** The authentication protocol for SNMPv3 (md5\|sha). 2672hpasm_privpassword | **Optional.** The password for authPriv security level. 2673hpasm_privprotocol | **Optional.** The private protocol for SNMPv3 (des\|aes\|aes128\|3des\|3desde). 2674hpasm_servertype | **Optional.** The type of the server: proliant (default) or bladesystem. 2675hpasm_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. 2676hpasm_remote | **Optional.** Run remote SNMP checks if enabled. Otherwise checks are executed locally using the `hpasmcli` binary. Defaults to `true`. 2677 2678#### openmanage <a id="plugin-contrib-command-openmanage"></a> 2679 2680The [check_openmanage](http://folk.uio.no/trondham/software/check_openmanage.html) plugin 2681checks the hardware health of Dell PowerEdge (and some PowerVault) servers. 2682It uses the Dell OpenManage Server Administrator (OMSA) software, which must be running on 2683the monitored system. check_openmanage can be used remotely with SNMP or locally with icinga2 agent, 2684check_by_ssh or similar, whichever suits your needs and particular taste. 2685 2686The plugin checks the health of the storage subsystem, power supplies, memory modules, 2687temperature probes etc., and gives an alert if any of the components are faulty or operate outside normal parameters. 2688 2689Custom variables passed as [command parameters](03-monitoring-basics.md#command-passing-parameters): 2690 2691Name | Description 2692--------------------------------|----------------------------------------------------------------------- 2693openmanage_all | **Optional.** Check everything, even log content 2694openmanage_blacklist | **Optional.** Blacklist missing and/or failed components 2695openmanage_check | **Optional.** Fine-tune which components are checked 2696openmanage_community | **Optional.** SNMP community string [default=public] 2697openmanage_config | **Optional.** Specify configuration file 2698openmanage_critical | **Optional.** Custom temperature critical limits 2699openmanage_extinfo | **Optional.** Append system info to alerts 2700openmanage_fahrenheit | **Optional.** Use Fahrenheit as temperature unit 2701openmanage_hostname | **Optional.** Hostname or IP (required for SNMP) 2702openmanage_htmlinfo | **Optional.** HTML output with clickable links 2703openmanage_info | **Optional.** Prefix any alerts with the service tag 2704openmanage_ipv6 | **Optional.** Use IPv6 instead of IPv4 [default=no] 2705openmanage_legacy_perfdata | **Optional.** Legacy performance data output 2706openmanage_no_storage | **Optional.** Don't check storage 2707openmanage_only | **Optional.** Only check a certain component or alert type 2708openmanage_perfdata | **Optional.** Output performance data [default=no] 2709openmanage_port | **Optional.** SNMP port number [default=161] 2710openmanage_protocol | **Optional.** SNMP protocol version [default=2c] 2711openmanage_short_state | **Optional.** Prefix alerts with alert state abbreviated 2712openmanage_show_blacklist | **Optional.** Show blacklistings in OK output 2713openmanage_state | **Optional.** Prefix alerts with alert state 2714openmanage_tcp | **Optional.** Use TCP instead of UDP [default=no] 2715openmanage_timeout | **Optional.** Plugin timeout in seconds [default=30] 2716openmanage_vdisk_critical | **Optional.** Make any alerts on virtual disks critical 2717openmanage_warning | **Optional.** Custom temperature warning limits 2718 2719#### lmsensors <a id="plugin-contrib-command-lmsensors"></a> 2720 2721The [check_lmsensors](https://github.com/jackbenny/check_temp) plugin, 2722uses the `lm-sensors` binary to monitor temperature sensors. 2723 2724Custom variables passed as [command parameters](03-monitoring-basics.md#command-passing-parameters): 2725 2726Name | Description 2727------------------------|---------------------------------------------------------------------------------- 2728lmsensors_warning | **Required.** Exit with WARNING status if above INTEGER degrees 2729lmsensors_critical | **Required.** Exit with CRITICAL status if above INTEGER degrees 2730lmsensors_sensor | **Optional.** Set what to monitor, for example CPU or MB (or M/B). Check sensors for the correct word. Default is CPU. 2731 2732#### hddtemp <a id="plugin-contrib-command-hddtemp"></a> 2733 2734The [check_hddtemp](https://github.com/vint21h/nagios-check-hddtemp) plugin, 2735uses the `hddtemp` binary to monitor hard drive temperature. 2736 2737Custom variables passed as [command parameters](03-monitoring-basics.md#command-passing-parameters): 2738 2739Name | Description 2740------------------------|---------------------------------------------------------------------------------- 2741hddtemp_server | **Required.** server name or address 2742hddtemp_port | **Optional.** port number 2743hddtemp_devices | **Optional.** comma separated devices list, or empty for all devices in hddtemp response 2744hddtemp_separator | **Optional.** hddtemp separator 2745hddtemp_warning | **Required.** warning temperature 2746hddtemp_critical | **Required.** critical temperature 2747hddtemp_timeout | **Optional.** receiving data from hddtemp operation network timeout 2748hddtemp_performance | **Optional.** If set, return performance data 2749hddtemp_quiet | **Optional.** If set, be quiet 2750 2751The following sane default value are specified: 2752``` 2753vars.hddtemp_server = "127.0.0.1" 2754vars.hddtemp_warning = 55 2755vars.hddtemp_critical = 60 2756vars.hddtemp_performance = true 2757vars.hddtemp_timeout = 5 2758``` 2759 2760#### adaptec-raid <a id="plugin-contrib-command-adaptec-raid"></a> 2761 2762The [check_adaptec_raid](https://github.com/thomas-krenn/check_adaptec_raid) plugin 2763uses the `arcconf` binary to monitor Adaptec RAID controllers. 2764 2765Custom variables passed as [command parameters](03-monitoring-basics.md#command-passing-parameters): 2766 2767Name | Description 2768--------------------------------|----------------------------------------------------------------------- 2769adaptec_controller_number | **Required.** Controller number to monitor. 2770arcconf_path | **Required.** Path to the `arcconf` binary, e.g. "/sbin/arcconf". 2771 2772#### lsi-raid <a id="plugin-contrib-command-lsi-raid"></a> 2773 2774The [check_lsi_raid](https://github.com/thomas-krenn/check_lsi_raid) plugin 2775uses the `storcli` binary to monitor MegaRAID RAID controllers. 2776 2777Custom variables passed as [command parameters](03-monitoring-basics.md#command-passing-parameters): 2778 2779Name | Description 2780--------------------------------|----------------------------------------------------------------------- 2781lsi_controller_number | **Optional.** Controller number to monitor. 2782storcli_path | **Optional.** Path to the `storcli` binary, e.g. "/usr/sbin/storcli". 2783lsi_enclosure_id | **Optional.** Enclosure numbers to be checked, comma-separated. 2784lsi_ld_id | **Optional.** Logical devices to be checked, comma-separated. 2785lsi_pd_id | **Optional.** Physical devices to be checked, comma-separated. 2786lsi_temp_warning | **Optional.** RAID controller warning temperature. 2787lsi_temp_critical | **Optional.** RAID controller critical temperature. 2788lsi_pd_temp_warning | **Optional.** Disk warning temperature. 2789lsi_pd_temp_critical | **Optional.** Disk critical temperature. 2790lsi_bbu_temp_warning | **Optional.** Battery warning temperature. 2791lsi_bbu_temp_critical | **Optional.** Battery critical temperature. 2792lsi_cv_temp_warning | **Optional.** CacheVault warning temperature. 2793lsi_cv_temp_critical | **Optional.** CacheVault critical temperature. 2794lsi_ignored_media_errors | **Optional.** Warning threshold for media errors. 2795lsi_ignored_other_errors | **Optional.** Warning threshold for other errors. 2796lsi_ignored_predictive_fails | **Optional.** Warning threshold for predictive failures. 2797lsi_ignored_shield_counters | **Optional.** Warning threshold for shield counter. 2798lsi_ignored_bbm_counters | **Optional.** Warning threshold for BBM counter. 2799lsi_bbu | **Optional.** Define if BBU is present and it's state should be checked. 2800lsi_noenclosures | **Optional.** If set to true, does not check enclosures. 2801lsi_nosudo | **Optional.** If set to true, does not use sudo when running storcli. 2802lsi_nocleanlogs | **Optional.** If set to true, does not clean up the log files after executing storcli checks. 2803 2804 2805#### smart-attributes <a id="plugin-contrib-command-smart-attributes"></a> 2806 2807The [check_smart_attributes](https://github.com/thomas-krenn/check_smart_attributes) plugin 2808uses the `smartctl` binary to monitor SMART values of SSDs and HDDs. 2809 2810Custom variables passed as [command parameters](03-monitoring-basics.md#command-passing-parameters): 2811 2812Name | Description 2813--------------------------------|----------------------------------------------------------------------- 2814smart_attributes_config_path | **Required.** Path to the smart attributes config file (e.g. check_smartdb.json). 2815smart_attributes_device | **Required.** Device name (e.g. /dev/sda) to monitor. 2816 2817 2818### IcingaCLI <a id="plugin-contrib-icingacli"></a> 2819 2820This category includes all plugins using the icingacli provided by Icinga Web 2. 2821 2822The 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. 2823 2824#### Business Process <a id="plugin-contrib-icingacli-businessprocess"></a> 2825 2826This subcommand is provided by the [business process module](https://exchange.icinga.com/icinga/Business+Process) 2827and executed as `icingacli businessprocess` CLI command. 2828 2829Custom variables passed as [command parameters](03-monitoring-basics.md#command-passing-parameters): 2830 2831Name | Description 2832------------------------------------------|----------------------------------------------------------------------------------------- 2833icingacli_businessprocess_process | **Required.** Business process to monitor. 2834icingacli_businessprocess_config | **Optional.** Configuration file containing your business process without file extension. 2835icingacli_businessprocess_details | **Optional.** Get details for root cause analysis. Defaults to false. 2836icingacli_businessprocess_statetype | **Optional.** Define which state type to look at, `soft` or `hard`. Overrides the default value inside the businessprocess module, if configured. 2837 2838#### Director <a id="plugin-contrib-icingacli-director"></a> 2839 2840This subcommand is provided by the [director module](https://github.com/Icinga/icingaweb2-module-director) > 1.4.2 and executed as `icingacli director health check`. Please refer to the [documentation](https://github.com/Icinga/icingaweb2-module-director/blob/master/doc/60-CLI.md#health-check-plugin) for all available sub-checks. 2841 2842Custom variables passed as [command parameters](03-monitoring-basics.md#command-passing-parameters): 2843 2844Name | Description 2845------------------------------------------|----------------------------------------------------------------------------------------- 2846icingacli_director_check | **Optional.** Run only a specific test suite. 2847icingacli_director_db | **Optional.** Use a specific Icinga Web DB resource. 2848 2849#### Elasticsearch <a id="plugin-contrib-icingacli-elasticsearch"></a> 2850 2851This subcommand is provided by the [elasticsearch_module](https://github.com/Icinga/icingaweb2-module-elasticsearch) and executed as `icingacli elasticsearch check`. 2852 2853* The value of `icingacli_elasticsearch_instance` is the same like in the configuration of the module. 2854* 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` 2855* The thresholds are just numerical values. They get checked against how many events match the filter within the given timeframe. 2856* The value of `icingacli_elasticsearch_index` is an index pattern. e.g. `logstash*` 2857 2858Name | Description 2859------------------------------------------|----------------------------------------------------------------------------------------- 2860icingacli_elasticsearch_instance | **Required.** The Elasticsearch to connect to 2861icingacli_elasticsearch_index | **Required.** Index pattern to use when searching 2862icingacli_elasticsearch_critical | **Required.** Critical threshold 2863icingacli_elasticsearch_warning | **Required.** Warning threshold 2864icingacli_elasticsearch_filter | **Required.** Filter for events 2865icingacli_elasticsearch_from | **Optional.** Negative value of time to search from now (Default: -5m) 2866 2867#### x509 <a id="plugin-contrib-icingacli-x509"></a> 2868 2869This subcommand is provided by the [x509 module](https://github.com/Icinga/icingaweb2-module-x509) and executed as `icingacli x509 check host`. Please refer to the [documentation](https://github.com/Icinga/icingaweb2-module-x509/blob/master/doc/10-Monitoring.md#host-check-command) for more information. 2870 2871Custom variables passed as [command parameters](03-monitoring-basics.md#command-passing-parameters): 2872 2873Name | Description 2874------------------------------------------|----------------------------------------------------------------------------------------- 2875icingacli_x509_ip | **Required.** A hosts IP address [or] 2876icingacli_x509_host | **Required.** A hosts name 2877icingacli_x509_port | **Optional.** The port to check in particular 2878icingacli_x509_warning | **Optional.** Less remaining time results in state WARNING (Default: 25%) 2879icingacli_x509_critical | **Optional.** Less remaining time results in state CRITICAL (Default: 10%) 2880icingacli_x509_allow_self_signed | **Optional.** Ignore if a certificate or its issuer has been self-signed (Default: false) 2881 2882### IPMI Devices <a id="plugin-contrib-ipmi"></a> 2883 2884This category includes all plugins for IPMI devices. 2885 2886#### ipmi-sensor <a id="plugin-contrib-command-ipmi-sensor"></a> 2887 2888The [check_ipmi_sensor](https://github.com/thomas-krenn/check_ipmi_sensor_v3) plugin 2889uses the `ipmimonitoring` binary to monitor sensor data for IPMI devices. Please 2890read the [documentation](https://www.thomas-krenn.com/en/wiki/IPMI_Sensor_Monitoring_Plugin) 2891for installation and configuration details. 2892 2893Custom variables passed as [command parameters](03-monitoring-basics.md#command-passing-parameters): 2894 2895Name | Description 2896---------------------------------|----------------------------------------------------------------------------------------------------- 2897ipmi_address | **Required.** Specifies the remote host (IPMI device) to check. Defaults to "$address$". 2898ipmi_config_file | **Optional.** Path to the FreeIPMI configuration file. It should contain IPMI username, IPMI password, and IPMI privilege-level. 2899ipmi_username | **Optional.** The IPMI username. 2900ipmi_password | **Optional.** The IPMI password. 2901ipmi_privilege_level | **Optional.** The IPMI privilege level of the IPMI user. 2902ipmi_backward_compatibility_mode | **Optional.** Enable backward compatibility mode, useful for FreeIPMI 0.5.\* (this omits FreeIPMI options "--quiet-cache" and "--sdr-cache-recreate"). 2903ipmi_sensor_type | **Optional.** Limit sensors to query based on IPMI sensor type. Examples for IPMI sensor types are 'Fan', 'Temperature' and 'Voltage'. 2904ipmi_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. 2905ipmi_exclude_sensor_id | **Optional.** Exclude sensor matching ipmi_sensor_id. 2906ipmi_exclude_sensor | **Optional.** Exclude sensor based on IPMI sensor type. (Comma-separated) 2907ipmi_exclude_sel | **Optional.** Exclude SEL entries of specific sensor types. (comma-separated list). 2908ipmi_sensor_id | **Optional.** Include sensor matching ipmi_sensor_id. 2909ipmi_protocol_lan_version | **Optional.** Change the protocol LAN version. Defaults to "LAN_2_0". 2910ipmi_number_of_active_fans | **Optional.** Number of fans that should be active. Otherwise a WARNING state is returned. 2911ipmi_show_fru | **Optional.** Print the product serial number if it is available in the IPMI FRU data. 2912ipmi_show_assettag | **Optional.** Print the assettag if it is available in the IPMI FRU data. (--fru is mandatory) 2913ipmi_show_board | **Optional.** Print additional motherboard informations if it is available in the IPMI FRU data. (--fru is mandatory) 2914ipmi_no_sel_checking | **Optional.** Turn off system event log checking via ipmi-sel. 2915ipmi_no_thresholds | **Optional.** Turn off performance data thresholds from output-sensor-thresholds. 2916ipmi_verbose | **Optional.** Be Verbose multi line output, also with additional details for warnings. 2917ipmi_debug | **Optional.** Be Verbose debugging output, followed by normal multi line output. 2918ipmi_unify_file | **Optional.** Path to the unify file to unify sensor names. 2919 2920#### ipmi-alive <a id="plugin-contrib-command-ipmi-alive"></a> 2921 2922The `ipmi-alive` check commands allows you to create a ping check for the IPMI Interface. 2923 2924Custom variables passed as [command parameters](03-monitoring-basics.md#command-passing-parameters): 2925 2926Name | Description 2927---------------------------------|----------------------------------------------------------------------------------------------------- 2928ping_address | **Optional.** The address of the IPMI interface. Defaults to "$address$" if the IPMI interface's `address` attribute is set, "$address6$" otherwise. 2929ping_wrta | **Optional.** The RTA warning threshold in milliseconds. Defaults to 5000. 2930ping_wpl | **Optional.** The packet loss warning threshold in %. Defaults to 100. 2931ping_crta | **Optional.** The RTA critical threshold in milliseconds. Defaults to 5000. 2932ping_cpl | **Optional.** The packet loss critical threshold in %. Defaults to 100. 2933ping_packets | **Optional.** The number of packets to send. Defaults to 1. 2934ping_timeout | **Optional.** The plugin timeout in seconds. Defaults to 0 (no timeout). 2935 2936 2937### Log Management <a id="plugins-contrib-log-management"></a> 2938 2939This category includes all plugins for log management, for example [Logstash](https://www.elastic.co/products/logstash). 2940 2941#### logstash <a id="plugins-contrib-command-logstash"></a> 2942 2943The [logstash](https://github.com/NETWAYS/check_logstash) plugin connects to 2944the Node API of Logstash. This plugin requires at least Logstash version 5.0.x. 2945 2946The Node API is not activated by default. You have to configure your Logstash 2947installation in order to allow plugin connections. 2948 2949Name | Description 2950---------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ 2951logstash_hostname | **Optional.** Hostname where Logstash is running. Defaults to `check_address` 2952logstash_port | **Optional.** Port where Logstash is listening for API requests. Defaults to 9600 2953logstash_filedesc_warn | **Optional.** Warning threshold of file descriptor usage in percent. Defaults to 85 (percent). 2954logstash_filedesc_crit | **Optional.** Critical threshold of file descriptor usage in percent. Defaults to 95 (percent). 2955logstash_heap_warn | **Optional.** Warning threshold of heap usage in percent. Defaults to 70 (percent). 2956logstash_heap_crit | **Optional.** Critical threshold of heap usage in percent Defaults to 80 (percent). 2957logstash_inflight_warn | **Optional.** Warning threshold of inflight events. 2958logstash_inflight_crit | **Optional.** Critical threshold of inflight events. 2959logstash_cpu_warn | **Optional.** Warning threshold for cpu usage in percent. 2960logstash_cpu_crit | **Optional.** Critical threshold for cpu usage in percent. 2961 2962#### logfiles <a id="plugins-contrib-command-logfiles"></a> 2963 2964The [logfiles](https://labs.consol.de/nagios/check_logfiles/) plugin finds 2965specified patterns in log files. 2966 2967Name | Description 2968----------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ 2969logfiles_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. 2970logfiles_logfile | **Optional.** This is the name of the log file you want to scan. 2971logfiles_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. 2972logfiles_critical_pattern | **Optional.** A regular expression which will trigger a critical error. 2973logfiles_warning_pattern | **Optional.** A regular expression which will trigger a warning error. 2974logfiles_critical_exception | **Optional.** A regular expression, the exceptions which are not counted as critical errors. 2975logfiles_warning_exception | **Optional.** A regular expression, the exceptions which are not counted as warning errors. 2976logfiles_ok_pattern | **Optional.** A regular expression which resets the error counters. 2977logfiles_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. 2978logfiles_syslog_server | **Optional.** With this option you limit the pattern matching to lines originating from the host check_logfiles is running on. 2979logfiles_syslog_client | **Optional.** With this option you limit the pattern matching to lines originating from the host named in this option. 2980logfiles_sticky | **Optional.** Errors are propagated through successive runs. 2981logfiles_unstick | **Optional.** Resets sticky errors. 2982logfiles_config | **Optional.** The name of a configuration file. 2983logfiles_configdir | **Optional.** The name of a configuration directory. Configfiles ending in .cfg or .conf are (recursively) imported. 2984logfiles_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. 2985logfiles_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. 2986logfiles_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. 2987logfiles_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. 2988logfiles_winwarncrit | **Optional.** With this parameter messages in the eventlog are classified by the type WARNING/ERROR (Default: off). Replaces or complements warning/criticalpattern. 2989logfiles_run_unique | **Optional.** This parameter prevents check_logfiles from starting when there’s already another instance using the same config file. (exits with UNKNOWN). 2990logfiles_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. 2991logfiles_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. 2992logfiles_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. 2993 2994 2995### Metrics <a id="plugin-contrib-metrics"></a> 2996 2997This category includes all plugins for metric-based checks. 2998 2999#### graphite <a id="plugin-contrib-command-graphite"></a> 3000 3001The [check_graphite](https://github.com/obfuscurity/nagios-scripts) plugin 3002uses the `rest-client` Ruby library to monitor a [Graphite](https://graphiteapp.org) instance. 3003 3004Custom variables passed as [command parameters](03-monitoring-basics.md#command-passing-parameters): 3005 3006Name | Description 3007------------------------------------|----------------------------------------------------------------------------------------------------- 3008graphite_url | **Required.** Target url. 3009graphite_metric | **Required.** Metric path string. 3010graphite_shortname | **Optional.** Metric short name (used for performance data). 3011graphite_duration | **Optional.** Length, in minute of data to parse (default: 5). 3012graphite_function | **Optional.** Function applied to metrics for thresholds (default: average). 3013graphite_warning | **Required.** Warning threshold. 3014graphite_critical | **Required.** Critical threshold. 3015graphite_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. 3016graphite_message | **Optional.** Text message to output (default: "metric count:"). 3017graphite_zero_on_error | **Optional.** Return 0 on a graphite 500 error. 3018graphite_link_graph | **Optional.** Add a link in the plugin output, showing a 24h graph for this metric in graphite. 3019 3020### Network Components <a id="plugin-contrib-network-components"></a> 3021 3022This category includes all plugins for various network components like routers, switches and firewalls. 3023 3024#### interfacetable <a id="plugin-contrib-command-interfacetable"></a> 3025 3026The [check_interfacetable_v3t](http://www.tontonitch.com/tiki/tiki-index.php?page=Nagios+plugins+-+interfacetable_v3t) plugin 3027generates a html page containing information about the monitored node and all of its interfaces. 3028 3029The Git repository is located on [GitHub](https://github.com/Tontonitch/interfacetable_v3t). 3030 3031Custom variables passed as [command parameters](03-monitoring-basics.md#command-passing-parameters): 3032 3033Name | Description 3034------------------------------------|----------------------------------------------------------------------------------------------------- 3035interfacetable_hostquery | **Required.** Specifies the remote host to poll. Defaults to "$address$". 3036interfacetable_hostdisplay | **Optional.** Specifies the hostname to display in the HTML link. Defaults to "$host.display_name$". 3037interfacetable_regex | **Optional.** Interface names and property names for some other options will be interpreted as regular expressions. Defaults to false. 3038interfacetable_outputshort | **Optional.** Reduce the verbosity of the plugin output. Defaults to false. 3039interfacetable_exclude | **Optional.** Comma separated list of interfaces globally excluded from the monitoring. 3040interfacetable_include | **Optional.** Comma separated list of interfaces globally included in the monitoring. 3041interfacetable_aliasmatching | **Optional.** Allow you to specify alias in addition to interface names. Defaults to false. 3042interfacetable_excludetraffic | **Optional.** Comma separated list of interfaces excluded from traffic checks. 3043interfacetable_includetraffic | **Optional.** Comma separated list of interfaces included for traffic checks. 3044interfacetable_warningtraffic | **Optional.** Interface traffic load percentage leading to a warning alert. 3045interfacetable_criticaltraffic | **Optional.** Interface traffic load percentage leading to a critical alert. 3046interfacetable_pkt | **Optional.** Add unicast/non-unicast pkt stats for each interface. 3047interfacetable_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. 3048interfacetable_trackproperty | **Optional.** List of tracked properties. 3049interfacetable_excludeproperty | **Optional.** Comma separated list of interfaces excluded from the property tracking. 3050interfacetable_includeproperty | **Optional.** Comma separated list of interfaces included in the property tracking. 3051interfacetable_community | **Optional.** Specifies the snmp v1/v2c community string. Defaults to "public" if using snmp v1/v2c, ignored using v3. 3052interfacetable_snmpv2 | **Optional.** Use snmp v2c. Defaults to false. 3053interfacetable_login | **Optional.** Login for snmpv3 authentication. 3054interfacetable_passwd | **Optional.** Auth password for snmpv3 authentication. 3055interfacetable_privpass | **Optional.** Priv password for snmpv3 authentication. 3056interfacetable_protocols | **Optional.** Authentication protocol,Priv protocol for snmpv3 authentication. 3057interfacetable_domain | **Optional.** SNMP transport domain. 3058interfacetable_contextname | **Optional.** Context name for the snmp requests. 3059interfacetable_port | **Optional.** SNMP port. Defaults to standard port. 3060interfacetable_64bits | **Optional.** Use SNMP 64-bits counters. Defaults to false. 3061interfacetable_maxrepetitions | **Optional.** Increasing this value may enhance snmp query performances by gathering more results at one time. 3062interfacetable_snmptimeout | **Optional.** Define the Transport Layer timeout for the snmp queries. 3063interfacetable_snmpretries | **Optional.** Define the number of times to retry sending a SNMP message. 3064interfacetable_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. 3065interfacetable_unixsnmp | **Optional.** Use unix snmp utilities for snmp requests. Defaults to false, which means use the perl bindings. 3066interfacetable_enableperfdata | **Optional.** Enable port performance data. Defaults to false. 3067interfacetable_perfdataformat | **Optional.** Define which performance data will be generated. Possible values are "full" (default), "loadonly", "globalonly". 3068interfacetable_perfdatathreshold | **Optional.** Define which thresholds are printed in the generated performance data. Possible values are "full" (default), "loadonly", "globalonly". 3069interfacetable_perfdatadir | **Optional.** When specified, the performance data are also written directly to a file, in the specified location. 3070interfacetable_perfdataservicedesc | **Optional.** Specify additional parameters for output performance data to PNP. Defaults to "$service.name$", only affects **interfacetable_perfdatadir**. 3071interfacetable_grapher | **Optional.** Specify the used graphing solution. Possible values are "pnp4nagios" (default), "nagiosgrapher", "netwaysgrapherv2" and "ingraph". 3072interfacetable_grapherurl | **Optional.** Graphing system url. Default depends on **interfacetable_grapher**. 3073interfacetable_portperfunit | **Optional.** Traffic could be reported in bits (counters) or in bps (calculated value). 3074interfacetable_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". 3075interfacetable_duplex | **Optional.** Add the duplex mode property for each interface in the interface table. Defaults to false. 3076interfacetable_stp | **Optional.** Add the stp state property for each interface in the interface table. Defaults to false. 3077interfacetable_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" 3078interfacetable_noipinfo | **Optional.** Remove the ip information for each interface from the interface table. Defaults to false. 3079interfacetable_alias | **Optional.** Add the alias information for each interface in the interface table. Defaults to false. 3080interfacetable_accessmethod | **Optional.** Access method for a shortcut to the host in the HTML page. Format is : <method>[:<target>] Where method can be: ssh, telnet, http or https. 3081interfacetable_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. 3082interfacetable_delta | **Optional.** Set the delta used for interface throughput calculation in seconds. 3083interfacetable_ifs | **Optional.** Input field separator. Defaults to ",". 3084interfacetable_cache | **Optional.** Define the retention time of the cached data in seconds. 3085interfacetable_noifloadgradient | **Optional.** Disable color gradient from green over yellow to red for the load percentage. Defaults to false. 3086interfacetable_nohuman | **Optional.** Do not translate bandwidth usage in human readable format. Defaults to false. 3087interfacetable_snapshot | **Optional.** Force the plugin to run like if it was the first launch. Defaults to false. 3088interfacetable_timeout | **Optional.** Define the global timeout limit of the plugin in seconds. Defaults to "15s". 3089interfacetable_css | **Optional.** Define the css stylesheet used by the generated html files. Possible values are "classic", "icinga" or "icinga-alternate1". 3090interfacetable_config | **Optional.** Specify a config file to load. 3091interfacetable_noconfigtable | **Optional.** Disable configuration table on the generated HTML page. Defaults to false. 3092interfacetable_notips | **Optional.** Disable the tips in the generated html tables. Defaults to false. 3093interfacetable_defaulttablesorting | **Optional.** Default table sorting can be "index" (default) or "name". 3094interfacetable_tablesplit | **Optional.** Generate multiple interface tables, one per interface type. Defaults to false. 3095interfacetable_notype | **Optional.** Remove the interface type for each interface. Defaults to false. 3096 3097#### iftraffic <a id="plugin-contrib-command-iftraffic"></a> 3098 3099The [check_iftraffic](https://exchange.icinga.com/exchange/iftraffic) plugin 3100checks the utilization of a given interface name using the SNMP protocol. 3101 3102Custom variables passed as [command parameters](03-monitoring-basics.md#command-passing-parameters): 3103 3104Name | Description 3105------------------------|--------------------------------------------------------- 3106iftraffic_address | **Required.** Specifies the remote host. Defaults to "$address$". 3107iftraffic_community | **Optional.** SNMP community. Defaults to "public'" if omitted. 3108iftraffic_version | **Optional.** SNMP version to use. Defaults to "1" if omitted. Requires v1.0.2+. 3109iftraffic_interface | **Required.** Queried interface name. 3110iftraffic_bandwidth | **Required.** Interface maximum speed in kilo/mega/giga/bits per second. 3111iftraffic_units | **Optional.** Interface units can be one of these values: `g` (gigabits/s),`m` (megabits/s), `k` (kilobits/s),`b` (bits/s) 3112iftraffic_warn | **Optional.** Percent of bandwidth usage necessary to result in warning status (defaults to `85`). 3113iftraffic_crit | **Optional.** Percent of bandwidth usage necessary to result in critical status (defaults to `98`). 3114iftraffic_max_counter | **Optional.** Maximum counter value of net devices in kilo/mega/giga/bytes. 3115 3116#### iftraffic64 <a id="plugin-contrib-command-iftraffic64"></a> 3117 3118The [check_iftraffic64](https://exchange.icinga.com/exchange/check_iftraffic64) plugin 3119checks the utilization of a given interface name using the SNMP protocol. 3120 3121Custom variables passed as [command parameters](03-monitoring-basics.md#command-passing-parameters): 3122 3123Name | Description 3124------------------------|--------------------------------------------------------- 3125iftraffic64_address | **Required.** Specifies the remote host. Defaults to "$address$". 3126iftraffic64_community | **Optional.** SNMP community. Defaults to "public'" if omitted. 3127iftraffic64_interface | **Required.** Queried interface name. 3128iftraffic64_bandwidth | **Required.** Interface maximum speed in kilo/mega/giga/bits per second. 3129iftraffic64_units | **Optional.** Interface units can be one of these values: `g` (gigabits/s),`m` (megabits/s), `k` (kilobits/s),`b` (bits/s) 3130iftraffic64_warn | **Optional.** Percent of bandwidth usage necessary to result in warning status (defaults to `85`). 3131iftraffic64_crit | **Optional.** Percent of bandwidth usage necessary to result in critical status (defaults to `98`). 3132iftraffic64_max_counter | **Optional.** Maximum counter value of net devices in kilo/mega/giga/bytes. 3133 3134#### interfaces <a id="plugin-contrib-command-interfaces"></a> 3135 3136The [check_interfaces](https://git.netways.org/plugins/check_interfaces) plugin 3137uses SNMP to monitor network interfaces and their utilization. 3138 3139Custom variables passed as [command parameters](03-monitoring-basics.md#command-passing-parameters): 3140 3141Name | Description 3142--------------------------|--------------------------------------------------------- 3143interfaces_address | **Optional.** The host's address. Defaults to "$address$" if the host's `address` attribute is set, "$address6$" otherwise. 3144interfaces_regex | **Optional.** Interface list regexp. 3145interfaces_exclude_regex | **Optional.** Interface list negative regexp. 3146interfaces_errors | **Optional.** Number of in errors (CRC errors for cisco) to consider a warning (default 50). 3147interface_out_errors | **Optional.** Number of out errors (collisions for cisco) to consider a warning (default same as in errors). 3148interfaces_perfdata | **Optional.** perfdata from last check result. 3149interfaces_prefix | **Optional.** Prefix interface names with this label. 3150interfaces_lastcheck | **Optional.** Last checktime (unixtime). 3151interfaces_bandwidth | **Optional.** Bandwidth warn level in percent. 3152interfaces_speed | **Optional.** Override speed detection with this value (bits per sec). 3153interfaces_trim | **Optional.** Cut this number of characters from the start of interface descriptions. 3154interfaces_mode | **Optional.** Special operating mode (default,cisco,nonbulk,bintec). 3155interfaces_auth_proto | **Optional.** SNMPv3 Auth Protocol (SHA\|MD5) 3156interfaces_auth_phrase | **Optional.** SNMPv3 Auth Phrase 3157interfaces_priv_proto | **Optional.** SNMPv3 Privacy Protocol (AES\|DES) 3158interfaces_priv_phrase | **Optional.** SNMPv3 Privacy Phrase 3159interfaces_user | **Optional.** SNMPv3 User 3160interfaces_down_is_ok | **Optional.** Disables critical alerts for down interfaces. 3161interfaces_aliases | **Optional.** Retrieves the interface description. 3162interfaces_match_aliases | **Optional.** Also match against aliases (Option --aliases automatically enabled). 3163interfaces_timeout | **Optional.** Sets the SNMP timeout (in ms). 3164interfaces_sleep | **Optional.** Sleep between every SNMP query (in ms). 3165interfaces_names | **Optional.** If set to true, use ifName instead of ifDescr. 3166 3167#### nwc_health <a id="plugin-contrib-command-nwc_health"></a> 3168 3169The [check_nwc_health](https://labs.consol.de/de/nagios/check_nwc_health/index.html) plugin 3170uses SNMP to monitor network components. The plugin is able to generate interface statistics, 3171check hardware (CPU, memory, fan, power, etc.), monitor firewall policies, HRSP, load-balancer 3172pools, processor and memory usage. 3173 3174Currently the following network components are supported: Cisco IOS, Cisco Nexus, Cisco ASA, 3175Cisco PIX, F5 BIG-IP, CheckPoint Firewall1, Juniper NetScreen, HP Procurve, Nortel, Brocade 4100/4900, 3176EMC DS 4700, EMC DS 24, Allied Telesyn. Blue Coat SG600, Cisco Wireless Lan Controller 5500, 3177Brocade ICX6610-24-HPOE, Cisco UC Telefonzeugs, FOUNDRY-SN-AGENT-MIB, FRITZ!BOX 7390, FRITZ!DECT 200, 3178Juniper IVE, Pulse-Gateway MAG4610, Cisco IronPort AsyncOS, Foundry, etc. A complete list can be 3179found in the plugin [documentation](https://labs.consol.de/nagios/check_nwc_health/index.html). 3180 3181Custom variables passed as [command parameters](03-monitoring-basics.md#command-passing-parameters): 3182 3183Name | Description 3184--------------------------------|--------------------------------------------------------- 3185nwc_health_hostname | **Optional.** The host's address. Defaults to "$address$" if the host's `address` attribute is set, "$address6$" otherwise. 3186nwc_health_mode | **Optional.** The plugin mode. A list of all available modes can be found in the [plugin documentation](https://labs.consol.de/nagios/check_nwc_health/index.html). 3187nwc_health_timeout | **Optional.** Seconds before plugin times out (default: 15) 3188nwc_health_blacklist | **Optional.** Blacklist some (missing/failed) components. 3189nwc_health_port | **Optional.** The SNMP port to use (default: 161). 3190nwc_health_domain | **Optional.** The transport domain to use (default: udp/ipv4, other possible values: udp6, udp/ipv6, tcp, tcp4, tcp/ipv4, tcp6, tcp/ipv6). 3191nwc_health_protocol | **Optional.** The SNMP protocol to use (default: 2c, other possibilities: 1,3). 3192nwc_health_community | **Optional.** SNMP community of the server (SNMP v1/2 only). 3193nwc_health_username | **Optional.** The securityName for the USM security model (SNMPv3 only). 3194nwc_health_authpassword | **Optional.** The authentication password for SNMPv3. 3195nwc_health_authprotocol | **Optional.** The authentication protocol for SNMPv3 (md5\|sha). 3196nwc_health_privpassword | **Optional.** The password for authPriv security level. 3197nwc_health_privprotocol | **Optional.** The private protocol for SNMPv3 (des\|aes\|aes128\|3des\|3desde). 3198nwc_health_contextengineid | **Optional.** The context engine id for SNMPv3 (10 to 64 hex characters). 3199nwc_health_contextname | **Optional.** The context name for SNMPv3 (empty represents the default context). 3200nwc_health_community2 | **Optional.** SNMP community which can be used to switch the context during runtime. 3201nwc_health_name | **Optional.** The name of an interface (ifDescr). 3202nwc_health_drecksptkdb | **Optional.** This parameter must be used instead of --name, because Devel::ptkdb is stealing the latter from the command line. 3203nwc_health_alias | **Optional.** The alias name of a 64bit-interface (ifAlias) 3204nwc_health_regexp | **Optional.** A flag indicating that --name is a regular expression 3205nwc_health_ifspeedin | **Optional.** Override the ifspeed oid of an interface (only inbound) 3206nwc_health_ifspeedout | **Optional.** Override the ifspeed oid of an interface (only outbound) 3207nwc_health_ifspeed | **Optional.** Override the ifspeed oid of an interface 3208nwc_health_units | **Optional.** One of %, B, KB, MB, GB, Bit, KBi, MBi, GBi. (used for e.g. mode interface-usage) 3209nwc_health_name2 | **Optional.** The secondary name of a component. 3210nwc_health_name3 | **Optional.** The tertiary name of a component. 3211nwc_health_role | **Optional.** The role of this device in a hsrp group (active/standby/listen). 3212nwc_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) 3213nwc_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. 3214nwc_health_warning | **Optional.** The warning threshold 3215nwc_health_critical | **Optional.** The critical threshold 3216nwc_health_warningx | **Optional.** The extended warning thresholds 3217nwc_health_criticalx | **Optional.** The extended critical thresholds 3218nwc_health_mitigation | **Optional.** The parameter allows you to change a critical error to a warning (1) or ok (0). 3219nwc_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. 3220nwc_health_morphperfdata | **Optional.** The parameter allows you to change performance data labels. It's a perl regexp and a substitution. --morphperfdata '(.*)ISATAP(.*)'='$1patasi$2' 3221nwc_health_negate | **Optional.** The parameter allows you to map exit levels, such as warning=critical. 3222nwc_health_mymodules-dyn-dir | **Optional.** A directory where own extensions can be found. 3223nwc_health_servertype | **Optional.** The type of the network device: cisco (default). Use it if auto-detection is not possible. 3224nwc_health_statefilesdir | **Optional.** An alternate directory where the plugin can save files. 3225nwc_health_oids | **Optional.** A list of oids which are downloaded and written to a cache file. Use it together with --mode oidcache. 3226nwc_health_offline | **Optional.** The maximum number of seconds since the last update of cache file before it is considered too old. 3227nwc_health_multiline | **Optional.** Multiline output 3228 3229#### printer_health <a id="plugin-contrib-command-printer_health"></a> 3230 3231The [check_printer_health](https://labs.consol.de/nagios/check_printer_health/index.html) plugin 3232uses SNMP to monitor printer. The plugin is able to generate supply statistics and check hardware. 3233A complete list can be found in the plugin [documentation](https://labs.consol.de/nagios/check_printer_health/index.html). 3234 3235Custom variables passed as [command parameters](03-monitoring-basics.md#command-passing-parameters): 3236 3237Name | Description 3238--------------------------------|--------------------------------------------------------- 3239printer_health_hostname | **Required.** The host's address. Defaults to "$address$" if the host's `address` attribute is set, "$address6$" otherwise. 3240printer_health_mode | **Required.** The plugin mode. A list of all available modes can be found in the [plugin documentation](https://labs.consol.de/nagios/check_printer_health/index.html). 3241printer_health_timeout | **Optional.** Seconds before plugin times out (default: 15) 3242printer_health_blacklist | **Optional.** Blacklist some (missing/failed) components. 3243printer_health_port | **Optional.** The SNMP port to use (default: 161). 3244printer_health_domain | **Optional.** The transport domain to use (default: udp/ipv4, other possible values: udp6, udp/ipv6, tcp, tcp4, tcp/ipv4, tcp6, tcp/ipv6). 3245printer_health_protocol | **Optional.** The SNMP protocol to use (default: 2c, other possibilities: 1,3). 3246printer_health_community | **Optional.** SNMP community of the server (SNMP v1/2 only). 3247printer_health_username | **Optional.** The securityName for the USM security model (SNMPv3 only). 3248printer_health_authpassword | **Optional.** The authentication password for SNMPv3. 3249printer_health_authprotocol | **Optional.** The authentication protocol for SNMPv3 (md5\|sha). 3250printer_health_privpassword | **Optional.** The password for authPriv security level. 3251printer_health_privprotocol | **Optional.** The private protocol for SNMPv3 (des\|aes\|aes128\|3des\|3desde). 3252printer_health_contextengineid | **Optional.** The context engine id for SNMPv3 (10 to 64 hex characters). 3253printer_health_contextname | **Optional.** The context name for SNMPv3 (empty represents the default context). 3254printer_health_community2 | **Optional.** SNMP community which can be used to switch the context during runtime. 3255printer_health_name | **Optional.** The name of an interface (ifDescr). 3256printer_health_regexp | **Optional.** A flag indicating that --name is a regular expression 3257printer_health_ifspeedin | **Optional.** Override the ifspeed oid of an interface (only inbound) 3258printer_health_ifspeedout | **Optional.** Override the ifspeed oid of an interface (only outbound) 3259printer_health_ifspeed | **Optional.** Override the ifspeed oid of an interface 3260printer_health_units | **Optional.** One of %, B, KB, MB, GB, Bit, KBi, MBi, GBi. (used for e.g. mode interface-usage) 3261printer_health_name2 | **Optional.** The secondary name of a component. 3262printer_health_name3 | **Optional.** The teritary name of a component. 3263printer_health_role | **Optional.** The role of this device in a hsrp group (active/standby/listen). 3264printer_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) 3265printer_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. 3266printer_health_warning | **Optional.** The warning threshold 3267printer_health_critical | **Optional.** The critical threshold 3268printer_health_warningx | **Optional.** The extended warning thresholds 3269printer_health_criticalx | **Optional.** The extended critical thresholds 3270printer_health_mitigation | **Optional.** The parameter allows you to change a critical error to a warning (1) or ok (0). 3271printer_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. 3272printer_health_morphperfdata | **Optional.** The parameter allows you to change performance data labels. It's a perl regexp and a substitution. --morphperfdata '(.*)ISATAP(.*)'='$1patasi$2' 3273printer_health_negate | **Optional.** The parameter allows you to map exit levels, such as warning=critical. 3274printer_health_mymodules-dyn-dir | **Optional.** A directory where own extensions can be found. 3275printer_health_servertype | **Optional.** The type of the network device: cisco (default). Use it if auto-detection is not possible. 3276printer_health_statefilesdir | **Optional.** An alternate directory where the plugin can save files. 3277printer_health_oids | **Optional.** A list of oids which are downloaded and written to a cache file. Use it together with --mode oidcache. 3278printer_health_offline | **Optional.** The maximum number of seconds since the last update of cache file before it is considered too old. 3279printer_health_multiline | **Optional.** Multiline output 3280 3281#### Thola <a id="plugin-contrib-command-thola"></a> 3282 3283The [Thola](https://thola.io) plugin 3284is a tool for monitoring network devices, that mainly uses SNMP. 3285 3286To run these commands you need a server that is running the Thola API. 3287If you don't know how to do this, you can have a look at the plugin's 3288[documentation](https://docs.thola.io). Also, you have to 3289put the Thola-client binary into the `PluginContribDir`. 3290 3291##### thola-cpu-load <a id="plugin-contrib-command-thola-cpu-load"></a> 3292 3293Checks the CPU load of a network device. 3294 3295Custom variables passed as [command parameters](03-monitoring-basics.md#command-passing-parameters): 3296 3297Name | Description 3298-------------------------------|-------------------------------------------------------- 3299thola_api_address | **Required.** Address of the Thola API to connect to 3300thola_device_address | **Required.** The host's address. Defaults to "$address$" if the host's address attribute is set, “$address6$” otherwise. 3301thola_device_snmp_community | **Optional.** SNMP community of the device 3302thola_device_snmp_protocol | **Optional.** SNMP version to use 3303thola_cpu_load_critical | **Optional.** Critical threshold for the CPU load in % 3304thola_cpu_load_warning | **Optional.** Warning threshold for the CPU load in % 3305 3306##### thola-interface-metrics <a id="plugin-contrib-command-thola-interface-metrics"></a> 3307 3308Checks the interface metrics of a network device. 3309 3310Custom variables passed as [command parameters](03-monitoring-basics.md#command-passing-parameters): 3311 3312Name | Description 3313--------------------------------|----------------------------------------------------- 3314thola_api_address | **Required.** Address of the Thola API to connect to 3315thola_device_address | **Required.** The host's address. Defaults to "$address$" if the host's address attribute is set, “$address6$” otherwise 3316thola_device_snmp_community | **Optional.** SNMP community of the device 3317 3318##### thola-hardware-health <a id="plugin-contrib-command-thola-hardware-health"></a> 3319 3320Checks the hardware health of a network device. 3321 3322Custom variables passed as [command parameters](03-monitoring-basics.md#command-passing-parameters): 3323 3324Name | Description 3325------------------------------|----------------------------------------------------- 3326thola_api_address | **Required.** Address of the Thola API to connect to 3327thola_device_address | **Required.** The host's address. Defaults to "$address$" if the host's address attribute is set, “$address6$” otherwise 3328thola_device_snmp_community | **Optional.** SNMP community of the device 3329 3330##### thola-identify <a id="plugin-contrib-command-thola-identify"></a> 3331 3332Checks if a device can be identified by the given properties. 3333 3334Custom variables passed as [command parameters](03-monitoring-basics.md#command-passing-parameters): 3335 3336Name | Description 3337-----------------------------------|-------------------------------------------------------------------------------- 3338thola_api_address | **Required.** Address of the Thola API to connect to 3339thola_device_address | **Required.** The host's address. Defaults to "$address$" if the host's address attribute is set, “$address6$” otherwise 3340thola_device_snmp_community | **Optional.** SNMP community of the device 3341thola_identify_model | **Optional.** Model that is compared to the actual model of the device 3342thola_identify_os_version | **Optional.** OS-version that is compared to the actual OS-version of the device 3343thola_identify_vendor | **Optional.** Vendor that is compared to the actual vendor of the device 3344thola_identify_serial_number | **Optional.** Serial number that is compared to the actual serial number of the device 3345thola_identify_discover_retries | **Optional.** The number of discover retries before aborting 3346thola_identify_discover_timeouts | **Optional.** The number of discover timeouts before aborting 3347 3348> **Note**: 3349> 3350> One of the variables `thola_identify_model`, `thola_identify_os_version`, 3351> `thola_identify_vendor` or `thola_identify_serial_number` must be set 3352 3353##### thola-memory-usage <a id="plugin-contrib-command-thola-memory-usage"></a> 3354 3355Checks the memory usage of a device. 3356 3357Custom variables passed as [command parameters](03-monitoring-basics.md#command-passing-parameters): 3358 3359Name | Description 3360-------------------------------|----------------------------------------------------- 3361thola_api_address | **Required.** Address of the Thola API to connect to 3362thola_device_address | **Required.** The host's address. Defaults to "$address$" if the host's address attribute is set, “$address6$” otherwise 3363thola_device_snmp_community | **Optional.** SNMP community of the device 3364thola_memory_usage_critical | **Optional.** Critical threshold for the memory usage in % 3365thola_memory_usage_warning | **Optional.** Warning threshold for the memory usage in % 3366 3367##### thola-sbc <a id="plugin-contrib-command-thola-sbc"></a> 3368 3369Checks special metrics from sbc network devices. 3370 3371Custom variables passed as [command parameters](03-monitoring-basics.md#command-passing-parameters): 3372 3373Name | Description 3374-----------------------------------------|----------------------------------------------------------- 3375thola_api_address | **Required.** Address of the Thola API to connect to 3376thola_device_address | **Required.** The host's address. Defaults to "$address$" if the host's address attribute is set, “$address6$” otherwise 3377thola_device_snmp_community | **Optional.** SNMP community of the device 3378thola_sbc_system_health_score_critical | **Optional.** Critical threshold for the health score in % 3379thola_sbc_system_health_score_warning | **Optional.** Warning threshold for the health score in % 3380 3381##### thola-thola-server <a id="plugin-contrib-command-thola-thola-server"></a> 3382 3383Checks if a Thola API is running on a given server. 3384 3385Custom variables passed as [command parameters](03-monitoring-basics.md#command-passing-parameters): 3386 3387Name | Description 3388--------------------|----------------------------------------------------- 3389thola_api_address | **Required.** Address of the Thola API to connect to 3390 3391##### thola-ups <a id="plugin-contrib-command-thola-ups"></a> 3392 3393Checks whether a UPS device has its main voltage applied. 3394 3395Custom variables passed as [command parameters](03-monitoring-basics.md#command-passing-parameters): 3396 3397Name | Description 3398--------------------------------------------|----------------------------------------------------------------- 3399thola_api_address | **Required.** Address of the Thola API to connect to 3400thola_device_address | **Required.** The host's address. Defaults to "$address$" if the host's address attribute is set, “$address6$” otherwise 3401thola_device_snmp_community | **Optional.** SNMP community of the device 3402thola_ups_batt_current_critical_max | **Optional.** High critical threshold for the battery current in Volt 3403thola_ups_batt_current_critical_min | **Optional.** Low critical threshold for the battery current in Volt 3404thola_ups_batt_current_warning_max | **Optional.** High warning threshold for the battery current in Volt 3405thola_ups_batt_current_warning_min | **Optional.** Low warning threshold for the battery current in Volt 3406thola_ups_batt_temperature_critical_max | **Optional.** High critical threshold for the battery temperature in degree celsius 3407thola_ups_batt_temperature_critical_min | **Optional.** Low critical threshold for the battery temperature in degree celsius 3408thola_ups_batt_temperature_warning_max | **Optional.** High warning threshold for the battery temperature in degree celsius 3409thola_ups_batt_temperature_warning_min | **Optional.** Low warning threshold for the battery temperature in degree celsius 3410thola_ups_current_load_critical_max | **Optional.** High critical threshold for the current load in percent 3411thola_ups_current_load_critical_min | **Optional.** Low critical threshold for the current load in percent 3412thola_ups_current_load_warning_max | **Optional.** High warning threshold for the current load in percent 3413thola_ups_current_load_warning_min | **Optional.** Low warning threshold for the current load in percent 3414thola_ups_rectifier_current_critical_max | **Optional.** High critical threshold for the current rectifier in Volt 3415thola_ups_rectifier_current_critical_min | **Optional.** Low critical threshold for the current rectifier in Volt 3416thola_ups_rectifier_current_warning_max | **Optional.** High warning threshold for the current rectifier in Volt 3417thola_ups_rectifier_current_warning_min | **Optional.** Low warning threshold for the current rectifier in Volt 3418thola_ups_system_voltage_critical_max | **Optional.** High critical threshold for the system voltage in Volt 3419thola_ups_system_voltage_critical_min | **Optional.** Low critical threshold for the system voltage in Volt 3420thola_ups_system_voltage_warning_max | **Optional.** High warning threshold for the system voltage in Volt 3421thola_ups_system_voltage_warning_min | **Optional.** Low warning threshold for the system voltage in Volt 3422 3423### Network Services <a id="plugin-contrib-network-services"></a> 3424 3425This category contains plugins which receive details about network services 3426 3427#### lsyncd <a id="plugin-contrib-command-lsyncd"></a> 3428 3429The [check_lsyncd](https://github.com/ohitz/check_lsyncd) plugin, 3430uses the `lsyncd` status file to monitor [lsyncd](https://axkibe.github.io/lsyncd/). 3431 3432Custom variables passed as [command parameters](03-monitoring-basics.md#command-passing-parameters): 3433 3434Name | Description 3435------------------------|--------------------------------------------------------------------------- 3436lsyncd_statfile | **Optional.** Set status file path (default: /var/run/lsyncd.status). 3437lsyncd_warning | **Optional.** Warning if more than N delays (default: 10). 3438lsyncd_critical | **Optional.** Critical if more then N delays (default: 100). 3439 3440#### fail2ban <a id="plugin-contrib-command-fail2ban"></a> 3441 3442The [check_fail2ban](https://github.com/fail2ban/fail2ban/tree/master/files/nagios) plugin 3443uses the `fail2ban-client` binary to monitor [fail2ban](https://www.fail2ban.org) jails. 3444 3445The plugin requires `sudo` permissions. 3446You can add a sudoers file to allow your monitoring user to use the plugin, i.e. edit /etc/sudoers.d/icinga and add: 3447``` 3448icinga ALL=(root) NOPASSWD:/usr/lib/nagios/plugins/check_fail2ban 3449``` 3450 3451and set the correct permissions: 3452```bash 3453chown -c root: /etc/sudoers.d/icinga 3454chmod -c 0440 /etc/sudoers.d/icinga 3455``` 3456 3457Custom variables passed as [command parameters](03-monitoring-basics.md#command-passing-parameters): 3458 3459Name | Description 3460------------------------|--------------------------------------------------------------------------- 3461fail2ban_display | **Optional.** To modify the output display, default is 'CHECK FAIL2BAN ACTIVITY' 3462fail2ban_path | **Optional.** Specify the path to the tw_cli binary, default value is /usr/bin/fail2ban-client 3463fail2ban_warning | **Optional.** Specify a warning threshold, default is 1 3464fail2ban_critical | **Optional.** Specify a critical threshold, default is 2 3465fail2ban_socket | **Optional.** Specify a socket path, default is unset 3466fail2ban_perfdata | **Optional.** If set to true, activate the perfdata output, default value for the plugin is set to true 3467fail2ban_jail | **Optional.** Specify the name of the specific jail to monitor; omitted by default, i.e. all jails are being monitored. 3468 3469### Operating System <a id="plugin-contrib-operating-system"></a> 3470 3471This category contains plugins which receive details about your operating system 3472or the guest system. 3473 3474#### mem <a id="plugin-contrib-command-mem"></a> 3475 3476The [check_mem.pl](https://github.com/justintime/nagios-plugins) plugin checks the 3477memory usage on linux and unix hosts. It is able to count cache memory as free when 3478compared to thresholds. More details can be found on [this blog entry](http://sysadminsjourney.com/content/2009/06/04/new-and-improved-checkmempl-nagios-plugin). 3479 3480Custom variables passed as [command parameters](03-monitoring-basics.md#command-passing-parameters): 3481 3482Name | Description 3483-------------|----------------------------------------------------------------------------------------------------------------------- 3484mem_used | **Optional.** Tell the plugin to check for used memory in opposite of **mem_free**. Must specify one of these as true. 3485mem_free | **Optional.** Tell the plugin to check for free memory in opposite of **mem_used**. Must specify one of these as true. 3486mem_cache | **Optional.** If set to true, plugin will count cache as free memory. Defaults to false. 3487mem_warning | **Required.** Specify the warning threshold as number interpreted as percent. 3488mem_critical | **Required.** Specify the critical threshold as number interpreted as percent. 3489 3490#### sar-perf <a id="plugin-contrib-command-sar-perf"></a> 3491 3492The [check_sar_perf.py](https://github.com/dnsmichi/check-sar-perf) 3493plugin collects performance metrics from Linux hosts using the `sar` binary available in the `sysstat` package. 3494 3495Custom variables passed as [command parameters](03-monitoring-basics.md#command-passing-parameters): 3496 3497Name | Description 3498-----------------|----------------------------------------------------------------------------------------------------------------------- 3499sar_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. 3500sar_perf_disk | **Optional.** Disk name for the 'disk' profile. 3501 3502 3503#### running_kernel <a id="plugin-contrib-command-running_kernel"></a> 3504 3505The [check_running_kernel](https://packages.debian.org/stretch/nagios-plugins-contrib) plugin 3506is provided by the `nagios-plugin-contrib` package on Debian/Ubuntu. 3507 3508Custom variables: 3509 3510Name | Description 3511---------------------------|------------- 3512running\_kernel\_use\_sudo | Whether to run the plugin with `sudo`. Defaults to false except on Ubuntu where it defaults to true. 3513 3514#### iostats <a id="plugin-contrib-command-iostats"></a> 3515 3516The [check_iostats](https://github.com/dnsmichi/icinga-plugins/blob/master/scripts/check_iostats) plugin 3517uses the `iostat` binary to monitor I/O on a Linux host. The default thresholds are rather high 3518so you can use a grapher for baselining before setting your own. 3519 3520Custom variables passed as [command parameters](03-monitoring-basics.md#command-passing-parameters): 3521 3522Name | Description 3523---------------|----------------------------------------------------------------------------------------------------------------------- 3524iostats\_disk | **Required.** The device to monitor without path. e.g. sda or vda. (default: sda). 3525iostats\_warning\_tps | **Required.** Warning threshold for tps (default: 3000). 3526iostats\_warning\_read | **Required.** Warning threshold for KB/s reads (default: 50000). 3527iostats\_warning\_write | **Required.** Warning threshold for KB/s writes (default: 10000). 3528iostats\_warning\_wait | **Required.** Warning threshold for % iowait (default: 50). 3529iostats\_critical\_tps | **Required.** Critical threshold for tps (default: 5000). 3530iostats\_critical\_read | **Required.** Critical threshold for KB/s reads (default: 80000). 3531iostats\_critical\_write | **Required.** Critical threshold for KB/s writes (default: 25000). 3532iostats\_critical\_wait | **Required.** Critical threshold for % iowait (default: 80). 3533 3534#### iostat <a id="plugin-contrib-command-iostat"></a> 3535 3536The [check_iostat](https://github.com/dnsmichi/icinga-plugins/blob/master/scripts/check_iostat) plugin 3537uses the `iostat` binary to monitor disk I/O on a Linux host. The default thresholds are rather high 3538so you can use a grapher for baselining before setting your own. 3539 3540Custom variables passed as [command parameters](03-monitoring-basics.md#command-passing-parameters): 3541 3542Name | Description 3543---------------|----------------------------------------------------------------------------------------------------------------------- 3544iostat\_disk | **Required.** The device to monitor without path. e.g. sda or vda. (default: sda). 3545iostat\_wtps | **Required.** Warning threshold for tps (default: 100). 3546iostat\_wread | **Required.** Warning threshold for KB/s reads (default: 100). 3547iostat\_wwrite | **Required.** Warning threshold for KB/s writes (default: 100). 3548iostat\_ctps | **Required.** Critical threshold for tps (default: 200). 3549iostat\_cread | **Required.** Critical threshold for KB/s reads (default: 200). 3550iostat\_cwrite | **Required.** Critical threshold for KB/s writes (default: 200). 3551 3552#### systemd <a id="plugin-contrib-command-systemd"></a> 3553 3554The [check_systemd.py](https://github.com/Josef-Friedrich/check_systemd) plugin 3555will report a degraded system to your monitoring solution. It requires only the [nagiosplugin](https://nagiosplugin.readthedocs.io/en/stable) library. 3556 3557Custom variables passed as [command parameters](03-monitoring-basics.md#command-passing-parameters): 3558 3559Name | Description 3560--------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------- 3561systemd\_unit | **Optional.** Name of the systemd unit that is being tested. 3562systemd\_exclude\_unit | **Optional.** Exclude a systemd unit from the checks. This option can be applied multiple times. Also supports regular expressions. 3563systemd\_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`) 3564systemd\_warning | **Optional.** Startup time in seconds to result in a warning status. (Default: `60s`) 3565systemd\_critical | **Optional.** Startup time in seconds to result in a critical status. (Default: `120s`) 3566systemd\_dead\_timers | **Optional.** Detect dead / inactive timers. (Default: `false`) 3567systemd\_dead\_timers\_warning | **Optional.** Time ago in seconds for dead / inactive timers to trigger a warning state (by default 6 days). 3568systemd\_dead\_timers\_critical | **Optional.** Time ago in seconds for dead / inactive timers to trigger a critical state (by default 7 days). 3569systemd\_verbose\_level | **Optional.** Increase verbosity level (Accepted values: `1`, `2` or `3`). (Defaults to none) 3570 3571#### yum <a id="plugin-contrib-command-yum"></a> 3572 3573The [check_yum](https://github.com/calestyo/check_yum) plugin checks the YUM package 3574management system for package updates. 3575The plugin requires the `yum-plugin-security` package to differentiate between security and normal updates. 3576 3577Custom variables passed as [command parameters](03-monitoring-basics.md#command-passing-parameters): 3578 3579Name | Description 3580------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- 3581yum_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. 3582yum_warn_on_any_update | **Optional.** Set to true to warn if there are any (non-security) package updates available. Defaults to false. 3583yum_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. 3584yum_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. 3585yum_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. 3586yum_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. 3587yum_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. 3588yum_installroot | **Optional.** Specifies another installation root directory (for example a chroot). 3589yum_timeout | **Optional.** Set a timeout in seconds after which the plugin will exit (defaults to 55 seconds). 3590 3591### Storage <a id="plugins-contrib-storage"></a> 3592 3593This category includes all plugins for various storage and object storage technologies. 3594 3595#### glusterfs <a id="plugins-contrib-command-glusterfs"></a> 3596 3597The [glusterfs](https://www.unixadm.org/software/nagios-stuff/checks/check_glusterfs) plugin 3598is used to check the GlusterFS storage health on the server. 3599The plugin requires `sudo` permissions. 3600 3601Custom variables passed as [command parameters](03-monitoring-basics.md#command-passing-parameters): 3602 3603Name | Description 3604---------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ 3605glusterfs_perfdata | **Optional.** Print perfdata of all or the specified volume. 3606glusterfs_warnonfailedheal | **Optional.** Warn if the *heal-failed* log contains entries. The log can be cleared by restarting glusterd. 3607glusterfs_volume | **Optional.** Only check the specified *VOLUME*. If --volume is not set, all volumes are checked. 3608glusterfs_disk_warning | **Optional.** Warn if disk usage is above *DISKWARN*. Defaults to 90 (percent). 3609glusterfs_disk_critical | **Optional.** Return a critical error if disk usage is above *DISKCRIT*. Defaults to 95 (percent). 3610glusterfs_inode_warning | **Optional.** Warn if inode usage is above *DISKWARN*. Defaults to 90 (percent). 3611glusterfs_inode_critical | **Optional.** Return a critical error if inode usage is above *DISKCRIT*. Defaults to 95 (percent). 3612 3613#### ceph <a id="plugins-contrib-command-ceph"></a> 3614 3615The [ceph plugin](https://github.com/ceph/ceph-nagios-plugins) 3616is used to check the Ceph storage health on the server. 3617 3618Custom variables passed as [command parameters](03-monitoring-basics.md#command-passing-parameters): 3619 3620Name | Description 3621-----------------|--------------------------------------------------------- 3622ceph_exec_dir | **Optional.** Ceph executable. Default /usr/bin/ceph. 3623ceph_conf_file | **Optional.** Alternative ceph conf file. 3624ceph_mon_address | **Optional.** Ceph monitor address[:port]. 3625ceph_client_id | **Optional.** Ceph client id. 3626ceph_client_name | **Optional.** Ceph client name. 3627ceph_client_key | **Optional.** Ceph client keyring file. 3628ceph_whitelist | **Optional.** Whitelist regexp for ceph health warnings. 3629ceph_details | **Optional.** Run 'ceph health detail'. 3630 3631#### btrfs <a id="plugins-contrib-command-btrfs"></a> 3632 3633The [btrfs plugin](https://github.com/knorrie/python-btrfs/) 3634is used to check the btrfs storage health on the server. 3635 3636The plugin requires `sudo` permissions. 3637You can add a sudoers file to allow your monitoring user to use the plugin, i.e. edit /etc/sudoers.d/icinga and add: 3638``` 3639icinga ALL=(root) NOPASSWD:/usr/lib/nagios/plugins/check_btrfs 3640``` 3641 3642and set the correct permissions: 3643```bash 3644chown -c root: /etc/sudoers.d/icinga 3645chmod -c 0440 /etc/sudoers.d/icinga 3646``` 3647 3648[monitoring-plugins-btrfs](https://packages.debian.org/monitoring-plugins-btrfs) provide the necessary binary on debian/ubuntu. 3649 3650Custom variables passed as [command parameters](03-monitoring-basics.md#command-passing-parameters): 3651 3652Name | Description 3653-----------------|--------------------------------------------------------- 3654btrfs_awg | **Optional.** Exit with WARNING status if less than the specified amount of disk space (in GiB) is unallocated 3655btrfs_acg | **Optional.** Exit with CRITICAL status if less than the specified amount of disk space (in GiB) is unallocated 3656btrfs_awp | **Optional.** Exit with WARNING status if more than the specified percent of disk space is allocated 3657btrfs_acp | **Optional.** Exit with CRITICAL status if more than the specified percent of disk space is allocated 3658btrfs_mountpoint | **Required.** Path to the BTRFS mountpoint 3659 3660### Virtualization <a id="plugin-contrib-virtualization"></a> 3661 3662This category includes all plugins for various virtualization technologies. 3663 3664#### esxi_hardware <a id="plugin-contrib-command-esxi-hardware"></a> 3665 3666The [check_esxi_hardware.py](https://www.claudiokuenzler.com/monitoring-plugins/check_esxi_hardware.php) plugin 3667uses the [pywbem](https://pywbem.github.io/pywbem/) Python library to monitor the hardware of ESXi servers 3668through the [VMWare API](https://www.vmware.com/support/pubs/sdk_pubs.html) and CIM service. 3669 3670Custom variables passed as [command parameters](03-monitoring-basics.md#command-passing-parameters): 3671 3672Name | Description 3673------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ 3674esxi_hardware_host | **Required.** Specifies the host to monitor. Defaults to "$address$". 3675esxi_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. 3676esxi_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. 3677esxi_hardware_port | **Optional.** Specifies the CIM port to connect to. Defaults to 5989. 3678esxi_hardware_sslproto | **Optional.** Specifies the SSL/TLS protocol to use. Defaults to local openssl config. 3679esxi_hardware_vendor | **Optional.** Defines the vendor of the server: "auto", "dell", "hp", "ibm", "intel", "unknown" (default). 3680esxi_hardware_html | **Optional.** Add web-links to hardware manuals for Dell servers (use your country extension). Only useful with **esxi_hardware_vendor** = dell. 3681esxi_hardware_ignore | **Optional.** Comma separated list of CIM elements to ignore. 3682esxi_hardware_regex | **Optional.** Allow regular expression lookups of elements in ignore list. Defaults to false. 3683esxi_hardware_perfdata | **Optional.** Add performcedata for graphers like PNP4Nagios to the output. Defaults to false. 3684esxi_hardware_nopower | **Optional.** Do not collect power performance data, when **esxi_hardware_perfdata** is set to true. Defaults to false. 3685esxi_hardware_novolts | **Optional.** Do not collect voltage performance data, when **esxi_hardware_perfdata** is set to true. Defaults to false. 3686esxi_hardware_nocurrent | **Optional.** Do not collect current performance data, when **esxi_hardware_perfdata** is set to true. Defaults to false. 3687esxi_hardware_notemp | **Optional.** Do not collect temperature performance data, when **esxi_hardware_perfdata** is set to true. Defaults to false. 3688esxi_hardware_nofan | **Optional.** Do not collect fan performance data, when **esxi_hardware_perfdata** is set to true. Defaults to false. 3689esxi_hardware_nolcd | **Optional.** Do not collect lcd/display status data. Defaults to false. 3690 3691#### VMware <a id="plugin-contrib-vmware"></a> 3692 3693Check commands for the [check_vmware_esx](https://github.com/BaldMansMojo/check_vmware_esx) plugin. 3694 3695**vmware-esx-dc-volumes** 3696 3697Check command object for the `check_vmware_esx` plugin. Shows all datastore volumes info. 3698 3699Custom variables passed as [command parameters](03-monitoring-basics.md#command-passing-parameters): 3700 3701Name | Description 3702------------------------|-------------- 3703vmware_datacenter | **Required.** Datacenter/vCenter hostname. 3704vmware_cluster | **Optional.** ESX or ESXi clustername. 3705vmware_sslport | **Optional.** SSL port connection. Defaults to "443". 3706vmware_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". 3707vmware_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". 3708vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90". 3709vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace. 3710vmware_sessionfile | **Optional.** Session file name enhancement. 3711vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp". 3712vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false". 3713vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default. 3714vmware_password | **Optional.** The username's password. No value defined as default. 3715vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Authentication file content:** <br> username=vmuser <br> password=p@ssw0rd 3716vmware_subselect | **Optional.** Volume name to be checked the free space. 3717vmware_gigabyte | **Optional.** Output in GB instead of MB. 3718vmware_usedspace | **Optional.** Output used space instead of free. Defaults to "false". 3719vmware_alertonly | **Optional.** List only alerting volumes. Defaults to "false". 3720vmware_exclude | **Optional.** Blacklist volumes name. No value defined as default. 3721vmware_include | **Optional.** Whitelist volumes name. No value defined as default. 3722vmware_isregexp | **Optional.** Treat blacklist and whitelist expressions as regexp. 3723vmware_dc_volume_used | **Optional.** Output used space instead of free. Defaults to "true". 3724vmware_warn | **Optional.** The warning threshold for volumes. Defaults to "80%". 3725vmware_crit | **Optional.** The critical threshold for volumes. Defaults to "90%". 3726 3727 3728**vmware-esx-dc-runtime-info** 3729 3730Check command object for the `check_vmware_esx` plugin. Shows all runtime info for the datacenter/Vcenter. 3731 3732Custom variables passed as [command parameters](03-monitoring-basics.md#command-passing-parameters): 3733 3734Name | Description 3735------------------------|-------------- 3736vmware_datacenter | **Required.** Datacenter/vCenter hostname. 3737vmware_cluster | **Optional.** ESX or ESXi clustername. 3738vmware_sslport | **Optional.** SSL port connection. Defaults to "443". 3739vmware_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". 3740vmware_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". 3741vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90". 3742vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace. 3743vmware_sessionfile | **Optional.** Session file name enhancement. 3744vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp". 3745vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false". 3746vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default. 3747vmware_password | **Optional.** The username's password. No value defined as default. 3748vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Authentication file content:** <br> username=vmuser <br> password=p@ssw0rd 3749 3750 3751**vmware-esx-dc-runtime-listvms** 3752 3753Check 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. 3754 3755Custom variables passed as [command parameters](03-monitoring-basics.md#command-passing-parameters): 3756 3757Name | Description 3758------------------------|-------------- 3759vmware_datacenter | **Required.** Datacenter/vCenter hostname. 3760vmware_cluster | **Optional.** ESX or ESXi clustername. 3761vmware_sslport | **Optional.** SSL port connection. Defaults to "443". 3762vmware_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". 3763vmware_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". 3764vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90". 3765vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace. 3766vmware_sessionfile | **Optional.** Session file name enhancement. 3767vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp". 3768vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false". 3769vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default. 3770vmware_password | **Optional.** The username's password. No value defined as default. 3771vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Authentication file content:** <br> username=vmuser <br> password=p@ssw0rd 3772vmware_alertonly | **Optional.** List only alerting VMs. Important here to avoid masses of data. 3773vmware_exclude | **Optional.** Blacklist VMs name. No value defined as default. 3774vmware_include | **Optional.** Whitelist VMs name. No value defined as default. 3775vmware_isregexp | **Optional.** Treat blacklist and whitelist expressions as regexp. 3776vmware_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. 3777 3778 3779**vmware-esx-dc-runtime-listhost** 3780 3781Check command object for the `check_vmware_esx` plugin. List of VMware ESX hosts and their power state. 3782 3783Custom variables passed as [command parameters](03-monitoring-basics.md#command-passing-parameters): 3784 3785Name | Description 3786------------------------|-------------- 3787vmware_datacenter | **Required.** Datacenter/vCenter hostname. 3788vmware_cluster | **Optional.** ESX or ESXi clustername. 3789vmware_sslport | **Optional.** SSL port connection. Defaults to "443". 3790vmware_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". 3791vmware_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". 3792vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90". 3793vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace. 3794vmware_sessionfile | **Optional.** Session file name enhancement. 3795vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp". 3796vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false". 3797vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default. 3798vmware_password | **Optional.** The username's password. No value defined as default. 3799vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Authentication file content:** <br> username=vmuser <br> password=p@ssw0rd 3800vmware_alertonly | **Optional.** List only alerting hosts. Important here to avoid masses of data. 3801vmware_exclude | **Optional.** Blacklist VMware ESX hosts. No value defined as default. 3802vmware_include | **Optional.** Whitelist VMware ESX hosts. No value defined as default. 3803vmware_isregexp | **Optional.** Treat blacklist and whitelist expressions as regexp. 3804vmware_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. 3805 3806 3807**vmware-esx-dc-runtime-listcluster** 3808 3809Check command object for the `check_vmware_esx` plugin. List of VMware clusters and their states. 3810 3811Custom variables passed as [command parameters](03-monitoring-basics.md#command-passing-parameters): 3812 3813Name | Description 3814------------------------|-------------- 3815vmware_datacenter | **Required.** Datacenter/vCenter hostname. 3816vmware_cluster | **Optional.** ESX or ESXi clustername. 3817vmware_sslport | **Optional.** SSL port connection. Defaults to "443". 3818vmware_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". 3819vmware_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". 3820vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90". 3821vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace. 3822vmware_sessionfile | **Optional.** Session file name enhancement. 3823vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp". 3824vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false". 3825vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default. 3826vmware_password | **Optional.** The username's password. No value defined as default. 3827vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Authentication file content:** <br> username=vmuser <br> password=p@ssw0rd 3828vmware_alertonly | **Optional.** List only alerting hosts. Important here to avoid masses of data. 3829vmware_exclude | **Optional.** Blacklist VMware cluster. No value defined as default. 3830vmware_include | **Optional.** Whitelist VMware cluster. No value defined as default. 3831vmware_isregexp | **Optional.** Treat blacklist and whitelist expressions as regexp. 3832vmware_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. 3833 3834 3835**vmware-esx-dc-runtime-issues** 3836 3837Check command object for the `check_vmware_esx` plugin. All issues for the host. 3838 3839Custom variables passed as [command parameters](03-monitoring-basics.md#command-passing-parameters): 3840 3841Name | Description 3842------------------------|-------------- 3843vmware_datacenter | **Required.** Datacenter/vCenter hostname. 3844vmware_cluster | **Optional.** ESX or ESXi clustername. 3845vmware_sslport | **Optional.** SSL port connection. Defaults to "443". 3846vmware_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". 3847vmware_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". 3848vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90". 3849vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace. 3850vmware_sessionfile | **Optional.** Session file name enhancement. 3851vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp". 3852vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false". 3853vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default. 3854vmware_password | **Optional.** The username's password. No value defined as default. 3855vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Authentication file content:** <br> username=vmuser <br> password=p@ssw0rd 3856vmware_exclude | **Optional.** Blacklist issues. No value defined as default. 3857vmware_include | **Optional.** Whitelist issues. No value defined as default. 3858vmware_isregexp | **Optional.** Treat blacklist and whitelist expressions as regexp. 3859vmware_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. 3860 3861 3862**vmware-esx-dc-runtime-status** 3863 3864Check command object for the `check_vmware_esx` plugin. Overall object status (gray/green/red/yellow). 3865 3866Custom variables passed as [command parameters](03-monitoring-basics.md#command-passing-parameters): 3867 3868Name | Description 3869------------------------|-------------- 3870vmware_datacenter | **Required.** Datacenter/vCenter hostname. 3871vmware_cluster | **Optional.** ESX or ESXi clustername. 3872vmware_sslport | **Optional.** SSL port connection. Defaults to "443". 3873vmware_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". 3874vmware_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". 3875vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90". 3876vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace. 3877vmware_sessionfile | **Optional.** Session file name enhancement. 3878vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp". 3879vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false". 3880vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default. 3881vmware_password | **Optional.** The username's password. No value defined as default. 3882vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Authentication file content:** <br> username=vmuser <br> password=p@ssw0rd 3883 3884 3885**vmware-esx-dc-runtime-tools** 3886 3887Check command object for the `check_vmware_esx` plugin. Vmware Tools status. 3888 3889Custom variables passed as [command parameters](03-monitoring-basics.md#command-passing-parameters): 3890 3891Name | Description 3892------------------------|-------------- 3893vmware_datacenter | **Required.** Datacenter/vCenter hostname. 3894vmware_cluster | **Optional.** ESX or ESXi clustername. 3895vmware_sslport | **Optional.** SSL port connection. Defaults to "443". 3896vmware_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". 3897vmware_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". 3898vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90". 3899vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace. 3900vmware_sessionfile | **Optional.** Session file name enhancement. 3901vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp". 3902vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false". 3903vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default. 3904vmware_password | **Optional.** The username's password. No value defined as default. 3905vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Authentication file content:** <br> username=vmuser <br> password=p@ssw0rd 3906vmware_poweredonly | **Optional.** List only VMs which are powered on. No value defined as default. 3907vmware_alertonly | **Optional.** List only alerting VMs. Important here to avoid masses of data. 3908vmware_exclude | **Optional.** Blacklist VMs. No value defined as default. 3909vmware_include | **Optional.** Whitelist VMs. No value defined as default. 3910vmware_isregexp | **Optional.** Treat blacklist and whitelist expressions as regexp. 3911vmware_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. 3912vmware_openvmtools | **Optional** Prevent CRITICAL state for installed and running Open VM Tools. 3913 3914 3915**vmware-esx-soap-host-check** 3916 3917Check command object for the `check_vmware_esx` plugin. Simple check to verify a successful connection to VMware SOAP API. 3918 3919Custom variables passed as [command parameters](03-monitoring-basics.md#command-passing-parameters): 3920 3921Name | Description 3922------------------------|-------------- 3923vmware_host | **Required.** ESX or ESXi hostname. 3924vmware_datacenter | **Optional.** Datacenter/vCenter hostname. In case the check is done through a Datacenter/vCenter host. 3925vmware_sslport | **Optional.** SSL port connection. Defaults to "443". 3926vmware_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". 3927vmware_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". 3928vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90". 3929vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace. 3930vmware_sessionfile | **Optional.** Session file name enhancement. 3931vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp". 3932vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false". 3933vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default. 3934vmware_password | **Optional.** The username's password. No value defined as default. 3935vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Authentication file content:** <br> username=vmuser <br> password=p@ssw0rd 3936 3937 3938**vmware-esx-soap-host-uptime** 3939 3940Check command object for the `check_vmware_esx` plugin. Displays uptime of the VMware host. 3941 3942Custom variables passed as [command parameters](03-monitoring-basics.md#command-passing-parameters): 3943 3944Name | Description 3945------------------------|-------------- 3946vmware_host | **Required.** ESX or ESXi hostname. 3947vmware_datacenter | **Optional.** Datacenter/vCenter hostname. In case the check is done through a Datacenter/vCenter host. 3948vmware_sslport | **Optional.** SSL port connection. Defaults to "443". 3949vmware_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". 3950vmware_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". 3951vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90". 3952vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace. 3953vmware_sessionfile | **Optional.** Session file name enhancement. 3954vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp". 3955vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false". 3956vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default. 3957vmware_password | **Optional.** The username's password. No value defined as default. 3958vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Authentication file content:** <br> username=vmuser <br> password=p@ssw0rd 3959 3960 3961**vmware-esx-soap-host-cpu** 3962 3963Check command object for the `check_vmware_esx` plugin. CPU usage in percentage. 3964 3965Custom variables passed as [command parameters](03-monitoring-basics.md#command-passing-parameters): 3966 3967Name | Description 3968------------------------|-------------- 3969vmware_host | **Required.** ESX or ESXi hostname. 3970vmware_datacenter | **Optional.** Datacenter/vCenter hostname. In case the check is done through a Datacenter/vCenter host. 3971vmware_sslport | **Optional.** SSL port connection. Defaults to "443". 3972vmware_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". 3973vmware_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". 3974vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90". 3975vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace. 3976vmware_sessionfile | **Optional.** Session file name enhancement. 3977vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp". 3978vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false". 3979vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default. 3980vmware_password | **Optional.** The username's password. No value defined as default. 3981vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Authentication file content:** <br> username=vmuser <br> password=p@ssw0rd 3982vmware_warn | **Optional.** The warning threshold in percent. Defaults to "80%". 3983vmware_crit | **Optional.** The critical threshold in percent. Defaults to "90%". 3984 3985 3986**vmware-esx-soap-host-cpu-ready** 3987 3988Check 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. 3989 3990Custom variables passed as [command parameters](03-monitoring-basics.md#command-passing-parameters): 3991 3992Name | Description 3993------------------------|-------------- 3994vmware_host | **Required.** ESX or ESXi hostname. 3995vmware_datacenter | **Optional.** Datacenter/vCenter hostname. In case the check is done through a Datacenter/vCenter host. 3996vmware_sslport | **Optional.** SSL port connection. Defaults to "443". 3997vmware_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". 3998vmware_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". 3999vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90". 4000vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace. 4001vmware_sessionfile | **Optional.** Session file name enhancement. 4002vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp". 4003vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false". 4004vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default. 4005vmware_password | **Optional.** The username's password. No value defined as default. 4006vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Authentication file content:** <br> username=vmuser <br> password=p@ssw0rd 4007 4008 4009**vmware-esx-soap-host-cpu-wait** 4010 4011Check 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. 4012 4013Custom variables passed as [command parameters](03-monitoring-basics.md#command-passing-parameters): 4014 4015Name | Description 4016------------------------|-------------- 4017vmware_host | **Required.** ESX or ESXi hostname. 4018vmware_datacenter | **Optional.** Datacenter/vCenter hostname. In case the check is done through a Datacenter/vCenter host. 4019vmware_sslport | **Optional.** SSL port connection. Defaults to "443". 4020vmware_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". 4021vmware_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". 4022vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90". 4023vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace. 4024vmware_sessionfile | **Optional.** Session file name enhancement. 4025vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp". 4026vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false". 4027vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default. 4028vmware_password | **Optional.** The username's password. No value defined as default. 4029vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Authentication file content:** <br> username=vmuser <br> password=p@ssw0rd 4030 4031 4032**vmware-esx-soap-host-cpu-usage** 4033 4034Check 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. 4035 4036Custom variables passed as [command parameters](03-monitoring-basics.md#command-passing-parameters): 4037 4038Name | Description 4039------------------------|-------------- 4040vmware_host | **Required.** ESX or ESXi hostname. 4041vmware_datacenter | **Optional.** Datacenter/vCenter hostname. In case the check is done through a Datacenter/vCenter host. 4042vmware_sslport | **Optional.** SSL port connection. Defaults to "443". 4043vmware_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". 4044vmware_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". 4045vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90". 4046vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace. 4047vmware_sessionfile | **Optional.** Session file name enhancement. 4048vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp". 4049vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false". 4050vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default. 4051vmware_password | **Optional.** The username's password. No value defined as default. 4052vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Authentication file content:** <br> username=vmuser <br> password=p@ssw0rd 4053vmware_warn | **Optional.** The warning threshold in percent. Defaults to "80%". 4054vmware_crit | **Optional.** The critical threshold in percent. Defaults to "90%". 4055 4056 4057**vmware-esx-soap-host-mem** 4058 4059Check command object for the `check_vmware_esx` plugin. All mem info(except overall and no thresholds). 4060 4061Custom variables passed as [command parameters](03-monitoring-basics.md#command-passing-parameters): 4062 4063Name | Description 4064------------------------|-------------- 4065vmware_host | **Required.** ESX or ESXi hostname. 4066vmware_datacenter | **Optional.** Datacenter/vCenter hostname. In case the check is done through a Datacenter/vCenter host. 4067vmware_sslport | **Optional.** SSL port connection. Defaults to "443". 4068vmware_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". 4069vmware_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". 4070vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90". 4071vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace. 4072vmware_sessionfile | **Optional.** Session file name enhancement. 4073vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp". 4074vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false". 4075vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default. 4076vmware_password | **Optional.** The username's password. No value defined as default. 4077vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Authentication file content:** <br> username=vmuser <br> password=p@ssw0rd 4078 4079 4080**vmware-esx-soap-host-mem-usage** 4081 4082Check command object for the `check_vmware_esx` plugin. Average mem usage in percentage. 4083 4084Custom variables passed as [command parameters](03-monitoring-basics.md#command-passing-parameters): 4085 4086Name | Description 4087------------------------|-------------- 4088vmware_host | **Required.** ESX or ESXi hostname. 4089vmware_datacenter | **Optional.** Datacenter/vCenter hostname. In case the check is done through a Datacenter/vCenter host. 4090vmware_sslport | **Optional.** SSL port connection. Defaults to "443". 4091vmware_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". 4092vmware_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". 4093vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90". 4094vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace. 4095vmware_sessionfile | **Optional.** Session file name enhancement. 4096vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp". 4097vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false". 4098vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default. 4099vmware_password | **Optional.** The username's password. No value defined as default. 4100vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Authentication file content:** <br> username=vmuser <br> password=p@ssw0rd 4101vmware_warn | **Optional.** The warning threshold in percent. Defaults to "80%". 4102vmware_crit | **Optional.** The critical threshold in percent. Defaults to "90%". 4103 4104 4105**vmware-esx-soap-host-mem-consumed** 4106 4107Check 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. 4108 4109Custom variables passed as [command parameters](03-monitoring-basics.md#command-passing-parameters): 4110 4111Name | Description 4112------------------------|-------------- 4113vmware_host | **Required.** ESX or ESXi hostname. 4114vmware_datacenter | **Optional.** Datacenter/vCenter hostname. In case the check is done through a Datacenter/vCenter host. 4115vmware_sslport | **Optional.** SSL port connection. Defaults to "443". 4116vmware_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". 4117vmware_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". 4118vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90". 4119vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace. 4120vmware_sessionfile | **Optional.** Session file name enhancement. 4121vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp". 4122vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false". 4123vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default. 4124vmware_password | **Optional.** The username's password. No value defined as default. 4125vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Authentication file content:** <br> username=vmuser <br> password=p@ssw0rd 4126vmware_warn | **Optional.** The warning threshold in percent. No value defined as default. 4127vmware_crit | **Optional.** The critical threshold in percent. No value defined as default. 4128 4129 4130**vmware-esx-soap-host-mem-swapused** 4131 4132Check 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. 4133 4134Custom variables passed as [command parameters](03-monitoring-basics.md#command-passing-parameters): 4135 4136Name | Description 4137------------------------|-------------- 4138vmware_host | **Required.** ESX or ESXi hostname. 4139vmware_datacenter | **Optional.** Datacenter/vCenter hostname. In case the check is done through a Datacenter/vCenter host. 4140vmware_sslport | **Optional.** SSL port connection. Defaults to "443". 4141vmware_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". 4142vmware_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". 4143vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90". 4144vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace. 4145vmware_sessionfile | **Optional.** Session file name enhancement. 4146vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp". 4147vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false". 4148vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default. 4149vmware_password | **Optional.** The username's password. No value defined as default. 4150vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Authentication file content:** <br> username=vmuser <br> password=p@ssw0rd 4151vmware_warn | **Optional.** The warning threshold in percent. No value defined as default. 4152vmware_crit | **Optional.** The critical threshold in percent. No value defined as default. 4153vmware_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. 4154 4155 4156**vmware-esx-soap-host-mem-overhead** 4157 4158Check command object for the `check_vmware_esx` plugin. Additional mem used by VM Server in MB. 4159 4160Custom variables passed as [command parameters](03-monitoring-basics.md#command-passing-parameters): 4161 4162Name | Description 4163------------------------|-------------- 4164vmware_host | **Required.** ESX or ESXi hostname. 4165vmware_datacenter | **Optional.** Datacenter/vCenter hostname. In case the check is done through a Datacenter/vCenter host. 4166vmware_sslport | **Optional.** SSL port connection. Defaults to "443". 4167vmware_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". 4168vmware_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". 4169vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90". 4170vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace. 4171vmware_sessionfile | **Optional.** Session file name enhancement. 4172vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp". 4173vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false". 4174vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default. 4175vmware_password | **Optional.** The username's password. No value defined as default. 4176vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Auhentication file content:** <br> username=vmuser <br> password=p@ssw0rd 4177vmware_warn | **Optional.** The warning threshold in percent. No value defined as default. 4178vmware_crit | **Optional.** The critical threshold in percent. No value defined as default. 4179 4180 4181**vmware-esx-soap-host-mem-memctl** 4182 4183Check 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. 4184 4185Custom variables passed as [command parameters](03-monitoring-basics.md#command-passing-parameters): 4186 4187Name | Description 4188------------------------|-------------- 4189vmware_host | **Required.** ESX or ESXi hostname. 4190vmware_datacenter | **Optional.** Datacenter/vCenter hostname. In case the check is done through a Datacenter/vCenter host. 4191vmware_sslport | **Optional.** SSL port connection. Defaults to "443". 4192vmware_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". 4193vmware_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". 4194vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90". 4195vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace. 4196vmware_sessionfile | **Optional.** Session file name enhancement. 4197vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp". 4198vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false". 4199vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default. 4200vmware_password | **Optional.** The username's password. No value defined as default. 4201vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Authentication file content:** <br> username=vmuser <br> password=p@ssw0rd 4202vmware_warn | **Optional.** The warning threshold in percent. No value defined as default. 4203vmware_crit | **Optional.** The critical threshold in percent. No value defined as default. 4204vmware_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. 4205 4206 4207**vmware-esx-soap-host-net** 4208 4209Check command object for the `check_vmware_esx` plugin. Shows net info. 4210 4211Custom variables passed as [command parameters](03-monitoring-basics.md#command-passing-parameters): 4212 4213Name | Description 4214------------------------|-------------- 4215vmware_host | **Required.** ESX or ESXi hostname. 4216vmware_datacenter | **Optional.** Datacenter/vCenter hostname. In case the check is done through a Datacenter/vCenter host. 4217vmware_sslport | **Optional.** SSL port connection. Defaults to "443". 4218vmware_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". 4219vmware_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". 4220vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90". 4221vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace. 4222vmware_sessionfile | **Optional.** Session file name enhancement. 4223vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp". 4224vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false". 4225vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default. 4226vmware_password | **Optional.** The username's password. No value defined as default. 4227vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Authentication file content:** <br> username=vmuser <br> password=p@ssw0rd 4228vmware_exclude | **Optional.** Blacklist NICs. No value defined as default. 4229vmware_isregexp | **Optional.** Treat blacklist expression as regexp. 4230 4231 4232**vmware-esx-soap-host-net-usage** 4233 4234Check command object for the `check_vmware_esx` plugin. Overall network usage in KBps(Kilobytes per Second). 4235 4236Custom variables passed as [command parameters](03-monitoring-basics.md#command-passing-parameters): 4237 4238Name | Description 4239------------------------|-------------- 4240vmware_host | **Required.** ESX or ESXi hostname. 4241vmware_datacenter | **Optional.** Datacenter/vCenter hostname. In case the check is done through a Datacenter/vCenter host. 4242vmware_sslport | **Optional.** SSL port connection. Defaults to "443". 4243vmware_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". 4244vmware_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". 4245vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90". 4246vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace. 4247vmware_sessionfile | **Optional.** Session file name enhancement. 4248vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp". 4249vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false". 4250vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default. 4251vmware_password | **Optional.** The username's password. No value defined as default. 4252vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Authentication file content:** <br> username=vmuser <br> password=p@ssw0rd 4253vmware_warn | **Optional.** The warning threshold in KBps(Kilobytes per Second). No value defined as default. 4254vmware_crit | **Optional.** The critical threshold in KBps(Kilobytes per Second). No value defined as default. 4255 4256 4257**vmware-esx-soap-host-net-receive** 4258 4259Check command object for the `check_vmware_esx` plugin. Data receive in KBps(Kilobytes per Second). 4260 4261Custom variables passed as [command parameters](03-monitoring-basics.md#command-passing-parameters): 4262 4263Name | Description 4264------------------------|-------------- 4265vmware_host | **Required.** ESX or ESXi hostname. 4266vmware_datacenter | **Optional.** Datacenter/vCenter hostname. In case the check is done through a Datacenter/vCenter host. 4267vmware_sslport | **Optional.** SSL port connection. Defaults to "443". 4268vmware_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". 4269vmware_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". 4270vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90". 4271vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace. 4272vmware_sessionfile | **Optional.** Session file name enhancement. 4273vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp". 4274vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false". 4275vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default. 4276vmware_password | **Optional.** The username's password. No value defined as default. 4277vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Authentication file content:** <br> username=vmuser <br> password=p@ssw0rd 4278vmware_warn | **Optional.** The warning threshold in KBps(Kilobytes per Second). No value defined as default. 4279vmware_crit | **Optional.** The critical threshold in KBps(Kilobytes per Second). No value defined as default. 4280 4281 4282**vmware-esx-soap-host-net-send** 4283 4284Check command object for the `check_vmware_esx` plugin. Data send in KBps(Kilobytes per Second). 4285 4286Custom variables passed as [command parameters](03-monitoring-basics.md#command-passing-parameters): 4287 4288Name | Description 4289------------------------|-------------- 4290vmware_host | **Required.** ESX or ESXi hostname. 4291vmware_datacenter | **Optional.** Datacenter/vCenter hostname. In case the check is done through a Datacenter/vCenter host. 4292vmware_sslport | **Optional.** SSL port connection. Defaults to "443". 4293vmware_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". 4294vmware_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". 4295vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90". 4296vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace. 4297vmware_sessionfile | **Optional.** Session file name enhancement. 4298vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp". 4299vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false". 4300vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default. 4301vmware_password | **Optional.** The username's password. No value defined as default. 4302vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Authentication file content:** <br> username=vmuser <br> password=p@ssw0rd 4303vmware_warn | **Optional.** The warning threshold in KBps(Kilobytes per Second). No value defined as default. 4304vmware_crit | **Optional.** The critical threshold in KBps(Kilobytes per Second). No value defined as default. 4305 4306 4307**vmware-esx-soap-host-net-nic** 4308 4309Check command object for the `check_vmware_esx` plugin. Check all active NICs. 4310 4311Custom variables passed as [command parameters](03-monitoring-basics.md#command-passing-parameters): 4312 4313Name | Description 4314------------------------|-------------- 4315vmware_host | **Required.** ESX or ESXi hostname. 4316vmware_datacenter | **Optional.** Datacenter/vCenter hostname. In case the check is done through a Datacenter/vCenter host. 4317vmware_sslport | **Optional.** SSL port connection. Defaults to "443". 4318vmware_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". 4319vmware_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". 4320vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90". 4321vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace. 4322vmware_sessionfile | **Optional.** Session file name enhancement. 4323vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp". 4324vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false". 4325vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default. 4326vmware_password | **Optional.** The username's password. No value defined as default. 4327vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Authentication file content:** <br> username=vmuser <br> password=p@ssw0rd 4328vmware_exclude | **Optional.** Blacklist NICs. No value defined as default. 4329vmware_isregexp | **Optional.** Treat blacklist expression as regexp. 4330 4331 4332**vmware-esx-soap-host-volumes** 4333 4334Check command object for the `check_vmware_esx` plugin. Shows all datastore volumes info. 4335 4336Custom variables passed as [command parameters](03-monitoring-basics.md#command-passing-parameters): 4337 4338Name | Description 4339------------------------|-------------- 4340vmware_host | **Required.** ESX or ESXi hostname. 4341vmware_datacenter | **Optional.** Datacenter/vCenter hostname. In case the check is done through a Datacenter/vCenter host. 4342vmware_sslport | **Optional.** SSL port connection. Defaults to "443". 4343vmware_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". 4344vmware_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". 4345vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90". 4346vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace. 4347vmware_sessionfile | **Optional.** Session file name enhancement. 4348vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp". 4349vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false". 4350vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default. 4351vmware_password | **Optional.** The username's password. No value defined as default. 4352vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Authentication file content:** <br> username=vmuser <br> password=p@ssw0rd 4353vmware_subselect | **Optional.** Volume name to be checked the free space. 4354vmware_gigabyte | **Optional.** Output in GB instead of MB. 4355vmware_usedspace | **Optional.** Output used space instead of free. Defaults to "false". 4356vmware_alertonly | **Optional.** List only alerting volumes. Defaults to "false". 4357vmware_exclude | **Optional.** Blacklist volumes name. No value defined as default. 4358vmware_include | **Optional.** Whitelist volumes name. No value defined as default. 4359vmware_isregexp | **Optional.** Treat blacklist and whitelist expressions as regexp. 4360vmware_warn | **Optional.** The warning threshold for volumes. Defaults to "80%". 4361vmware_crit | **Optional.** The critical threshold for volumes. Defaults to "90%". 4362vmware_spaceleft | **Optional.** This has to be used in conjunction with thresholds as mentioned above. 4363 4364 4365**vmware-esx-soap-host-io** 4366 4367Check 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. 4368 4369Custom variables passed as [command parameters](03-monitoring-basics.md#command-passing-parameters): 4370 4371Name | Description 4372------------------------|-------------- 4373vmware_host | **Required.** ESX or ESXi hostname. 4374vmware_datacenter | **Optional.** Datacenter/vCenter hostname. In case the check is done through a Datacenter/vCenter host. 4375vmware_sslport | **Optional.** SSL port connection. Defaults to "443". 4376vmware_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". 4377vmware_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". 4378vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90". 4379vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace. 4380vmware_sessionfile | **Optional.** Session file name enhancement. 4381vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp". 4382vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false". 4383vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default. 4384vmware_password | **Optional.** The username's password. No value defined as default. 4385vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Authentication file content:** <br> username=vmuser <br> password=p@ssw0rd 4386 4387 4388**vmware-esx-soap-host-io-aborted** 4389 4390Check command object for the `check_vmware_esx` plugin. Number of aborted SCSI commands. 4391 4392Custom variables passed as [command parameters](03-monitoring-basics.md#command-passing-parameters): 4393 4394Name | Description 4395------------------------|-------------- 4396vmware_host | **Required.** ESX or ESXi hostname. 4397vmware_datacenter | **Optional.** Datacenter/vCenter hostname. In case the check is done through a Datacenter/vCenter host. 4398vmware_sslport | **Optional.** SSL port connection. Defaults to "443". 4399vmware_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". 4400vmware_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". 4401vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90". 4402vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace. 4403vmware_sessionfile | **Optional.** Session file name enhancement. 4404vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp". 4405vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false". 4406vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default. 4407vmware_password | **Optional.** The username's password. No value defined as default. 4408vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Authentication file content:** <br> username=vmuser <br> password=p@ssw0rd 4409vmware_warn | **Optional.** The warning threshold. No value defined as default. 4410vmware_crit | **Optional.** The critical threshold. No value defined as default. 4411 4412 4413**vmware-esx-soap-host-io-resets** 4414 4415Check command object for the `check_vmware_esx` plugin. Number of SCSI bus resets. 4416 4417Custom variables passed as [command parameters](03-monitoring-basics.md#command-passing-parameters): 4418 4419Name | Description 4420------------------------|-------------- 4421vmware_host | **Required.** ESX or ESXi hostname. 4422vmware_datacenter | **Optional.** Datacenter/vCenter hostname. In case the check is done through a Datacenter/vCenter host. 4423vmware_sslport | **Optional.** SSL port connection. Defaults to "443". 4424vmware_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". 4425vmware_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". 4426vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90". 4427vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace. 4428vmware_sessionfile | **Optional.** Session file name enhancement. 4429vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp". 4430vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false". 4431vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default. 4432vmware_password | **Optional.** The username's password. No value defined as default. 4433vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Authentication file content:** <br> username=vmuser <br> password=p@ssw0rd 4434vmware_warn | **Optional.** The warning threshold. No value defined as default. 4435vmware_crit | **Optional.** The critical threshold. No value defined as default. 4436 4437 4438**vmware-esx-soap-host-io-read** 4439 4440Check command object for the `check_vmware_esx` plugin. Average number of kilobytes read from the disk each second. 4441 4442Custom variables passed as [command parameters](03-monitoring-basics.md#command-passing-parameters): 4443 4444Name | Description 4445------------------------|-------------- 4446vmware_host | **Required.** ESX or ESXi hostname. 4447vmware_datacenter | **Optional.** Datacenter/vCenter hostname. In case the check is done through a Datacenter/vCenter host. 4448vmware_sslport | **Optional.** SSL port connection. Defaults to "443". 4449vmware_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". 4450vmware_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". 4451vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90". 4452vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace. 4453vmware_sessionfile | **Optional.** Session file name enhancement. 4454vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp". 4455vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false". 4456vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default. 4457vmware_password | **Optional.** The username's password. No value defined as default. 4458vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Authentication file content:** <br> username=vmuser <br> password=p@ssw0rd 4459vmware_warn | **Optional.** The warning threshold. No value defined as default. 4460vmware_crit | **Optional.** The critical threshold. No value defined as default. 4461 4462 4463**vmware-esx-soap-host-io-read-latency** 4464 4465Check 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. 4466 4467Custom variables passed as [command parameters](03-monitoring-basics.md#command-passing-parameters): 4468 4469Name | Description 4470------------------------|-------------- 4471vmware_host | **Required.** ESX or ESXi hostname. 4472vmware_datacenter | **Optional.** Datacenter/vCenter hostname. In case the check is done through a Datacenter/vCenter host. 4473vmware_sslport | **Optional.** SSL port connection. Defaults to "443". 4474vmware_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". 4475vmware_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". 4476vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90". 4477vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace. 4478vmware_sessionfile | **Optional.** Session file name enhancement. 4479vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp". 4480vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false". 4481vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default. 4482vmware_password | **Optional.** The username's password. No value defined as default. 4483vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Authentication file content:** <br> username=vmuser <br> password=p@ssw0rd 4484vmware_warn | **Optional.** The warning threshold. No value defined as default. 4485vmware_crit | **Optional.** The critical threshold. No value defined as default. 4486 4487 4488**vmware-esx-soap-host-io-write** 4489 4490Check command object for the `check_vmware_esx` plugin. Average number of kilobytes written to disk each second. 4491 4492Custom variables passed as [command parameters](03-monitoring-basics.md#command-passing-parameters): 4493 4494Name | Description 4495------------------------|-------------- 4496vmware_host | **Required.** ESX or ESXi hostname. 4497vmware_datacenter | **Optional.** Datacenter/vCenter hostname. In case the check is done through a Datacenter/vCenter host. 4498vmware_sslport | **Optional.** SSL port connection. Defaults to "443". 4499vmware_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". 4500vmware_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". 4501vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90". 4502vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace. 4503vmware_sessionfile | **Optional.** Session file name enhancement. 4504vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp". 4505vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false". 4506vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default. 4507vmware_password | **Optional.** The username's password. No value defined as default. 4508vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Authentication file content:** <br> username=vmuser <br> password=p@ssw0rd 4509vmware_warn | **Optional.** The warning threshold. No value defined as default. 4510vmware_crit | **Optional.** The critical threshold. No value defined as default. 4511 4512 4513**vmware-esx-soap-host-io-write-latency** 4514 4515Check 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. 4516 4517Custom variables passed as [command parameters](03-monitoring-basics.md#command-passing-parameters): 4518 4519Name | Description 4520------------------------|-------------- 4521vmware_host | **Required.** ESX or ESXi hostname. 4522vmware_datacenter | **Optional.** Datacenter/vCenter hostname. In case the check is done through a Datacenter/vCenter host. 4523vmware_sslport | **Optional.** SSL port connection. Defaults to "443". 4524vmware_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". 4525vmware_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". 4526vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90". 4527vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace. 4528vmware_sessionfile | **Optional.** Session file name enhancement. 4529vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp". 4530vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false". 4531vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default. 4532vmware_password | **Optional.** The username's password. No value defined as default. 4533vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Authentication file content:** <br> username=vmuser <br> password=p@ssw0rd 4534vmware_warn | **Optional.** The warning threshold. No value defined as default. 4535vmware_crit | **Optional.** The critical threshold. No value defined as default. 4536 4537 4538**vmware-esx-soap-host-io-usage** 4539 4540Check 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. 4541 4542Custom variables passed as [command parameters](03-monitoring-basics.md#command-passing-parameters): 4543 4544Name | Description 4545------------------------|-------------- 4546vmware_host | **Required.** ESX or ESXi hostname. 4547vmware_datacenter | **Optional.** Datacenter/vCenter hostname. In case the check is done through a Datacenter/vCenter host. 4548vmware_sslport | **Optional.** SSL port connection. Defaults to "443". 4549vmware_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". 4550vmware_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". 4551vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90". 4552vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace. 4553vmware_sessionfile | **Optional.** Session file name enhancement. 4554vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp". 4555vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false". 4556vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default. 4557vmware_password | **Optional.** The username's password. No value defined as default. 4558vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Authentication file content:** <br> username=vmuser <br> password=p@ssw0rd 4559vmware_warn | **Optional.** The warning threshold. No value defined as default. 4560vmware_crit | **Optional.** The critical threshold. No value defined as default. 4561 4562 4563**vmware-esx-soap-host-io-kernel-latency** 4564 4565Check command object for the `check_vmware_esx` plugin. Average amount of time (ms) spent by VMkernel processing each SCSI command. 4566 4567Custom variables passed as [command parameters](03-monitoring-basics.md#command-passing-parameters): 4568 4569Name | Description 4570------------------------|-------------- 4571vmware_host | **Required.** ESX or ESXi hostname. 4572vmware_datacenter | **Optional.** Datacenter/vCenter hostname. In case the check is done through a Datacenter/vCenter host. 4573vmware_sslport | **Optional.** SSL port connection. Defaults to "443". 4574vmware_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". 4575vmware_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". 4576vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90". 4577vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace. 4578vmware_sessionfile | **Optional.** Session file name enhancement. 4579vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp". 4580vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false". 4581vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default. 4582vmware_password | **Optional.** The username's password. No value defined as default. 4583vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Authentication file content:** <br> username=vmuser <br> password=p@ssw0rd 4584vmware_warn | **Optional.** The warning threshold. No value defined as default. 4585vmware_crit | **Optional.** The critical threshold. No value defined as default. 4586 4587 4588**vmware-esx-soap-host-io-device-latency** 4589 4590Check command object for the `check_vmware_esx` plugin. Average amount of time (ms) to complete a SCSI command from the physical device. 4591 4592Custom variables passed as [command parameters](03-monitoring-basics.md#command-passing-parameters): 4593 4594Name | Description 4595------------------------|-------------- 4596vmware_host | **Required.** ESX or ESXi hostname. 4597vmware_datacenter | **Optional.** Datacenter/vCenter hostname. In case the check is done through a Datacenter/vCenter host. 4598vmware_sslport | **Optional.** SSL port connection. Defaults to "443". 4599vmware_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". 4600vmware_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". 4601vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90". 4602vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace. 4603vmware_sessionfile | **Optional.** Session file name enhancement. 4604vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp". 4605vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false". 4606vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default. 4607vmware_password | **Optional.** The username's password. No value defined as default. 4608vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Authentication file content:** <br> username=vmuser <br> password=p@ssw0rd 4609vmware_warn | **Optional.** The warning threshold. No value defined as default. 4610vmware_crit | **Optional.** The critical threshold. No value defined as default. 4611 4612 4613**vmware-esx-soap-host-io-queue-latency** 4614 4615Check command object for the `check_vmware_esx` plugin. Average amount of time (ms) spent in the VMkernel queue. 4616 4617Custom variables passed as [command parameters](03-monitoring-basics.md#command-passing-parameters): 4618 4619Name | Description 4620------------------------|-------------- 4621vmware_host | **Required.** ESX or ESXi hostname. 4622vmware_datacenter | **Optional.** Datacenter/vCenter hostname. In case the check is done through a Datacenter/vCenter host. 4623vmware_sslport | **Optional.** SSL port connection. Defaults to "443". 4624vmware_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". 4625vmware_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". 4626vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90". 4627vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace. 4628vmware_sessionfile | **Optional.** Session file name enhancement. 4629vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp". 4630vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false". 4631vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default. 4632vmware_password | **Optional.** The username's password. No value defined as default. 4633vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Authentication file content:** <br> username=vmuser <br> password=p@ssw0rd 4634vmware_warn | **Optional.** The warning threshold. No value defined as default. 4635vmware_crit | **Optional.** The critical threshold. No value defined as default. 4636 4637 4638**vmware-esx-soap-host-io-total-latency** 4639 4640Check 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. 4641 4642Custom variables passed as [command parameters](03-monitoring-basics.md#command-passing-parameters): 4643 4644Name | Description 4645------------------------|-------------- 4646vmware_host | **Required.** ESX or ESXi hostname. 4647vmware_datacenter | **Optional.** Datacenter/vCenter hostname. In case the check is done through a Datacenter/vCenter host. 4648vmware_sslport | **Optional.** SSL port connection. Defaults to "443". 4649vmware_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". 4650vmware_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". 4651vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90". 4652vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace. 4653vmware_sessionfile | **Optional.** Session file name enhancement. 4654vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp". 4655vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false". 4656vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default. 4657vmware_password | **Optional.** The username's password. No value defined as default. 4658vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Authentication file content:** <br> username=vmuser <br> password=p@ssw0rd 4659vmware_warn | **Optional.** The warning threshold. No value defined as default. 4660vmware_crit | **Optional.** The critical threshold. No value defined as default. 4661 4662 4663**vmware-esx-soap-host-media** 4664 4665Check 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. 4666 4667Custom variables passed as [command parameters](03-monitoring-basics.md#command-passing-parameters): 4668 4669Name | Description 4670------------------------|-------------- 4671vmware_host | **Required.** ESX or ESXi hostname. 4672vmware_datacenter | **Optional.** Datacenter/vCenter hostname. In case the check is done through a Datacenter/vCenter host. 4673vmware_sslport | **Optional.** SSL port connection. Defaults to "443". 4674vmware_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". 4675vmware_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". 4676vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90". 4677vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace. 4678vmware_sessionfile | **Optional.** Session file name enhancement. 4679vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp". 4680vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false". 4681vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default. 4682vmware_password | **Optional.** The username's password. No value defined as default. 4683vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Authentication file content:** <br> username=vmuser <br> password=p@ssw0rd 4684vmware_exclude | **Optional.** Blacklist VMs name. No value defined as default. 4685vmware_include | **Optional.** Whitelist VMs name. No value defined as default. 4686vmware_isregexp | **Optional.** Treat blacklist and whitelist expressions as regexp. 4687vmware_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. 4688 4689 4690**vmware-esx-soap-host-service** 4691 4692Check command object for the `check_vmware_esx` plugin. Shows host service info. 4693 4694Custom variables passed as [command parameters](03-monitoring-basics.md#command-passing-parameters): 4695 4696Name | Description 4697------------------------|-------------- 4698vmware_host | **Required.** ESX or ESXi hostname. 4699vmware_datacenter | **Optional.** Datacenter/vCenter hostname. In case the check is done through a Datacenter/vCenter host. 4700vmware_sslport | **Optional.** SSL port connection. Defaults to "443". 4701vmware_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". 4702vmware_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". 4703vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90". 4704vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace. 4705vmware_sessionfile | **Optional.** Session file name enhancement. 4706vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp". 4707vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false". 4708vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default. 4709vmware_password | **Optional.** The username's password. No value defined as default. 4710vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Authentication file content:** <br> username=vmuser <br> password=p@ssw0rd 4711vmware_exclude | **Optional.** Blacklist services name. No value defined as default. 4712vmware_include | **Optional.** Whitelist services name. No value defined as default. 4713vmware_isregexp | **Optional.** Treat blacklist and whitelist expressions as regexp. 4714vmware_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. 4715 4716 4717**vmware-esx-soap-host-runtime** 4718 4719Check 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. 4720 4721Custom variables passed as [command parameters](03-monitoring-basics.md#command-passing-parameters): 4722 4723Name | Description 4724------------------------|-------------- 4725vmware_host | **Required.** ESX or ESXi hostname. 4726vmware_datacenter | **Optional.** Datacenter/vCenter hostname. In case the check is done through a Datacenter/vCenter host. 4727vmware_sslport | **Optional.** SSL port connection. Defaults to "443". 4728vmware_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". 4729vmware_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". 4730vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90". 4731vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace. 4732vmware_sessionfile | **Optional.** Session file name enhancement. 4733vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp". 4734vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false". 4735vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default. 4736vmware_password | **Optional.** The username's password. No value defined as default. 4737vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Authentication file content:** <br> username=vmuser <br> password=p@ssw0rd 4738vmware_exclude | **Optional.** Blacklist VMs name. No value defined as default. 4739vmware_include | **Optional.** Whitelist VMs name. No value defined as default. 4740vmware_isregexp | **Optional.** Treat blacklist and whitelist expressions as regexp. 4741 4742 4743**vmware-esx-soap-host-runtime-con** 4744 4745Check command object for the `check_vmware_esx` plugin. Shows connection state. 4746 4747Custom variables passed as [command parameters](03-monitoring-basics.md#command-passing-parameters): 4748 4749Name | Description 4750------------------------|-------------- 4751vmware_host | **Required.** ESX or ESXi hostname. 4752vmware_datacenter | **Optional.** Datacenter/vCenter hostname. In case the check is done through a Datacenter/vCenter host. 4753vmware_sslport | **Optional.** SSL port connection. Defaults to "443". 4754vmware_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". 4755vmware_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". 4756vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90". 4757vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace. 4758vmware_sessionfile | **Optional.** Session file name enhancement. 4759vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp". 4760vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false". 4761vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default. 4762vmware_password | **Optional.** The username's password. No value defined as default. 4763vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Authentication file content:** <br> username=vmuser <br> password=p@ssw0rd 4764 4765 4766**vmware-esx-soap-host-runtime-listvms** 4767 4768Check command object for the `check_vmware_esx` plugin. List of VMware machines and their status. 4769 4770Custom variables passed as [command parameters](03-monitoring-basics.md#command-passing-parameters): 4771 4772Name | Description 4773------------------------|-------------- 4774vmware_host | **Required.** ESX or ESXi hostname. 4775vmware_datacenter | **Optional.** Datacenter/vCenter hostname. In case the check is done through a Datacenter/vCenter host. 4776vmware_sslport | **Optional.** SSL port connection. Defaults to "443". 4777vmware_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". 4778vmware_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". 4779vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90". 4780vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace. 4781vmware_sessionfile | **Optional.** Session file name enhancement. 4782vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp". 4783vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false". 4784vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default. 4785vmware_password | **Optional.** The username's password. No value defined as default. 4786vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Authentication file content:** <br> username=vmuser <br> password=p@ssw0rd 4787vmware_exclude | **Optional.** Blacklist VMs name. No value defined as default. 4788vmware_include | **Optional.** Whitelist VMs name. No value defined as default. 4789vmware_isregexp | **Optional.** Treat blacklist and whitelist expressions as regexp. 4790vmware_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. 4791 4792 4793**vmware-esx-soap-host-runtime-status** 4794 4795Check command object for the `check_vmware_esx` plugin. Overall object status (gray/green/red/yellow). 4796 4797Custom variables passed as [command parameters](03-monitoring-basics.md#command-passing-parameters): 4798 4799Name | Description 4800------------------------|-------------- 4801vmware_host | **Required.** ESX or ESXi hostname. 4802vmware_datacenter | **Optional.** Datacenter/vCenter hostname. In case the check is done through a Datacenter/vCenter host. 4803vmware_sslport | **Optional.** SSL port connection. Defaults to "443". 4804vmware_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". 4805vmware_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". 4806vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90". 4807vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace. 4808vmware_sessionfile | **Optional.** Session file name enhancement. 4809vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp". 4810vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false". 4811vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default. 4812vmware_password | **Optional.** The username's password. No value defined as default. 4813vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Authentication file content:** <br> username=vmuser <br> password=p@ssw0rd 4814 4815 4816**vmware-esx-soap-host-runtime-health** 4817 4818Check command object for the `check_vmware_esx` plugin. Checks cpu/storage/memory/sensor status. 4819 4820Custom variables passed as [command parameters](03-monitoring-basics.md#command-passing-parameters): 4821 4822Name | Description 4823------------------------|-------------- 4824vmware_host | **Required.** ESX or ESXi hostname. 4825vmware_datacenter | **Optional.** Datacenter/vCenter hostname. In case the check is done through a Datacenter/vCenter host. 4826vmware_sslport | **Optional.** SSL port connection. Defaults to "443". 4827vmware_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". 4828vmware_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". 4829vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90". 4830vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace. 4831vmware_sessionfile | **Optional.** Session file name enhancement. 4832vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp". 4833vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false". 4834vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default. 4835vmware_password | **Optional.** The username's password. No value defined as default. 4836vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Authentication file content:** <br> username=vmuser <br> password=p@ssw0rd 4837vmware_exclude | **Optional.** Blacklist status name. No value defined as default. 4838vmware_include | **Optional.** Whitelist status name. No value defined as default. 4839vmware_isregexp | **Optional.** Treat blacklist and whitelist expressions as regexp. 4840 4841 4842**vmware-esx-soap-host-runtime-health-listsensors** 4843 4844Check command object for the `check_vmware_esx` plugin. List all available sensors(use for listing purpose only). 4845 4846Custom variables passed as [command parameters](03-monitoring-basics.md#command-passing-parameters): 4847 4848Name | Description 4849------------------------|-------------- 4850vmware_host | **Required.** ESX or ESXi hostname. 4851vmware_datacenter | **Optional.** Datacenter/vCenter hostname. In case the check is done through a Datacenter/vCenter host. 4852vmware_sslport | **Optional.** SSL port connection. Defaults to "443". 4853vmware_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". 4854vmware_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". 4855vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90". 4856vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace. 4857vmware_sessionfile | **Optional.** Session file name enhancement. 4858vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp". 4859vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false". 4860vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default. 4861vmware_password | **Optional.** The username's password. No value defined as default. 4862vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Authentication file content:** <br> username=vmuser <br> password=p@ssw0rd 4863vmware_exclude | **Optional.** Blacklist status name. No value defined as default. 4864vmware_include | **Optional.** Whitelist status name. No value defined as default. 4865vmware_isregexp | **Optional.** Treat blacklist and whitelist expressions as regexp. 4866 4867 4868**vmware-esx-soap-host-runtime-health-nostoragestatus** 4869 4870Check 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**. 4871 4872Custom variables passed as [command parameters](03-monitoring-basics.md#command-passing-parameters): 4873 4874Name | Description 4875------------------------|-------------- 4876vmware_host | **Required.** ESX or ESXi hostname. 4877vmware_datacenter | **Optional.** Datacenter/vCenter hostname. In case the check is done through a Datacenter/vCenter host. 4878vmware_sslport | **Optional.** SSL port connection. Defaults to "443". 4879vmware_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". 4880vmware_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". 4881vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90". 4882vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace. 4883vmware_sessionfile | **Optional.** Session file name enhancement. 4884vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp". 4885vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false". 4886vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default. 4887vmware_password | **Optional.** The username's password. No value defined as default. 4888vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Authentication file content:** <br> username=vmuser <br> password=p@ssw0rd 4889vmware_exclude | **Optional.** Blacklist status name. No value defined as default. 4890vmware_include | **Optional.** Whitelist status name. No value defined as default. 4891vmware_isregexp | **Optional.** Treat blacklist and whitelist expressions as regexp. 4892 4893 4894**vmware-esx-soap-host-runtime-storagehealth** 4895 4896Check command object for the `check_vmware_esx` plugin. Local storage status check. 4897 4898Custom variables passed as [command parameters](03-monitoring-basics.md#command-passing-parameters): 4899 4900Name | Description 4901------------------------|-------------- 4902vmware_host | **Required.** ESX or ESXi hostname. 4903vmware_datacenter | **Optional.** Datacenter/vCenter hostname. In case the check is done through a Datacenter/vCenter host. 4904vmware_sslport | **Optional.** SSL port connection. Defaults to "443". 4905vmware_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". 4906vmware_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". 4907vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90". 4908vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace. 4909vmware_sessionfile | **Optional.** Session file name enhancement. 4910vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp". 4911vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false". 4912vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default. 4913vmware_password | **Optional.** The username's password. No value defined as default. 4914vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Authentication file content:** <br> username=vmuser <br> password=p@ssw0rd 4915vmware_exclude | **Optional.** Blacklist storage name. No value defined as default. 4916vmware_include | **Optional.** Whitelist storage name. No value defined as default. 4917vmware_isregexp | **Optional.** Treat blacklist and whitelist expressions as regexp. 4918vmware_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. 4919 4920 4921**vmware-esx-soap-host-runtime-temp** 4922 4923Check command object for the `check_vmware_esx` plugin. Lists all temperature sensors. 4924 4925Custom variables passed as [command parameters](03-monitoring-basics.md#command-passing-parameters): 4926 4927Name | Description 4928------------------------|-------------- 4929vmware_host | **Required.** ESX or ESXi hostname. 4930vmware_datacenter | **Optional.** Datacenter/vCenter hostname. In case the check is done through a Datacenter/vCenter host. 4931vmware_sslport | **Optional.** SSL port connection. Defaults to "443". 4932vmware_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". 4933vmware_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". 4934vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90". 4935vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace. 4936vmware_sessionfile | **Optional.** Session file name enhancement. 4937vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp". 4938vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false". 4939vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default. 4940vmware_password | **Optional.** The username's password. No value defined as default. 4941vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Authentication file content:** <br> username=vmuser <br> password=p@ssw0rd 4942vmware_exclude | **Optional.** Blacklist sensor name. No value defined as default. 4943vmware_include | **Optional.** Whitelist sensor name. No value defined as default. 4944vmware_isregexp | **Optional.** Treat blacklist and whitelist expressions as regexp. 4945vmware_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. 4946 4947 4948**vmware-esx-soap-host-runtime-issues** 4949 4950Check command object for the `check_vmware_esx` plugin. Lists all configuration issues for the host. 4951 4952Custom variables passed as [command parameters](03-monitoring-basics.md#command-passing-parameters): 4953 4954Name | Description 4955------------------------|-------------- 4956vmware_host | **Required.** ESX or ESXi hostname. 4957vmware_datacenter | **Optional.** Datacenter/vCenter hostname. In case the check is done through a Datacenter/vCenter host. 4958vmware_sslport | **Optional.** SSL port connection. Defaults to "443". 4959vmware_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". 4960vmware_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". 4961vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90". 4962vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace. 4963vmware_sessionfile | **Optional.** Session file name enhancement. 4964vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp". 4965vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false". 4966vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default. 4967vmware_password | **Optional.** The username's password. No value defined as default. 4968vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Authentication file content:** <br> username=vmuser <br> password=p@ssw0rd 4969vmware_exclude | **Optional.** Blacklist configuration issues. No value defined as default. 4970vmware_include | **Optional.** Whitelist configuration issues. No value defined as default. 4971vmware_isregexp | **Optional.** Treat blacklist and whitelist expressions as regexp. 4972vmware_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. 4973 4974 4975**vmware-esx-soap-host-storage** 4976 4977Check command object for the `check_vmware_esx` plugin. Shows Host storage info. 4978 4979Custom variables passed as [command parameters](03-monitoring-basics.md#command-passing-parameters): 4980 4981Name | Description 4982------------------------|-------------- 4983vmware_host | **Required.** ESX or ESXi hostname. 4984vmware_datacenter | **Optional.** Datacenter/vCenter hostname. In case the check is done through a Datacenter/vCenter host. 4985vmware_sslport | **Optional.** SSL port connection. Defaults to "443". 4986vmware_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". 4987vmware_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". 4988vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90". 4989vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace. 4990vmware_sessionfile | **Optional.** Session file name enhancement. 4991vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp". 4992vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false". 4993vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default. 4994vmware_password | **Optional.** The username's password. No value defined as default. 4995vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Authentication file content:** <br> username=vmuser <br> password=p@ssw0rd 4996vmware_exclude | **Optional.** Blacklist adapters, luns and paths. No value defined as default. 4997vmware_include | **Optional.** Whitelist adapters, luns and paths. No value defined as default. 4998vmware_isregexp | **Optional.** Treat blacklist and whitelist expressions as regexp. 4999 5000 5001**vmware-esx-soap-host-storage-adapter** 5002 5003Check command object for the `check_vmware_esx` plugin. List host bus adapters. 5004 5005Custom variables passed as [command parameters](03-monitoring-basics.md#command-passing-parameters): 5006 5007Name | Description 5008------------------------|-------------- 5009vmware_host | **Required.** ESX or ESXi hostname. 5010vmware_datacenter | **Optional.** Datacenter/vCenter hostname. In case the check is done through a Datacenter/vCenter host. 5011vmware_sslport | **Optional.** SSL port connection. Defaults to "443". 5012vmware_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". 5013vmware_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". 5014vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90". 5015vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace. 5016vmware_sessionfile | **Optional.** Session file name enhancement. 5017vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp". 5018vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false". 5019vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default. 5020vmware_password | **Optional.** The username's password. No value defined as default. 5021vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Authentication file content:** <br> username=vmuser <br> password=p@ssw0rd 5022vmware_exclude | **Optional.** Blacklist adapters. No value defined as default. 5023vmware_include | **Optional.** Whitelist adapters. No value defined as default. 5024vmware_isregexp | **Optional.** Treat blacklist and whitelist expressions as regexp. 5025vmware_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. 5026 5027 5028**vmware-esx-soap-host-storage-lun** 5029 5030Check 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. 5031 5032Custom variables passed as [command parameters](03-monitoring-basics.md#command-passing-parameters): 5033 5034Name | Description 5035------------------------|-------------- 5036vmware_host | **Required.** ESX or ESXi hostname. 5037vmware_datacenter | **Optional.** Datacenter/vCenter hostname. In case the check is done through a Datacenter/vCenter host. 5038vmware_sslport | **Optional.** SSL port connection. Defaults to "443". 5039vmware_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". 5040vmware_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". 5041vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90". 5042vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace. 5043vmware_sessionfile | **Optional.** Session file name enhancement. 5044vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp". 5045vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false". 5046vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default. 5047vmware_password | **Optional.** The username's password. No value defined as default. 5048vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Authentication file content:** <br> username=vmuser <br> password=p@ssw0rd 5049vmware_exclude | **Optional.** Blacklist luns. No value defined as default. 5050vmware_include | **Optional.** Whitelist luns. No value defined as default. 5051vmware_isregexp | **Optional.** Treat blacklist and whitelist expressions as regexp. 5052vmware_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. 5053 5054 5055**vmware-esx-soap-host-storage-path** 5056 5057Check command object for the `check_vmware_esx` plugin. List multipaths and the associated paths. 5058 5059Custom variables passed as [command parameters](03-monitoring-basics.md#command-passing-parameters): 5060 5061Name | Description 5062------------------------|-------------- 5063vmware_host | **Required.** ESX or ESXi hostname. 5064vmware_datacenter | **Optional.** Datacenter/vCenter hostname. In case the check is done through a Datacenter/vCenter host. 5065vmware_sslport | **Optional.** SSL port connection. Defaults to "443". 5066vmware_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". 5067vmware_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". 5068vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90". 5069vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace. 5070vmware_sessionfile | **Optional.** Session file name enhancement. 5071vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp". 5072vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false". 5073vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default. 5074vmware_password | **Optional.** The username's password. No value defined as default. 5075vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Authentication file content:** <br> username=vmuser <br> password=p@ssw0rd 5076vmware_alertonly | **Optional.** List only alerting units. Important here to avoid masses of data. Defaults to "false". 5077vmware_exclude | **Optional.** Blacklist paths. No value defined as default. 5078vmware_include | **Optional.** Whitelist paths. No value defined as default. 5079vmware_isregexp | **Optional.** Treat blacklist and whitelist expressions as regexp. 5080vmware_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. 5081vmware_standbyok | **Optional.** For storage systems where a standby multipath is ok and not a warning. Defaults to false. 5082 5083 5084**vmware-esx-soap-vm-cpu** 5085 5086Check command object for the `check_vmware_esx` plugin. Shows all CPU usage info. 5087 5088Custom variables passed as [command parameters](03-monitoring-basics.md#command-passing-parameters): 5089 5090Name | Description 5091------------------------|-------------- 5092vmware_datacenter | **Optional.** Datacenter/vCenter hostname. Conflicts with **vmware_host**. 5093vmware_host | **Optional.** ESX or ESXi hostname. Conflicts with **vmware_datacenter**. 5094vmware_vmname | **Required.** Virtual machine name. 5095vmware_sslport | **Optional.** SSL port connection. Defaults to "443". 5096vmware_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". 5097vmware_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". 5098vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90". 5099vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace. 5100vmware_sessionfile | **Optional.** Session file name enhancement. 5101vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp". 5102vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false". 5103vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default. 5104vmware_password | **Optional.** The username's password. No value defined as default. 5105vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Authentication file content:** <br> username=vmuser <br> password=p@ssw0rd 5106 5107 5108 5109**vmware-esx-soap-vm-cpu-ready** 5110 5111Check 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. 5112 5113Custom variables passed as [command parameters](03-monitoring-basics.md#command-passing-parameters): 5114 5115Name | Description 5116------------------------|-------------- 5117vmware_datacenter | **Optional.** Datacenter/vCenter hostname. Conflicts with **vmware_host**. 5118vmware_host | **Optional.** ESX or ESXi hostname. Conflicts with **vmware_datacenter**. 5119vmware_vmname | **Required.** Virtual machine name. 5120vmware_sslport | **Optional.** SSL port connection. Defaults to "443". 5121vmware_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". 5122vmware_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". 5123vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90". 5124vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace. 5125vmware_sessionfile | **Optional.** Session file name enhancement. 5126vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp". 5127vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false". 5128vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default. 5129vmware_password | **Optional.** The username's password. No value defined as default. 5130vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Authentication file content:** <br> username=vmuser <br> password=p@ssw0rd 5131vmware_warn | **Optional.** The warning threshold. No value defined as default. 5132vmware_crit | **Optional.** The critical threshold. No value defined as default. 5133 5134 5135**vmware-esx-soap-vm-cpu-wait** 5136 5137Check 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. 5138 5139Custom variables passed as [command parameters](03-monitoring-basics.md#command-passing-parameters): 5140 5141Name | Description 5142------------------------|-------------- 5143vmware_datacenter | **Optional.** Datacenter/vCenter hostname. Conflicts with **vmware_host**. 5144vmware_host | **Optional.** ESX or ESXi hostname. Conflicts with **vmware_datacenter**. 5145vmware_vmname | **Required.** Virtual machine name. 5146vmware_sslport | **Optional.** SSL port connection. Defaults to "443". 5147vmware_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". 5148vmware_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". 5149vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90". 5150vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace. 5151vmware_sessionfile | **Optional.** Session file name enhancement. 5152vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp". 5153vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false". 5154vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default. 5155vmware_password | **Optional.** The username's password. No value defined as default. 5156vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Authentication file content:** <br> username=vmuser <br> password=p@ssw0rd 5157vmware_warn | **Optional.** The warning threshold. No value defined as default. 5158vmware_crit | **Optional.** The critical threshold. No value defined as default. 5159 5160 5161**vmware-esx-soap-vm-cpu-usage** 5162 5163Check 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. 5164 5165Custom variables passed as [command parameters](03-monitoring-basics.md#command-passing-parameters): 5166 5167Name | Description 5168------------------------|-------------- 5169vmware_datacenter | **Optional.** Datacenter/vCenter hostname. Conflicts with **vmware_host**. 5170vmware_host | **Optional.** ESX or ESXi hostname. Conflicts with **vmware_datacenter**. 5171vmware_vmname | **Required.** Virtual machine name. 5172vmware_sslport | **Optional.** SSL port connection. Defaults to "443". 5173vmware_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". 5174vmware_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". 5175vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90". 5176vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace. 5177vmware_sessionfile | **Optional.** Session file name enhancement. 5178vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp". 5179vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false". 5180vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default. 5181vmware_password | **Optional.** The username's password. No value defined as default. 5182vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Authentication file content:** <br> username=vmuser <br> password=p@ssw0rd 5183vmware_warn | **Optional.** Warning threshold in percent. Defaults to "80%". 5184vmware_crit | **Optional.** Critical threshold in percent. Defaults to "90%". 5185 5186 5187**vmware-esx-soap-vm-mem** 5188 5189Check command object for the `check_vmware_esx` plugin. Shows all memory info, except overall. 5190 5191Custom variables passed as [command parameters](03-monitoring-basics.md#command-passing-parameters): 5192 5193Name | Description 5194------------------------|-------------- 5195vmware_datacenter | **Optional.** Datacenter/vCenter hostname. Conflicts with **vmware_host**. 5196vmware_host | **Optional.** ESX or ESXi hostname. Conflicts with **vmware_datacenter**. 5197vmware_vmname | **Required.** Virtual machine name. 5198vmware_sslport | **Optional.** SSL port connection. Defaults to "443". 5199vmware_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". 5200vmware_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". 5201vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90". 5202vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace. 5203vmware_sessionfile | **Optional.** Session file name enhancement. 5204vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp". 5205vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false". 5206vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default. 5207vmware_password | **Optional.** The username's password. No value defined as default. 5208vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Authentication file content:** <br> username=vmuser <br> password=p@ssw0rd 5209 5210 5211**vmware-esx-soap-vm-mem-usage** 5212 5213Check command object for the `check_vmware_esx` plugin. Average mem usage in percentage of configured virtual machine "physical" memory. 5214 5215Custom variables passed as [command parameters](03-monitoring-basics.md#command-passing-parameters): 5216 5217Name | Description 5218------------------------|-------------- 5219vmware_datacenter | **Optional.** Datacenter/vCenter hostname. Conflicts with **vmware_host**. 5220vmware_host | **Optional.** ESX or ESXi hostname. Conflicts with **vmware_datacenter**. 5221vmware_vmname | **Required.** Virtual machine name. 5222vmware_sslport | **Optional.** SSL port connection. Defaults to "443". 5223vmware_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". 5224vmware_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". 5225vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90". 5226vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace. 5227vmware_sessionfile | **Optional.** Session file name enhancement. 5228vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp". 5229vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false". 5230vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default. 5231vmware_password | **Optional.** The username's password. No value defined as default. 5232vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Authentication file content:** <br> username=vmuser <br> password=p@ssw0rd 5233vmware_warn | **Optional.** Warning threshold in percent. Defaults to "80%". 5234vmware_crit | **Optional.** Critical threshold in percent. Defaults to "90%". 5235 5236 5237**vmware-esx-soap-vm-mem-consumed** 5238 5239Check 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> 5240**vm consumed memory = memory granted -- memory saved** 5241 5242Custom variables passed as [command parameters](03-monitoring-basics.md#command-passing-parameters): 5243 5244Name | Description 5245------------------------|-------------- 5246vmware_datacenter | **Optional.** Datacenter/vCenter hostname. Conflicts with **vmware_host**. 5247vmware_host | **Optional.** ESX or ESXi hostname. Conflicts with **vmware_datacenter**. 5248vmware_vmname | **Required.** Virtual machine name. 5249vmware_sslport | **Optional.** SSL port connection. Defaults to "443". 5250vmware_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". 5251vmware_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". 5252vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90". 5253vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace. 5254vmware_sessionfile | **Optional.** Session file name enhancement. 5255vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp". 5256vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false". 5257vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default. 5258vmware_password | **Optional.** The username's password. No value defined as default. 5259vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Authentication file content:** <br> username=vmuser <br> password=p@ssw0rd 5260vmware_warn | **Optional.** The warning threshold. No value defined as default. 5261vmware_crit | **Optional.** The critical threshold. No value defined as default. 5262 5263 5264**vmware-esx-soap-vm-mem-memctl** 5265 5266Check 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. 5267 5268Custom variables passed as [command parameters](03-monitoring-basics.md#command-passing-parameters): 5269 5270Name | Description 5271------------------------|-------------- 5272vmware_datacenter | **Optional.** Datacenter/vCenter hostname. Conflicts with **vmware_host**. 5273vmware_host | **Optional.** ESX or ESXi hostname. Conflicts with **vmware_datacenter**. 5274vmware_vmname | **Required.** Virtual machine name. 5275vmware_sslport | **Optional.** SSL port connection. Defaults to "443". 5276vmware_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". 5277vmware_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". 5278vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90". 5279vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace. 5280vmware_sessionfile | **Optional.** Session file name enhancement. 5281vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp". 5282vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false". 5283vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default. 5284vmware_password | **Optional.** The username's password. No value defined as default. 5285vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Authentication file content:** <br> username=vmuser <br> password=p@ssw0rd 5286vmware_warn | **Optional.** The warning threshold. No value defined as default. 5287vmware_crit | **Optional.** The critical threshold. No value defined as default. 5288 5289 5290 5291**vmware-esx-soap-vm-net** 5292 5293Check command object for the `check_vmware_esx` plugin. Shows net info. 5294 5295Custom variables passed as [command parameters](03-monitoring-basics.md#command-passing-parameters): 5296 5297Name | Description 5298------------------------|-------------- 5299vmware_datacenter | **Optional.** Datacenter/vCenter hostname. Conflicts with **vmware_host**. 5300vmware_host | **Optional.** ESX or ESXi hostname. Conflicts with **vmware_datacenter**. 5301vmware_vmname | **Required.** Virtual machine name. 5302vmware_sslport | **Optional.** SSL port connection. Defaults to "443". 5303vmware_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". 5304vmware_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". 5305vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90". 5306vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace. 5307vmware_sessionfile | **Optional.** Session file name enhancement. 5308vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp". 5309vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false". 5310vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default. 5311vmware_password | **Optional.** The username's password. No value defined as default. 5312vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Authentication file content:** <br> username=vmuser <br> password=p@ssw0rd 5313 5314 5315**vmware-esx-soap-vm-net-usage** 5316 5317Check command object for the `check_vmware_esx` plugin. Overall network usage in KBps(Kilobytes per Second). 5318 5319Custom variables passed as [command parameters](03-monitoring-basics.md#command-passing-parameters): 5320 5321Name | Description 5322------------------------|-------------- 5323vmware_datacenter | **Optional.** Datacenter/vCenter hostname. Conflicts with **vmware_host**. 5324vmware_host | **Optional.** ESX or ESXi hostname. Conflicts with **vmware_datacenter**. 5325vmware_vmname | **Required.** Virtual machine name. 5326vmware_sslport | **Optional.** SSL port connection. Defaults to "443". 5327vmware_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". 5328vmware_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". 5329vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90". 5330vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace. 5331vmware_sessionfile | **Optional.** Session file name enhancement. 5332vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp". 5333vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false". 5334vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default. 5335vmware_password | **Optional.** The username's password. No value defined as default. 5336vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Authentication file content:** <br> username=vmuser <br> password=p@ssw0rd 5337vmware_warn | **Optional.** The warning threshold. No value defined as default. 5338vmware_crit | **Optional.** The critical threshold. No value defined as default. 5339 5340 5341**vmware-esx-soap-vm-net-receive** 5342 5343Check command object for the `check_vmware_esx` plugin. Receive in KBps(Kilobytes per Second). 5344 5345Custom variables passed as [command parameters](03-monitoring-basics.md#command-passing-parameters): 5346 5347Name | Description 5348------------------------|-------------- 5349vmware_datacenter | **Optional.** Datacenter/vCenter hostname. Conflicts with **vmware_host**. 5350vmware_host | **Optional.** ESX or ESXi hostname. Conflicts with **vmware_datacenter**. 5351vmware_vmname | **Required.** Virtual machine name. 5352vmware_sslport | **Optional.** SSL port connection. Defaults to "443". 5353vmware_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". 5354vmware_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". 5355vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90". 5356vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace. 5357vmware_sessionfile | **Optional.** Session file name enhancement. 5358vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp". 5359vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false". 5360vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default. 5361vmware_password | **Optional.** The username's password. No value defined as default. 5362vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Authentication file content:** <br> username=vmuser <br> password=p@ssw0rd 5363vmware_warn | **Optional.** The warning threshold. No value defined as default. 5364vmware_crit | **Optional.** The critical threshold. No value defined as default. 5365 5366 5367**vmware-esx-soap-vm-net-send** 5368 5369Check command object for the `check_vmware_esx` plugin. Send in KBps(Kilobytes per Second). 5370 5371Custom variables passed as [command parameters](03-monitoring-basics.md#command-passing-parameters): 5372 5373Name | Description 5374------------------------|-------------- 5375vmware_datacenter | **Optional.** Datacenter/vCenter hostname. Conflicts with **vmware_host**. 5376vmware_host | **Optional.** ESX or ESXi hostname. Conflicts with **vmware_datacenter**. 5377vmware_vmname | **Required.** Virtual machine name. 5378vmware_sslport | **Optional.** SSL port connection. Defaults to "443". 5379vmware_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". 5380vmware_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". 5381vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90". 5382vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace. 5383vmware_sessionfile | **Optional.** Session file name enhancement. 5384vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp". 5385vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false". 5386vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default. 5387vmware_password | **Optional.** The username's password. No value defined as default. 5388vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Authentication file content:** <br> username=vmuser <br> password=p@ssw0rd 5389vmware_warn | **Optional.** The warning threshold. No value defined as default. 5390vmware_crit | **Optional.** The critical threshold. No value defined as default. 5391 5392 5393**vmware-esx-soap-vm-io** 5394 5395Check 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. 5396 5397Custom variables passed as [command parameters](03-monitoring-basics.md#command-passing-parameters): 5398 5399Name | Description 5400------------------------|-------------- 5401vmware_datacenter | **Optional.** Datacenter/vCenter hostname. Conflicts with **vmware_host**. 5402vmware_host | **Optional.** ESX or ESXi hostname. Conflicts with **vmware_datacenter**. 5403vmware_vmname | **Required.** Virtual machine name. 5404vmware_sslport | **Optional.** SSL port connection. Defaults to "443". 5405vmware_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". 5406vmware_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". 5407vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90". 5408vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace. 5409vmware_sessionfile | **Optional.** Session file name enhancement. 5410vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp". 5411vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false". 5412vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default. 5413vmware_password | **Optional.** The username's password. No value defined as default. 5414vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Authentication file content:** <br> username=vmuser <br> password=p@ssw0rd 5415 5416 5417**vmware-esx-soap-vm-io-read** 5418 5419Check command object for the `check_vmware_esx` plugin. Average number of kilobytes read from the disk each second. 5420 5421Custom variables passed as [command parameters](03-monitoring-basics.md#command-passing-parameters): 5422 5423Name | Description 5424------------------------|-------------- 5425vmware_datacenter | **Optional.** Datacenter/vCenter hostname. Conflicts with **vmware_host**. 5426vmware_host | **Optional.** ESX or ESXi hostname. Conflicts with **vmware_datacenter**. 5427vmware_vmname | **Required.** Virtual machine name. 5428vmware_sslport | **Optional.** SSL port connection. Defaults to "443". 5429vmware_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". 5430vmware_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". 5431vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90". 5432vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace. 5433vmware_sessionfile | **Optional.** Session file name enhancement. 5434vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp". 5435vmware_nosession | **Optional.** No auth session - IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false". 5436vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default. 5437vmware_password | **Optional.** The username's password. No value defined as default. 5438vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Authentication file content:** <br> username=vmuser <br> password=p@ssw0rd 5439vmware_warn | **Optional.** The warning threshold. No value defined as default. 5440vmware_crit | **Optional.** The critical threshold. No value defined as default. 5441 5442 5443**vmware-esx-soap-vm-io-write** 5444 5445Check command object for the `check_vmware_esx` plugin. Average number of kilobytes written to disk each second. 5446 5447Custom variables passed as [command parameters](03-monitoring-basics.md#command-passing-parameters): 5448 5449Name | Description 5450------------------------|-------------- 5451vmware_datacenter | **Optional.** Datacenter/vCenter hostname. Conflicts with **vmware_host**. 5452vmware_host | **Optional.** ESX or ESXi hostname. Conflicts with **vmware_datacenter**. 5453vmware_vmname | **Required.** Virtual machine name. 5454vmware_sslport | **Optional.** SSL port connection. Defaults to "443". 5455vmware_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". 5456vmware_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". 5457vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90". 5458vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace. 5459vmware_sessionfile | **Optional.** Session file name enhancement. 5460vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp". 5461vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false". 5462vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default. 5463vmware_password | **Optional.** The username's password. No value defined as default. 5464vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Authentication file content:** <br> username=vmuser <br> password=p@ssw0rd 5465vmware_warn | **Optional.** The warning threshold. No value defined as default. 5466vmware_crit | **Optional.** The critical threshold. No value defined as default. 5467 5468 5469**vmware-esx-soap-vm-io-usage** 5470 5471Check command object for the `check_vmware_esx` plugin. Aggregated disk I/O rate. 5472 5473Custom variables passed as [command parameters](03-monitoring-basics.md#command-passing-parameters): 5474 5475Name | Description 5476------------------------|-------------- 5477vmware_datacenter | **Optional.** Datacenter/vCenter hostname. Conflicts with **vmware_host**. 5478vmware_host | **Optional.** ESX or ESXi hostname. Conflicts with **vmware_datacenter**. 5479vmware_vmname | **Required.** Virtual machine name. 5480vmware_sslport | **Optional.** SSL port connection. Defaults to "443". 5481vmware_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". 5482vmware_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". 5483vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90". 5484vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace. 5485vmware_sessionfile | **Optional.** Session file name enhancement. 5486vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp". 5487vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false". 5488vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default. 5489vmware_password | **Optional.** The username's password. No value defined as default. 5490vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Authentication file content:** <br> username=vmuser <br> password=p@ssw0rd 5491vmware_warn | **Optional.** The warning threshold. No value defined as default. 5492vmware_crit | **Optional.** The critical threshold. No value defined as default. 5493 5494 5495**vmware-esx-soap-vm-runtime** 5496 5497Check command object for the `check_vmware_esx` plugin. Shows virtual machine runtime info. 5498 5499Custom variables passed as [command parameters](03-monitoring-basics.md#command-passing-parameters): 5500 5501Name | Description 5502------------------------|-------------- 5503vmware_datacenter | **Optional.** Datacenter/vCenter hostname. Conflicts with **vmware_host**. 5504vmware_host | **Optional.** ESX or ESXi hostname. Conflicts with **vmware_datacenter**. 5505vmware_vmname | **Required.** Virtual machine name. 5506vmware_sslport | **Optional.** SSL port connection. Defaults to "443". 5507vmware_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". 5508vmware_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". 5509vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90". 5510vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace. 5511vmware_sessionfile | **Optional.** Session file name enhancement. 5512vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp". 5513vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false". 5514vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default. 5515vmware_password | **Optional.** The username's password. No value defined as default. 5516vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Authentication file content:** <br> username=vmuser <br> password=p@ssw0rd 5517 5518 5519**vmware-esx-soap-vm-runtime-con** 5520 5521Check command object for the `check_vmware_esx` plugin. Shows the connection state. 5522 5523Custom variables passed as [command parameters](03-monitoring-basics.md#command-passing-parameters): 5524 5525Name | Description 5526------------------------|-------------- 5527vmware_datacenter | **Optional.** Datacenter/vCenter hostname. Conflicts with **vmware_host**. 5528vmware_host | **Optional.** ESX or ESXi hostname. Conflicts with **vmware_datacenter**. 5529vmware_vmname | **Required.** Virtual machine name. 5530vmware_sslport | **Optional.** SSL port connection. Defaults to "443". 5531vmware_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". 5532vmware_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". 5533vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90". 5534vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace. 5535vmware_sessionfile | **Optional.** Session file name enhancement. 5536vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp". 5537vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false". 5538vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default. 5539vmware_password | **Optional.** The username's password. No value defined as default. 5540vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Authentication file content:** <br> username=vmuser <br> password=p@ssw0rd 5541 5542 5543**vmware-esx-soap-vm-runtime-powerstate** 5544 5545Check command object for the `check_vmware_esx` plugin. Shows virtual machine power state: poweredOn, poweredOff or suspended. 5546 5547Custom variables passed as [command parameters](03-monitoring-basics.md#command-passing-parameters): 5548 5549Name | Description 5550------------------------|-------------- 5551vmware_datacenter | **Optional.** Datacenter/vCenter hostname. Conflicts with **vmware_host**. 5552vmware_host | **Optional.** ESX or ESXi hostname. Conflicts with **vmware_datacenter**. 5553vmware_vmname | **Required.** Virtual machine name. 5554vmware_sslport | **Optional.** SSL port connection. Defaults to "443". 5555vmware_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". 5556vmware_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". 5557vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90". 5558vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace. 5559vmware_sessionfile | **Optional.** Session file name enhancement. 5560vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp". 5561vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false". 5562vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default. 5563vmware_password | **Optional.** The username's password. No value defined as default. 5564vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Authentication file content:** <br> username=vmuser <br> password=p@ssw0rd 5565 5566 5567**vmware-esx-soap-vm-runtime-status** 5568 5569Check command object for the `check_vmware_esx` plugin. Overall object status (gray/green/red/yellow). 5570 5571Custom variables passed as [command parameters](03-monitoring-basics.md#command-passing-parameters): 5572 5573Name | Description 5574------------------------|-------------- 5575vmware_datacenter | **Optional.** Datacenter/vCenter hostname. Conflicts with **vmware_host**. 5576vmware_host | **Optional.** ESX or ESXi hostname. Conflicts with **vmware_datacenter**. 5577vmware_vmname | **Required.** Virtual machine name. 5578vmware_sslport | **Optional.** SSL port connection. Defaults to "443". 5579vmware_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". 5580vmware_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". 5581vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90". 5582vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace. 5583vmware_sessionfile | **Optional.** Session file name enhancement. 5584vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp". 5585vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false". 5586vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default. 5587vmware_password | **Optional.** The username's password. No value defined as default. 5588vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Authentication file content:** <br> username=vmuser <br> password=p@ssw0rd 5589 5590 5591**vmware-esx-soap-vm-runtime-consoleconnections** 5592 5593Check command object for the `check_vmware_esx` plugin. Console connections to virtual machine. 5594 5595Custom variables passed as [command parameters](03-monitoring-basics.md#command-passing-parameters): 5596 5597Name | Description 5598------------------------|-------------- 5599vmware_datacenter | **Optional.** Datacenter/vCenter hostname. Conflicts with **vmware_host**. 5600vmware_host | **Optional.** ESX or ESXi hostname. Conflicts with **vmware_datacenter**. 5601vmware_vmname | **Required.** Virtual machine name. 5602vmware_sslport | **Optional.** SSL port connection. Defaults to "443". 5603vmware_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". 5604vmware_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". 5605vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90". 5606vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace. 5607vmware_sessionfile | **Optional.** Session file name enhancement. 5608vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp". 5609vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false". 5610vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default. 5611vmware_password | **Optional.** The username's password. No value defined as default. 5612vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Authentication file content:** <br> username=vmuser <br> password=p@ssw0rd 5613vmware_warn | **Optional.** The warning threshold. No value defined as default. 5614vmware_crit | **Optional.** The critical threshold. No value defined as default. 5615 5616 5617**vmware-esx-soap-vm-runtime-gueststate** 5618 5619Check command object for the `check_vmware_esx` plugin. Guest OS status. Needs VMware Tools installed and running. 5620 5621Custom variables passed as [command parameters](03-monitoring-basics.md#command-passing-parameters): 5622 5623Name | Description 5624------------------------|-------------- 5625vmware_datacenter | **Optional.** Datacenter/vCenter hostname. Conflicts with **vmware_host**. 5626vmware_host | **Optional.** ESX or ESXi hostname. Conflicts with **vmware_datacenter**. 5627vmware_vmname | **Required.** Virtual machine name. 5628vmware_sslport | **Optional.** SSL port connection. Defaults to "443". 5629vmware_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". 5630vmware_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". 5631vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90". 5632vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace. 5633vmware_sessionfile | **Optional.** Session file name enhancement. 5634vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp". 5635vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false". 5636vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default. 5637vmware_password | **Optional.** The username's password. No value defined as default. 5638vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Authentication file content:** <br> username=vmuser <br> password=p@ssw0rd 5639 5640**vmware-esx-soap-vm-runtime-tools** 5641 5642Check command object for the `check_vmware_esx` plugin. Guest OS status. VMware tools status. 5643 5644Custom variables passed as [command parameters](03-monitoring-basics.md#command-passing-parameters): 5645 5646Name | Description 5647------------------------|-------------- 5648vmware_datacenter | **Optional.** Datacenter/vCenter hostname. Conflicts with **vmware_host**. 5649vmware_host | **Optional.** ESX or ESXi hostname. Conflicts with **vmware_datacenter**. 5650vmware_vmname | **Required.** Virtual machine name. 5651vmware_sslport | **Optional.** SSL port connection. Defaults to "443". 5652vmware_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". 5653vmware_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". 5654vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90". 5655vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace. 5656vmware_sessionfile | **Optional.** Session file name enhancement. 5657vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp". 5658vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false". 5659vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default. 5660vmware_password | **Optional.** The username's password. No value defined as default. 5661vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Authentication file content:** <br> username=vmuser <br> password=p@ssw0rd 5662vmware_openvmtools | **Optional** Prevent CRITICAL state for installed and running Open VM Tools. 5663 5664 5665**vmware-esx-soap-vm-runtime-issues** 5666 5667Check command object for the `check_vmware_esx` plugin. All issues for the virtual machine. 5668 5669Custom variables passed as [command parameters](03-monitoring-basics.md#command-passing-parameters): 5670 5671Name | Description 5672------------------------|-------------- 5673vmware_datacenter | **Optional.** Datacenter/vCenter hostname. Conflicts with **vmware_host**. 5674vmware_host | **Optional.** ESX or ESXi hostname. Conflicts with **vmware_datacenter**. 5675vmware_vmname | **Required.** Virtual machine name. 5676vmware_sslport | **Optional.** SSL port connection. Defaults to "443". 5677vmware_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". 5678vmware_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". 5679vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90". 5680vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace. 5681vmware_sessionfile | **Optional.** Session file name enhancement. 5682vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp". 5683vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false". 5684vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default. 5685vmware_password | **Optional.** The username's password. No value defined as default. 5686vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Authentication file content:** <br> username=vmuser <br> password=p@ssw0rd 5687vmware_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. 5688 5689 5690### Web <a id="plugin-contrib-web"></a> 5691 5692This category includes all plugins for web-based checks. 5693 5694#### apache-status <a id="plugin-contrib-command-apache-status"></a> 5695 5696The [check_apache_status.pl](https://github.com/lbetz/check_apache_status) plugin 5697uses the [/server-status](https://httpd.apache.org/docs/current/mod/mod_status.html) 5698HTTP endpoint to monitor status metrics for the Apache webserver. 5699 5700Custom variables passed as [command parameters](03-monitoring-basics.md#command-passing-parameters): 5701 5702Name | Description 5703--------------------------------|---------------------------------------------------------------------------------- 5704apache_status_address | **Optional.** Host address. Defaults to "$address$" if the host's `address` attribute is set, `address6` otherwise. 5705apache_status_port | **Optional.** HTTP port. 5706apache_status_uri | **Optional.** URL to use, instead of the default (http://`apache_status_address`/server-status). 5707apache_status_ssl | **Optional.** Set to use SSL connection. 5708apache_status_no_validate | **Optional.** Skip SSL certificate validation. 5709apache_status_username | **Optional.** Username for basic auth. 5710apache_status_password | **Optional.** Password for basic auth. 5711apache_status_timeout | **Optional.** Timeout in seconds. 5712apache_status_unreachable | **Optional.** Return CRITICAL if socket timed out or http code >= 500. 5713apache_status_warning | **Optional.** Warning threshold (number of open slots, busy workers and idle workers that will cause a WARNING) like ':20,50,:50'. 5714apache_status_critical | **Optional.** Critical threshold (number of open slots, busy workers and idle workers that will cause a CRITICAL) like ':10,25,:20'. 5715 5716 5717#### ssl_cert <a id="plugin-check-command-ssl_cert"></a> 5718 5719The [check_ssl_cert](https://github.com/matteocorti/check_ssl_cert) plugin 5720uses the openssl binary (and optional curl) to check a X.509 certificate. 5721 5722Custom variables passed as [command parameters](03-monitoring-basics.md#command-passing-parameters): 5723 5724Name | Description 5725--------------------------|-------------- 5726ssl_cert_address | **Optional.** The host's address. Defaults to "$address$" if the host's `address` attribute is set, "$address6$" otherwise. 5727ssl_cert_port | **Optional.** TCP port number (default: 443). 5728ssl_cert_file | **Optional.** Local file path. Works only if `ssl_cert_address` is set to "localhost". 5729ssl_cert_warn | **Optional.** Minimum number of days a certificate has to be valid. 5730ssl_cert_critical | **Optional.** Minimum number of days a certificate has to be valid to issue a critical status. 5731ssl_cert_cn | **Optional.** Pattern to match the CN of the certificate. 5732ssl_cert_altnames | **Optional.** Matches the pattern specified in -n with alternate 5733ssl_cert_issuer | **Optional.** Pattern to match the issuer of the certificate. 5734ssl_cert_org | **Optional.** Pattern to match the organization of the certificate. 5735ssl_cert_email | **Optional.** Pattern to match the email address contained in the certificate. 5736ssl_cert_serial | **Optional.** Pattern to match the serial number. 5737ssl_cert_noauth | **Optional.** Ignore authority warnings (expiration only) 5738ssl_cert_match_host | **Optional.** Match CN with the host name. 5739ssl_cert_selfsigned | **Optional.** Allow self-signed certificate. 5740ssl_cert_sni | **Optional.** Sets the TLS SNI (Server Name Indication) extension. 5741ssl_cert_timeout | **Optional.** Seconds before connection times out (default: 15) 5742ssl_cert_protocol | **Optional.** Use the specific protocol {http,smtp,pop3,imap,ftp,xmpp,irc,ldap} (default: http). 5743ssl_cert_clientcert | **Optional.** Use client certificate to authenticate. 5744ssl_cert_clientpass | **Optional.** Set passphrase for client certificate. 5745ssl_cert_ssllabs | **Optional.** SSL Labs assessment 5746ssl_cert_ssllabs_nocache | **Optional.** Forces a new check by SSL Labs 5747ssl_cert_rootcert | **Optional.** Root certificate or directory to be used for certificate validation. 5748ssl_cert_ignore_signature | **Optional.** Do not check if the certificate was signed with SHA1 od MD5. 5749ssl_cert_ssl_version | **Optional.** Force specific SSL version out of {ssl2,ssl3,tls1,tls1_1,tls1_2}. 5750ssl_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. 5751ssl_cert_cipher | **Optional.** Cipher selection: force {ecdsa,rsa} authentication. 5752ssl_cert_ignore_expiration | **Optional.** Ignore expiration date. 5753ssl_cert_ignore_ocsp | **Optional.** Do not check revocation with OCSP. 5754ssl_cert_ignore_sct | **Optional.** Do not check for signed certificate timestamps. 5755 5756 5757#### jmx4perl <a id="plugin-contrib-command-jmx4perl"></a> 5758 5759The [check_jmx4perl](https://metacpan.org/pod/distribution/jmx4perl/scripts/check_jmx4perl) plugin 5760uses the HTTP API exposed by the [Jolokia](https://jolokia.org) 5761web application and queries Java message beans on an application server. It is 5762part of the `JMX::Jmx4Perl` Perl module which includes detailed 5763[documentation](https://metacpan.org/pod/distribution/jmx4perl/scripts/check_jmx4perl). 5764 5765Custom variables passed as [command parameters](03-monitoring-basics.md#command-passing-parameters): 5766 5767Name | Description 5768-----------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------- 5769jmx4perl_url | **Required.** URL to agent web application. Defaults to "http://$address$:8080/jolokia". 5770jmx4perl_product | **Optional.** Name of app server product (e.g. jboss), by default is uses an auto detection facility. 5771jmx4perl_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. 5772jmx4perl_mbean | **Optional.** MBean name (e.g. java.lang:type=Memory). 5773jmx4perl_attribute | **Optional.** Attribute name (e.g. HeapMemoryUsage). 5774jmx4perl_operation | **Optional.** Operation to execute. 5775jmx4perl_value | **Optional.** Shortcut for specifying mbean/attribute/path. Slashes within names must be escaped with backslash. 5776jmx4perl_delta | **Optional.** Switches on incremental mode. Optional argument are seconds used for normalizing. 5777jmx4perl_path | **Optional.** Inner path for extracting a single value from a complex attribute or return value (e.g. used). 5778jmx4perl_target | **Optional.** JSR-160 Service URL specifing the target server. 5779jmx4perl_target_user | **Optional.** Username to use for JSR-160 connection. 5780jmx4perl_target_password | **Optional.** Password to use for JSR-160 connection. 5781jmx4perl_proxy | **Optional.** Proxy to use. 5782jmx4perl_user | **Optional.** User for HTTP authentication. 5783jmx4perl_password | **Optional.** Password for HTTP authentication. 5784jmx4perl_name | **Optional.** Name to use for output, by default a standard value based on the MBean and attribute will be used. 5785jmx4perl_method | **Optional.** HTTP method to use, either get or post. By default a method is determined automatically based on the request type. 5786jmx4perl_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. 5787jmx4perl_base_mbean | **Optional.** Base MBean name, interprets critical and warning values as relative in the range 0 .. 100%. Requires "jmx4perl_base_attribute". 5788jmx4perl_base_attribute | **Optional.** Base attribute for a relative check. Requires "jmx4perl_base_mbean". 5789jmx4perl_base_path | **Optional.** Base path for relative checks, where this path is used on the base attribute's value. 5790jmx4perl_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. 5791jmx4perl_null | **Optional.** Value which should be used in case of a null return value of an operation or attribute. Defaults to null. 5792jmx4perl_string | **Optional.** Force string comparison for critical and warning checks. Defaults to false. 5793jmx4perl_numeric | **Optional.** Force numeric comparison for critical and warning checks. Defaults to false. 5794jmx4perl_critical | **Optional.** Critical threshold for value. 5795jmx4perl_warning | **Optional.** Warning threshold for value. 5796jmx4perl_label | **Optional.** Label to be used for printing out the result of the check. For placeholders which can be used see the documentation. 5797jmx4perl_perfdata | **Optional.** Whether performance data should be omitted, which are included by default. Defaults to "on" for numeric values, to "off" for strings. 5798jmx4perl_unknown_is_critical | **Optional.** Map UNKNOWN errors to errors with a CRITICAL status. Defaults to false. 5799jmx4perl_timeout | **Optional.** Seconds before plugin times out. Defaults to "15". 5800jmx4perl_config | **Optional.** Path to configuration file. 5801jmx4perl_server | **Optional.** Symbolic name of server url to use, which needs to be configured in the configuration file. 5802jmx4perl_check | **Optional.** Name of a check configuration as defined in the configuration file, use array if you need arguments. 5803 5804 5805#### kdc <a id="plugin-contrib-command-kdc"></a> 5806 5807The [check_kdc](https://exchange.nagios.org/directory/Plugins/Security/check_kdc/details) plugin 5808uses the Kerberos `kinit` binary to monitor Kerberos 5 KDC by acquiring a ticket. 5809 5810Custom variables passed as [command parameters](03-monitoring-basics.md#command-passing-parameters): 5811 5812Name | Description 5813----------------|-------------------------------------------------------------------------- 5814kdc_address | **Optional.** The host's address. Defaults to "$address$" if the host's `address` attribute is set, `address6` otherwise. 5815kdc_port | **Optional** Port on which KDC runs (default 88). 5816kdc_principal | **Required** Principal name to authenticate as (including realm). 5817kdc_keytab | **Required** Keytab file containing principal's key. 5818 5819 5820#### nginx_status <a id="plugin-contrib-command-nginx_status"></a> 5821 5822The [check_nginx_status.pl](https://github.com/regilero/check_nginx_status) plugin 5823uses the [/nginx_status](https://nginx.org/en/docs/http/ngx_http_stub_status_module.html) 5824HTTP endpoint which provides metrics for monitoring Nginx. 5825 5826Custom variables passed as [command parameters](03-monitoring-basics.md#command-passing-parameters): 5827 5828Name | Description 5829--------------------------------|---------------------------------------------------------------------------------- 5830nginx_status_host_address | **Optional.** The host's address. Defaults to "$address$" if the host's `address` attribute is set, `address6` otherwise. 5831nginx_status_port | **Optional.** the http port. 5832nginx_status_url | **Optional.** URL to use, instead of the default (http://`nginx_status_hostname`/nginx_status). 5833nginx_status_servername | **Optional.** ServerName to use if you specified an IP to match the good Virtualhost in your target. 5834nginx_status_ssl | **Optional.** set to use ssl connection. 5835nginx_status_disable_sslverify | **Optional.** set to disable SSL hostname verification. 5836nginx_status_user | **Optional.** Username for basic auth. 5837nginx_status_pass | **Optional.** Password for basic auth. 5838nginx_status_realm | **Optional.** Realm for basic auth. 5839nginx_status_maxreach | **Optional.** Number of max processes reached (since last check) that should trigger an alert. 5840nginx_status_timeout | **Optional.** timeout in seconds. 5841nginx_status_warn | **Optional.** Warning threshold (number of active connections, ReqPerSec or ConnPerSec that will cause a WARNING) like '10000,100,200'. 5842nginx_status_critical | **Optional.** Critical threshold (number of active connections, ReqPerSec or ConnPerSec that will cause a CRITICAL) like '20000,200,300'. 5843 5844 5845#### rbl <a id="plugin-contrib-command-rbl"></a> 5846 5847The [check_rbl](https://github.com/matteocorti/check_rbl) plugin 5848uses the `Net::DNS` Perl library to check whether your SMTP server 5849is blacklisted. 5850 5851Custom variables passed as [command parameters](03-monitoring-basics.md#command-passing-parameters): 5852 5853Name | Description 5854----------------|-------------------------------------------------------------------------- 5855rbl_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. 5856rbl_server | **Required** List of RBL servers as an array. 5857rbl_warning | **Optional** Number of blacklisting servers for a warning. 5858rbl_critical | **Optional** Number of blacklisting servers for a critical. 5859rbl_timeout | **Optional** Seconds before plugin times out (default: 15). 5860 5861 5862#### squid <a id="plugin-contrib-command-squid"></a> 5863 5864The [check_squid](https://exchange.icinga.com/exchange/check_squid) plugin 5865uses the `squidclient` binary to monitor a [Squid proxy](http://www.squid-cache.org). 5866 5867Custom variables passed as [command parameters](03-monitoring-basics.md#command-passing-parameters): 5868 5869Name | Description 5870------------------------|---------------------------------------------------------------------------------- 5871squid_hostname | **Optional.** The host's address. Defaults to "$address$" if the host's `address` attribute is set, "$address6$" otherwise. 5872squid_data | **Optional.** Data to fetch (default: Connections) available data: Connections Cache Resources Memory FileDescriptors. 5873squid_port | **Optional.** Port number (default: 3128). 5874squid_user | **Optional.** WWW user. 5875squid_password | **Optional.** WWW password. 5876squid_warning | **Optional.** Warning threshold. See http://nagiosplug.sourceforge.net/developer-guidelines.html#THRESHOLDFORMAT for the threshold format. 5877squid_critical | **Optional.** Critical threshold. See http://nagiosplug.sourceforge.net/developer-guidelines.html#THRESHOLDFORMAT for the threshold format. 5878squid_client | **Optional.** Path of squidclient (default: /usr/bin/squidclient). 5879squid_timeout | **Optional.** Seconds before plugin times out (default: 15). 5880 5881 5882#### webinject <a id="plugin-contrib-command-webinject"></a> 5883 5884The [check_webinject](https://labs.consol.de/de/nagios/check_webinject/index.html) plugin 5885uses [WebInject](http://www.webinject.org/manual.html) to test web applications 5886and web services in an automated fashion. 5887It can be used to test individual system components that have HTTP interfaces 5888(JSP, ASP, CGI, PHP, AJAX, Servlets, HTML Forms, XML/SOAP Web Services, REST, etc), 5889and can be used as a test harness to create a suite of HTTP level automated functional, 5890acceptance, and regression tests. A test harness allows you to run many test cases 5891and collect/report your results. WebInject offers real-time results 5892display and may also be used for monitoring system response times. 5893 5894Custom variables passed as [command parameters](03-monitoring-basics.md#command-passing-parameters): 5895 5896Name | Description 5897------------------------|-------------- 5898webinject_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. 5899webinject_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. 5900webinject_no_output | **Optional.** Suppresses all output to STDOUT except the results summary. 5901webinject_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. 5902webinject_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. 5903webinject_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. 5904 5905#### varnish <a id="plugin-contrib-command-varnish"></a> 5906 5907The [check_varnish](https://github.com/varnish/varnish-nagios) plugin, 5908also available in the [monitoring-plugins-contrib](https://packages.debian.org/sid/nagios-plugins-contrib) on debian, 5909uses the `varnishstat` binary to monitor [varnish](https://varnish-cache.org/). 5910 5911Custom variables passed as [command parameters](03-monitoring-basics.md#command-passing-parameters): 5912 5913Name | Description 5914------------------------|---------------------------------------------------------------------------------- 5915varnish_name | **Optional.** Specify the Varnish instance name 5916varnish_param | **Optional.** Specify the parameter to check (see below). The default is 'ratio'. 5917varnish_critical | **Optional.** Set critical threshold: [@][lo:]hi 5918varnish_warning | **Optional.** Set warning threshold: [@][lo:]hi 5919 5920For *varnish_param*, all items reported by varnishstat(1) are available - use the 5921identifier listed in the left column by `varnishstat -l`. In 5922addition, the following parameters are available: 5923 5924Name | Description 5925------------------------|---------------------------------------------------------------------------------- 5926uptime | How long the cache has been running (in seconds) 5927ratio | The cache hit ratio expressed as a percentage of hits to hits + misses. Default thresholds are 95 and 90. 5928usage | Cache file usage as a percentage of the total cache space. 5929 5930#### haproxy <a id="plugin-contrib-command-haproxy"></a> 5931 5932The [check_haproxy](https://salsa.debian.org/nagios-team/pkg-nagios-plugins-contrib/blob/master/check_haproxy/check_haproxy) plugin, 5933also available in the [monitoring-plugins-contrib](https://packages.debian.org/nagios-plugins-contrib) on debian, 5934uses the `haproxy` csv statistics page to monitor [haproxy](https://www.haproxy.org/) response time. The plugin output performance data for backends sessions and statistics response time. 5935 5936This plugin need to access the csv statistics page. You can configure it in haproxy by adding a new frontend: 5937``` 5938frontend stats 5939 bind 127.0.0.1:80 5940 stats enablestats 5941 stats uri /stats 5942``` 5943 5944The statistics page will be available at `http://127.0.0.1/stats;csv;norefresh`. 5945 5946Custom variables passed as [command parameters](03-monitoring-basics.md#command-passing-parameters): 5947 5948Name | Description 5949------------------------|---------------------------------------------------------------------------------- 5950haproxy_username | **Optional.** Username for HTTP Auth 5951haproxy_password | **Optional.** Password for HTTP Auth 5952haproxy_url | **Required.** URL of the HAProxy csv statistics page. 5953haproxy_timeout | **Optional.** Seconds before plugin times out (default: 10) 5954haproxy_warning | **Optional.** Warning request time threshold (in seconds) 5955haproxy_critical | **Optional.** Critical request time threshold (in seconds) 5956 5957#### haproxy_status <a id="plugin-contrib-command-haproxy_status"></a> 5958 5959The [check_haproxy_status](https://github.com/jonathanio/monitoring-nagios-haproxy) plugin, 5960uses the `haproxy` statistics socket to monitor [haproxy](https://www.haproxy.org/) frontends/backends. 5961 5962This 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: 5963``` 5964stats socket /run/haproxy/admin.sock user haproxy group icinga mode 660 level operator 5965``` 5966 5967Custom variables passed as [command parameters](03-monitoring-basics.md#command-passing-parameters): 5968 5969Name | Description 5970----------------------------|---------------------------------------------------------------------------------- 5971haproxy\_status\_default | **Optional.** Set/Override the defaults which will be applied to all checks (unless specifically set by --overrides). 5972haproxy\_status\_frontends | **Optional.** Enable checks for the frontends in HAProxy (that they're marked as OPEN and the session limits haven't been reached). 5973haproxy\_status\_nofrontends| **Optional.** Disable checks for the frontends in HAProxy (that they're marked as OPEN and the session limits haven't been reached). 5974haproxy\_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). 5975haproxy\_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). 5976haproxy\_status\_servers | **Optional.** Enable checks for the servers in HAProxy (that they haven't reached the limits for the sessions or for queues). 5977haproxy\_status\_noservers | **Optional.** Disable checks for the servers in HAProxy (that they haven't reached the limits for the sessions or for queues). 5978haproxy\_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. 5979haproxy\_status\_socket | **Required.** Path to the socket check_haproxy should connect to 5980 5981#### phpfpm_status <a id="plugin-contrib-command-phpfpm_status"></a> 5982 5983The [check_phpfpm_status](https://github.com/regilero/check_phpfpm_status) plugin, 5984uses the `php-fpm` status page to monitor php-fpm. 5985 5986Custom variables passed as [command parameters](03-monitoring-basics.md#command-passing-parameters): 5987 5988Name | Description 5989--------------------------|---------------------------------------------------------------------------------- 5990phpfpm\_status\_hostname | **Required.** name or IP address of host to check 5991phpfpm\_status\_port | **Optional.** Http port, or Fastcgi port when using --fastcgi 5992phpfpm\_status\_url | **Optional.** Specific URL (only the path part of it in fact) to use, instead of the default /fpm-status 5993phpfpm\_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 5994phpfpm\_status\_fastcgi | **Optional.** If set, connect directly to php-fpm via network or local socket, using fastcgi protocol instead of HTTP. 5995phpfpm\_status\_user | **Optional.** Username for basic auth 5996phpfpm\_status\_pass | **Optional.** Password for basic auth 5997phpfpm\_status\_realm | **Optional.** Realm for basic auth 5998phpfpm\_status\_debug | **Optional.** If set, debug mode (show http request response) 5999phpfpm\_status\_timeout | **Optional.** timeout in seconds (Default: 15) 6000phpfpm\_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). 6001phpfpm\_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. 6002phpfpm\_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. 6003phpfpm\_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 6004phpfpm\_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 6005