1 # Icinga Template Library <a id="icinga-template-library"></a>
3 The Icinga Template Library (ITL) implements standard templates
4 and object definitions.
6 There is a subset of templates and object definitions available:
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)
17 The ITL content is updated with new releases. Please do not modify
18 templates and/or objects as changes will be overridden without
21 You are advised to create your own CheckCommand definitions in
24 ## Generic Templates <a id="itl-generic-templates"></a>
26 By default the generic templates are included in the [icinga2.conf](04-configuration.md#icinga2-conf) configuration file:
32 These templates are imported by the provided example configuration.
36 > These templates are built into the binaries. By convention
37 > all command and timeperiod objects should import these templates.
39 ### plugin-check-command <a id="itl-plugin-check-command"></a>
41 Command template for check plugins executed by Icinga 2.
43 The `plugin-check-command` command does not support any vars.
45 By default this template is automatically imported into all [CheckCommand](09-object-types.md#objecttype-checkcommand) definitions.
47 ### plugin-notification-command <a id="itl-plugin-notification-command"></a>
49 Command template for notification scripts executed by Icinga 2.
51 The `plugin-notification-command` command does not support any vars.
53 By default this template is automatically imported into all [NotificationCommand](09-object-types.md#objecttype-notificationcommand) definitions.
55 ### plugin-event-command <a id="itl-plugin-event-command"></a>
57 Command template for event handler scripts executed by Icinga 2.
59 The `plugin-event-command` command does not support any vars.
61 By default this template is automatically imported into all [EventCommand](09-object-types.md#objecttype-eventcommand) definitions.
63 ### legacy-timeperiod <a id="itl-legacy-timeperiod"></a>
65 Timeperiod template for [Timeperiod objects](09-object-types.md#objecttype-timeperiod).
67 The `legacy-timeperiod` timeperiod does not support any vars.
69 By default this template is automatically imported into all [TimePeriod](09-object-types.md#objecttype-timeperiod) definitions.
71 ## Check Commands <a id="itl-check-commands"></a>
73 These check commands are embedded into Icinga 2 and do not require any external
76 ### icinga <a id="itl-icinga"></a>
78 Check command for the built-in `icinga` check. This check returns performance
79 data for the current Icinga instance and optionally allows for minimum version checks.
81 Custom variables passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
84 -----------------------|---------------
85 icinga\_min\_version | **Optional.** Required minimum Icinga 2 version, e.g. `2.8.0`. If not satisfied, the state changes to `Critical`. Release packages only.
87 ### cluster <a id="itl-icinga-cluster"></a>
89 Check command for the built-in `cluster` check. This check returns performance
90 data for the current Icinga instance and connected endpoints.
92 The `cluster` check command does not support any vars.
94 ### cluster-zone <a id="itl-icinga-cluster-zone"></a>
96 Check command for the built-in `cluster-zone` check.
98 Custom variables passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
101 -----------------------|---------------
102 cluster\_zone | **Required.** The zone name. Defaults to `$host.name$`.
103 cluster\_lag\_warning | **Optional.** Warning threshold for log lag in seconds. Applies if the log lag is greater than the threshold.
104 cluster\_lag\_critical | **Optional.** Critical threshold for log lag in seconds. Applies if the log lag is greater than the threshold.
106 ### ido <a id="itl-icinga-ido"></a>
108 Check command for the built-in `ido` check.
110 Custom variables passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
113 --------------------------------|-----------------------------
114 ido\_type | **Required.** The type of the IDO connection object. Can be either "IdoMysqlConnection" or "IdoPgsqlConnection".
115 ido\_name | **Required.** The name of the IDO connection object.
116 ido\_queries\_warning | **Optional.** Warning threshold for queries/s. Applies if the rate is lower than the threshold.
117 ido\_queries\_critical | **Optional.** Critical threshold for queries/s. Applies if the rate is lower than the threshold.
118 ido\_pending\_queries\_warning | **Optional.** Warning threshold for pending queries. Applies if pending queries are higher than the threshold. Supersedes the `ido_queries` thresholds above.
119 ido\_pending\_queries\_critical | **Optional.** Critical threshold for pending queries. Applies if pending queries are higher than the threshold. Supersedes the `ido_queries` thresholds above.
122 ### dummy <a id="itl-dummy"></a>
124 Check command for the built-in `dummy` check. This allows to set
125 a check result state and output and can be used in [freshness checks](08-advanced-topics.md#check-result-freshness)
126 or [runtime object checks](08-advanced-topics.md#access-object-attributes-at-runtime).
127 In contrast to the [check_dummy](https://www.monitoring-plugins.org/doc/man/check_dummy.html)
128 plugin, Icinga 2 implements a light-weight in memory check with 2.9+.
130 Custom variables passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
133 ----------------|--------------
134 dummy\_state | **Optional.** The state. Can be one of 0 (ok), 1 (warning), 2 (critical) and 3 (unknown). Defaults to 0.
135 dummy\_text | **Optional.** Plugin output. Defaults to "Check was successful.".
137 ### passive <a id="itl-check-command-passive"></a>
139 Specialised check command object for passive checks which uses the functionality of the "dummy" check command with appropriate default values.
141 Custom variables passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
144 ----------------|--------------
145 dummy_state | **Optional.** The state. Can be one of 0 (ok), 1 (warning), 2 (critical) and 3 (unknown). Defaults to 3.
146 dummy_text | **Optional.** Plugin output. Defaults to "No Passive Check Result Received.".
148 ### random <a id="itl-random"></a>
150 Check command for the built-in `random` check. This check returns random states
151 and adds the check source to the check output.
153 For test and demo purposes only. The `random` check command does not support
156 ### exception <a id="itl-exception"></a>
158 Check command for the built-in `exception` check. This check throws an exception.
160 For test and demo purposes only. The `exception` check command does not support
163 ### sleep <a id="itl-sleep"></a>
165 Check command for the built-in `sleep` check. This allows to use sleep for testing
169 ----------------|--------------
170 sleep\_time | **Optional.** The duration of the sleep in seconds. Defaults to 1s.
172 <!-- keep this anchor for URL link history only -->
173 <a id="plugin-check-commands"></a>
175 ## Plugin Check Commands for Monitoring Plugins <a id="plugin-check-commands-monitoring-plugins"></a>
177 The Plugin Check Commands provides example configuration for plugin check commands
178 provided by the [Monitoring Plugins](https://www.monitoring-plugins.org) project.
180 By default the Plugin Check Commands are included in the [icinga2.conf](04-configuration.md#icinga2-conf) configuration
185 The plugin check commands assume that there's a global constant named `PluginDir`
186 which contains the path of the plugins from the Monitoring Plugins project.
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.
194 ### apt <a id="plugin-check-command-apt"></a>
196 The plugin [apt](https://www.monitoring-plugins.org/doc/man/check_apt.html) checks for software updates on systems that use
197 package management systems based on the apt-get(8) command found in Debian based systems.
199 Custom variables passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
202 ------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
203 apt_extra_opts | **Optional.** Read options from an ini file.
204 apt_upgrade | **Optional.** [Default] Perform an upgrade. If an optional OPTS argument is provided, apt-get will be run with these command line options instead of the default.
205 apt_dist_upgrade | **Optional.** Perform a dist-upgrade instead of normal upgrade. Like with -U OPTS can be provided to override the default options.
206 apt_include | **Optional.** Include only packages matching REGEXP. Can be specified multiple times the values will be combined together.
207 apt_exclude | **Optional.** Exclude packages matching REGEXP from the list of packages that would otherwise be included. Can be specified multiple times.
208 apt_critical | **Optional.** If the full package information of any of the upgradable packages match this REGEXP, the plugin will return CRITICAL status. Can be specified multiple times.
209 apt_timeout | **Optional.** Seconds before plugin times out (default: 10).
210 apt_only_critical | **Optional.** Only warn about critical upgrades.
211 apt_list | **Optional.** List packages available for upgrade.
214 ### breeze <a id="plugin-check-command-breeze"></a>
216 The [check_breeze](https://www.monitoring-plugins.org/doc/man/check_breeze.html) plugin reports the signal
217 strength of a Breezecom wireless equipment.
219 Custom variables passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
222 -----------------|---------------------------------
223 breeze_hostname | **Required.** Name or IP address of host to check. Defaults to "$address$" if the host's `address` attribute is set, "$address6$" otherwise.
224 breeze_community | **Optional.** SNMPv1 community. Defaults to "public".
225 breeze_warning | **Required.** Percentage strength below which a WARNING status will result. Defaults to 50.
226 breeze_critical | **Required.** Percentage strength below which a WARNING status will result. Defaults to 20.
229 ### by_ssh <a id="plugin-check-command-by-ssh"></a>
231 The [check_by_ssh](https://www.monitoring-plugins.org/doc/man/check_by_ssh.html) plugin uses SSH to execute
232 commands on a remote host.
234 Custom variables passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
237 ---------------- | --------------
238 by_ssh_address | **Optional.** The host's address. Defaults to "$address$" if the host's `address` attribute is set, "$address6$" otherwise.
239 by_ssh_port | **Optional.** The SSH port. Defaults to 22.
240 by_ssh_command | **Required.** The command that should be executed. Can be an array if multiple arguments should be passed to `check_by_ssh`.
241 by_ssh_arguments | **Optional.** A dictionary with arguments for the command. This works exactly like the 'arguments' dictionary for ordinary CheckCommands.
242 by_ssh_logname | **Optional.** The SSH username.
243 by_ssh_identity | **Optional.** The SSH identity.
244 by_ssh_quiet | **Optional.** Whether to suppress SSH warnings. Defaults to false.
245 by_ssh_warn | **Optional.** The warning threshold.
246 by_ssh_crit | **Optional.** The critical threshold.
247 by_ssh_timeout | **Optional.** The timeout in seconds.
248 by_ssh_options | **Optional.** Call ssh with '-o OPTION' (multiple options may be specified as an array).
249 by_ssh_ipv4 | **Optional.** Use IPv4 connection. Defaults to false.
250 by_ssh_ipv6 | **Optional.** Use IPv6 connection. Defaults to false.
251 by_ssh_skip_stderr | **Optional.** Ignore all or (if specified) first n lines on STDERR.
254 ### clamd <a id="plugin-check-command-clamd"></a>
256 The [check_clamd](https://www.monitoring-plugins.org/doc/man/check_clamd.html) plugin tests CLAMD
257 connections with the specified host (or unix socket).
259 Custom variables passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
262 -------------------|--------------
263 clamd_address | **Required.** The host's address or unix socket (must be an absolute path).
264 clamd_port | **Optional.** Port number (default: none).
265 clamd_expect | **Optional.** String to expect in server response. Multiple strings must be defined as array.
266 clamd_all | **Optional.** All expect strings need to occur in server response. Defaults to false.
267 clamd_escape_send | **Optional.** Enable usage of \\n, \\r, \\t or \\\\ in send string.
268 clamd_send | **Optional.** String to send to the server.
269 clamd_escape_quit | **Optional.** Enable usage of \\n, \\r, \\t or \\\\ in quit string.
270 clamd_quit | **Optional.** String to send server to initiate a clean close of the connection.
271 clamd_refuse | **Optional.** Accept TCP refusals with states ok, warn, crit. Defaults to crit.
272 clamd_mismatch | **Optional.** Accept expected string mismatches with states ok, warn, crit. Defaults to warn.
273 clamd_jail | **Optional.** Hide output from TCP socket.
274 clamd_maxbytes | **Optional.** Close connection once more than this number of bytes are received.
275 clamd_delay | **Optional.** Seconds to wait between sending string and polling for response.
276 clamd_certificate | **Optional.** Minimum number of days a certificate has to be valid. 1st value is number of days for warning, 2nd is critical (if not specified: 0) -- separated by comma.
277 clamd_ssl | **Optional.** Use SSL for the connection. Defaults to false.
278 clamd_wtime | **Optional.** Response time to result in warning status (seconds).
279 clamd_ctime | **Optional.** Response time to result in critical status (seconds).
280 clamd_timeout | **Optional.** Seconds before connection times out. Defaults to 10.
281 clamd_ipv4 | **Optional.** Use IPv4 connection. Defaults to false.
282 clamd_ipv6 | **Optional.** Use IPv6 connection. Defaults to false.
285 ### dhcp <a id="plugin-check-command-dhcp"></a>
287 The [check_dhcp](https://www.monitoring-plugins.org/doc/man/check_dhcp.html) plugin
288 tests the availability of DHCP servers on a network.
290 Custom variables passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
293 ----------------|--------------
294 dhcp_serverip | **Optional.** The IP address of the DHCP server which we should get a response from.
295 dhcp_requestedip| **Optional.** The IP address which we should be offered by a DHCP server.
296 dhcp_timeout | **Optional.** The timeout in seconds.
297 dhcp_interface | **Optional.** The interface to use.
298 dhcp_mac | **Optional.** The MAC address to use in the DHCP request.
299 dhcp_unicast | **Optional.** Whether to use unicast requests. Defaults to false.
302 ### dig <a id="plugin-check-command-dig"></a>
304 The [check_dig](https://www.monitoring-plugins.org/doc/man/check_dig.html) plugin
305 test the DNS service on the specified host using dig.
307 Custom variables passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
310 ---------------------|--------------
311 dig_server | **Optional.** The DNS server to query. Defaults to "127.0.0.1".
312 dig_port | **Optional.** Port number (default: 53).
313 dig_lookup | **Required.** The address that should be looked up.
314 dig_record_type | **Optional.** Record type to lookup (default: A).
315 dig_expected_address | **Optional.** An address expected to be in the answer section. If not set, uses whatever was in -l.
316 dig_arguments | **Optional.** Pass STRING as argument(s) to dig.
317 dig_retries | **Optional.** Number of retries passed to dig, timeout is divided by this value (Default: 3).
318 dig_warning | **Optional.** Response time to result in warning status (seconds).
319 dig_critical | **Optional.** Response time to result in critical status (seconds).
320 dig_timeout | **Optional.** Seconds before connection times out (default: 10).
321 dig_ipv4 | **Optional.** Force dig to only use IPv4 query transport. Defaults to false.
322 dig_ipv6 | **Optional.** Force dig to only use IPv6 query transport. Defaults to false.
325 ### disk <a id="plugin-check-command-disk"></a>
327 The [check_disk](https://www.monitoring-plugins.org/doc/man/check_disk.html) plugin
328 checks the amount of used disk space on a mounted file system and generates an alert
329 if free space is less than one of the threshold values.
331 Custom variables passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
334 --------------------|------------------------
335 disk\_wfree | **Optional.** The free space warning threshold. Defaults to "20%". If the percent sign is omitted, units from `disk_units` are used.
336 disk\_cfree | **Optional.** The free space critical threshold. Defaults to "10%". If the percent sign is omitted, units from `disk_units` are used.
337 disk\_inode\_wfree | **Optional.** The free inode warning threshold.
338 disk\_inode\_cfree | **Optional.** The free inode critical threshold.
339 disk\_partition | **Optional.** The partition. **Deprecated in 2.3.**
340 disk\_partition\_excluded | **Optional.** The excluded partition. **Deprecated in 2.3.**
341 disk\_partitions | **Optional.** The partition(s). Multiple partitions must be defined as array.
342 disk\_partitions\_excluded | **Optional.** The excluded partition(s). Multiple partitions must be defined as array.
343 disk\_clear | **Optional.** Clear thresholds. May be true or false.
344 disk\_exact\_match | **Optional.** For paths or partitions specified with -p, only check for exact paths. May be true or false.
345 disk\_errors\_only | **Optional.** Display only devices/mountpoints with errors. May be true or false.
346 disk\_ignore\_reserved | **Optional.** If set, account root-reserved blocks are not accounted for freespace in perfdata. May be true or false.
347 disk\_group | **Optional.** Group paths. Thresholds apply to (free-)space of all partitions together.
348 disk\_kilobytes | **Optional.** Same as --units kB. May be true or false.
349 disk\_local | **Optional.** Only check local filesystems. May be true or false.
350 disk\_stat\_remote\_fs | **Optional.** Only check local filesystems against thresholds. Yet call stat on remote filesystems to test if they are accessible (e.g. to detect Stale NFS Handles). May be true or false.
351 disk\_mountpoint | **Optional.** Display the mountpoint instead of the partition. May be true or false.
352 disk\_megabytes | **Optional.** Same as --units MB. May be true or false.
353 disk\_all | **Optional.** Explicitly select all paths. This is equivalent to -R '.\*'. May be true or false.
354 disk\_eregi\_path | **Optional.** Case insensitive regular expression for path/partition. Multiple regular expression strings must be defined as array.
355 disk\_ereg\_path | **Optional.** Regular expression for path or partition. Multiple regular expression strings must be defined as array.
356 disk\_ignore\_eregi\_path | **Optional.** Regular expression to ignore selected path/partition (case insensitive). Multiple regular expression strings must be defined as array.
357 disk\_ignore\_ereg\_path | **Optional.** Regular expression to ignore selected path or partition. Multiple regular expression strings must be defined as array.
358 disk\_timeout | **Optional.** Seconds before connection times out (default: 10).
359 disk\_units | **Optional.** Choose bytes, kB, MB, GB, TB (default: MB).
360 disk\_exclude\_type | **Optional.** Ignore all filesystems of indicated type. Multiple regular expression strings must be defined as array. Defaults to "none", "tmpfs", "sysfs", "proc", "configfs", "devtmpfs", "devfs", "mtmfs", "tracefs", "cgroup", "fuse.gvfsd-fuse", "fuse.gvfs-fuse-daemon", "fdescfs", "overlay", "nsfs", "squashfs".
361 disk\_include\_type | **Optional.** Check only filesystems of indicated type. Multiple regular expression strings must be defined as array.
363 ### disk_smb <a id="plugin-check-command-disk-smb"></a>
365 The [check_disk_smb](https://www.monitoring-plugins.org/doc/man/check_disk_smb.html) plugin
366 uses the `smbclient` binary to check SMB shares.
368 Custom variables passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
371 ------------------------|------------------------
372 disk_smb_hostname | **Required.** NetBIOS name of the server.
373 disk_smb_share | **Required.** Share name being queried.
374 disk_smb_workgroup | **Optional.** Workgroup or Domain used (defaults to 'WORKGROUP' if omitted).
375 disk_smb_address | **Optional.** IP address of the host (only necessary if host belongs to another network).
376 disk_smb_username | **Optional.** Username for server log-in (defaults to 'guest' if omitted).
377 disk_smb_password | **Optional.** Password for server log-in (defaults to an empty password if omitted).
378 disk_smb_wused | **Optional.** The used space warning threshold. Defaults to "85%". If the percent sign is omitted, use optional disk units.
379 disk_smb_cused | **Optional.** The used space critical threshold. Defaults to "95%". If the percent sign is omitted, use optional disk units.
380 disk_smb_port | **Optional.** Connection port, e.g. `139` or `445`. Defaults to `smbclient` default if omitted.
382 ### dns <a id="plugin-check-command-dns"></a>
384 The [check_dns](https://www.monitoring-plugins.org/doc/man/check_dns.html) plugin
385 uses the nslookup program to obtain the IP address for the given host/domain query.
386 An optional DNS server to use may be specified. If no DNS server is specified, the
387 default server(s) specified in `/etc/resolv.conf` will be used.
389 Custom variables passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
392 ---------------------|--------------
393 dns_lookup | **Optional.** The hostname or IP to query the DNS for. Defaults to "$host_name$".
394 dns_server | **Optional.** The DNS server to query. Defaults to the server configured in the OS.
395 dns_query_type | **Optional.** The DNS record query type where TYPE =(A, AAAA, SRV, TXT, MX, ANY). The default query type is 'A' (IPv4 host entry)
396 dns_expected_answers | **Optional.** The answer(s) to look for. A hostname must end with a dot. Multiple answers must be defined as array.
397 dns_authoritative | **Optional.** Expect the server to send an authoritative answer.
398 dns_accept_cname | **Optional.** Accept cname responses as a valid result to a query.
399 dns_wtime | **Optional.** Return warning if elapsed time exceeds value.
400 dns_ctime | **Optional.** Return critical if elapsed time exceeds value.
401 dns_timeout | **Optional.** Seconds before connection times out. Defaults to 10.
405 ### file_age <a id="plugin-check-command-file-age"></a>
407 The [check_file_age](https://www.monitoring-plugins.org/doc/man/check_file_age.html) plugin
408 checks a file's size and modification time to make sure it's not empty and that it's sufficiently recent.
410 Custom variables passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
413 -----------------------|--------------------------------------------------------------------------------------------------------
414 file_age_file | **Required.** File to monitor.
415 file_age_warning_time | **Optional.** File must be no more than this many seconds old as warning threshold. Defaults to "240s".
416 file_age_critical_time | **Optional.** File must be no more than this many seconds old as critical threshold. Defaults to "600s".
417 file_age_warning_size | **Optional.** File must be at least this many bytes long as warning threshold. No default given.
418 file_age_critical_size | **Optional.** File must be at least this many bytes long as critical threshold. Defaults to "0B".
419 file_age_ignoremissing | **Optional.** Return OK if the file does not exist. Defaults to false.
422 ### flexlm <a id="plugin-check-command-flexlm"></a>
424 The [check_flexlm](https://www.monitoring-plugins.org/doc/man/check_flexlm.html) plugin
425 checks available flexlm license managers. Requires the `lmstat` command.
427 Custom variables passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
430 -------------------|----------------------------------------------------------
431 flexlm_licensefile | **Required.** Name of license file (usually license.dat).
432 flexlm_timeout | **Optional.** Plugin time out in seconds. Defaults to 15.
435 ### fping4 <a id="plugin-check-command-fping4"></a>
437 The [check_fping](https://www.monitoring-plugins.org/doc/man/check_fping.html) plugin
438 uses the `fping` command to ping the specified host for a fast check. Note that it is
439 necessary to set the `suid` flag on `fping`.
441 This CheckCommand expects an IPv4 address.
443 Custom variables passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
446 ----------------|--------------
447 fping_address | **Optional.** The host's IPv4 address. Defaults to "$address$".
448 fping_wrta | **Optional.** The RTA warning threshold in milliseconds. Defaults to 100.
449 fping_wpl | **Optional.** The packet loss warning threshold in %. Defaults to 5.
450 fping_crta | **Optional.** The RTA critical threshold in milliseconds. Defaults to 200.
451 fping_cpl | **Optional.** The packet loss critical threshold in %. Defaults to 15.
452 fping_number | **Optional.** The number of packets to send. Defaults to 5.
453 fping_interval | **Optional.** The interval between packets in milli-seconds. Defaults to 500.
454 fping_bytes | **Optional.** The size of ICMP packet.
455 fping_target_timeout | **Optional.** The target timeout in milli-seconds.
456 fping_source_ip | **Optional.** The name or ip address of the source ip.
457 fping_source_interface | **Optional.** The source interface name.
460 ### fping6 <a id="plugin-check-command-fping6"></a>
462 The [check_fping](https://www.monitoring-plugins.org/doc/man/check_fping.html) plugin
463 will use the `fping` command to ping the specified host for a fast check. Note that it is
464 necessary to set the `suid` flag on `fping`.
466 This CheckCommand expects an IPv6 address.
468 Custom variables passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
471 ----------------|--------------
472 fping_address | **Optional.** The host's IPv6 address. Defaults to "$address6$".
473 fping_wrta | **Optional.** The RTA warning threshold in milliseconds. Defaults to 100.
474 fping_wpl | **Optional.** The packet loss warning threshold in %. Defaults to 5.
475 fping_crta | **Optional.** The RTA critical threshold in milliseconds. Defaults to 200.
476 fping_cpl | **Optional.** The packet loss critical threshold in %. Defaults to 15.
477 fping_number | **Optional.** The number of packets to send. Defaults to 5.
478 fping_interval | **Optional.** The interval between packets in milli-seconds. Defaults to 500.
479 fping_bytes | **Optional.** The size of ICMP packet.
480 fping_target_timeout | **Optional.** The target timeout in milli-seconds.
481 fping_source_ip | **Optional.** The name or ip address of the source ip.
482 fping_source_interface | **Optional.** The source interface name.
485 ### ftp <a id="plugin-check-command-ftp"></a>
487 The [check_ftp](https://www.monitoring-plugins.org/doc/man/check_ftp.html) plugin
488 tests FTP connections with the specified host (or unix socket).
490 Custom variables passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
493 -------------------|--------------
494 ftp_address | **Optional.** The host's address. Defaults to "$address$" if the host's `address` attribute is set, "$address6$" otherwise.
495 ftp_port | **Optional.** The FTP port number.
496 ftp_expect | **Optional.** String to expect in server response. Multiple strings must be defined as array.
497 ftp_all | **Optional.** All expect strings need to occur in server response. Defaults to false.
498 ftp_escape_send | **Optional.** Enable usage of \\n, \\r, \\t or \\\\ in send string.
499 ftp_send | **Optional.** String to send to the server.
500 ftp_escape_quit | **Optional.** Enable usage of \\n, \\r, \\t or \\\\ in quit string.
501 ftp_quit | **Optional.** String to send server to initiate a clean close of the connection.
502 ftp_refuse | **Optional.** Accept TCP refusals with states ok, warn, crit. Defaults to crit.
503 ftp_mismatch | **Optional.** Accept expected string mismatches with states ok, warn, crit. Defaults to warn.
504 ftp_jail | **Optional.** Hide output from TCP socket.
505 ftp_maxbytes | **Optional.** Close connection once more than this number of bytes are received.
506 ftp_delay | **Optional.** Seconds to wait between sending string and polling for response.
507 ftp_certificate | **Optional.** Minimum number of days a certificate has to be valid. 1st value is number of days for warning, 2nd is critical (if not specified: 0) -- separated by comma.
508 ftp_ssl | **Optional.** Use SSL for the connection. Defaults to false.
509 ftp_wtime | **Optional.** Response time to result in warning status (seconds).
510 ftp_ctime | **Optional.** Response time to result in critical status (seconds).
511 ftp_timeout | **Optional.** Seconds before connection times out. Defaults to 10.
512 ftp_ipv4 | **Optional.** Use IPv4 connection. Defaults to false.
513 ftp_ipv6 | **Optional.** Use IPv6 connection. Defaults to false.
516 ### game <a id="plugin-check-command-game"></a>
518 The [check_game](https://www.monitoring-plugins.org/doc/man/check_game.html) plugin
519 tests game server connections with the specified host.
520 This plugin uses the 'qstat' command, the popular game server status query tool.
521 If you don't have the package installed, you will need to [download](http://www.activesw.com/people/steve/qstat.html)
522 or install the package `quakestat` before you can use this plugin.
524 Custom variables passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
527 -------------------|-------------------
528 game_game | **Required.** Name of the game.
529 game_ipaddress | **Required.** Ipaddress of the game server to query.
530 game_timeout | **Optional.** Seconds before connection times out. Defaults to 10.
531 game_port | **Optional.** Port to connect to.
532 game_gamefield | **Optional.** Field number in raw qstat output that contains game name.
533 game_mapfield | **Optional.** Field number in raw qstat output that contains map name.
534 game_pingfield | **Optional.** Field number in raw qstat output that contains ping time.
535 game_gametime | **Optional.** Field number in raw qstat output that contains game time.
536 game_hostname | **Optional.** Name of the host running the game.
539 ### hostalive <a id="plugin-check-command-hostalive"></a>
541 Check command object for the [check_ping](https://www.monitoring-plugins.org/doc/man/check_ping.html)
542 plugin with host check default values. This variant uses the host's `address` attribute
543 if available and falls back to using the `address6` attribute if the `address` attribute is not set.
545 Custom variables passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
548 ----------------|--------------
549 ping_address | **Optional.** The host's address. Defaults to "$address$" if the host's `address` attribute is set, "$address6$" otherwise.
550 ping_wrta | **Optional.** The RTA warning threshold in milliseconds. Defaults to 3000.
551 ping_wpl | **Optional.** The packet loss warning threshold in %. Defaults to 80.
552 ping_crta | **Optional.** The RTA critical threshold in milliseconds. Defaults to 5000.
553 ping_cpl | **Optional.** The packet loss critical threshold in %. Defaults to 100.
554 ping_packets | **Optional.** The number of packets to send. Defaults to 5.
555 ping_timeout | **Optional.** The plugin timeout in seconds. Defaults to 0 (no timeout).
558 ### hostalive4 <a id="plugin-check-command-hostalive4"></a>
560 Check command object for the [check_ping](https://www.monitoring-plugins.org/doc/man/check_ping.html)
561 plugin with host check default values. This variant uses the host's `address` attribute.
563 Custom variables passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
566 ----------------|--------------
567 ping_address | **Optional.** The host's IPv4 address. Defaults to "$address$".
568 ping_wrta | **Optional.** The RTA warning threshold in milliseconds. Defaults to 3000.
569 ping_wpl | **Optional.** The packet loss warning threshold in %. Defaults to 80.
570 ping_crta | **Optional.** The RTA critical threshold in milliseconds. Defaults to 5000.
571 ping_cpl | **Optional.** The packet loss critical threshold in %. Defaults to 100.
572 ping_packets | **Optional.** The number of packets to send. Defaults to 5.
573 ping_timeout | **Optional.** The plugin timeout in seconds. Defaults to 0 (no timeout).
576 ### hostalive6 <a id="plugin-check-command-hostalive6"></a>
578 Check command object for the [check_ping](https://www.monitoring-plugins.org/doc/man/check_ping.html)
579 plugin with host check default values. This variant uses the host's `address6` attribute.
581 Custom variables passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
584 ----------------|--------------
585 ping_address | **Optional.** The host's IPv6 address. Defaults to "$address6$".
586 ping_wrta | **Optional.** The RTA warning threshold in milliseconds. Defaults to 3000.
587 ping_wpl | **Optional.** The packet loss warning threshold in %. Defaults to 80.
588 ping_crta | **Optional.** The RTA critical threshold in milliseconds. Defaults to 5000.
589 ping_cpl | **Optional.** The packet loss critical threshold in %. Defaults to 100.
590 ping_packets | **Optional.** The number of packets to send. Defaults to 5.
591 ping_timeout | **Optional.** The plugin timeout in seconds. Defaults to 0 (no timeout).
594 ### hpjd <a id="plugin-check-command-hpjd"></a>
596 The [check_hpjd](https://www.monitoring-plugins.org/doc/man/check_hpjd.html) plugin
597 tests the state of an HP printer with a JetDirect card. Net-snmp must be installed
598 on the computer running the plugin.
600 Custom variables passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
603 ----------------|--------------
604 hpjd_address | **Optional.** The host's address. Defaults to "$address$" if the host's `address` attribute is set, "$address6$" otherwise.
605 hpjd_port | **Optional.** The host's SNMP port. Defaults to 161.
606 hpjd_community | **Optional.** The SNMP community. Defaults to "public".
609 ### http <a id="plugin-check-command-http"></a>
611 The [check_http](https://www.monitoring-plugins.org/doc/man/check_http.html) plugin
612 tests the HTTP service on the specified host. It can test normal (http) and secure
613 (https) servers, follow redirects, search for strings and regular expressions,
614 check connection times, and report on certificate expiration times.
616 The plugin can either test the HTTP response of a server, or if `http_certificate` is set to a non-empty value, the TLS certificate age for a HTTPS host.
618 Custom variables passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
621 ---------------------------------|---------------------------------
622 http_address | **Optional.** The host's address. Defaults to "$address$" if the host's `address` attribute is set, "$address6$" otherwise.
623 http_vhost | **Optional.** The virtual host that should be sent in the "Host" header.
624 http_uri | **Optional.** The request URI for GET or POST. Defaults to `/`.
625 http_port | **Optional.** The TCP port. Defaults to 80 when not using SSL, 443 otherwise.
626 http_ssl | **Optional.** Whether to use SSL. Defaults to false.
627 http_ssl_force_tlsv1 | **Optional.** Whether to force TLSv1.
628 http_ssl_force_tlsv1_1 | **Optional.** Whether to force TLSv1.1.
629 http_ssl_force_tlsv1_2 | **Optional.** Whether to force TLSv1.2.
630 http_ssl_force_sslv2 | **Optional.** Whether to force SSLv2.
631 http_ssl_force_sslv3 | **Optional.** Whether to force SSLv3.
632 http_ssl_force_tlsv1_or_higher | **Optional.** Whether to force TLSv1 or higher.
633 http_ssl_force_tlsv1_1_or_higher | **Optional.** Whether to force TLSv1.1 or higher.
634 http_ssl_force_tlsv1_2_or_higher | **Optional.** Whether to force TLSv1.2 or higher.
635 http_ssl_force_sslv2_or_higher | **Optional.** Whether to force SSLv2 or higher.
636 http_ssl_force_sslv3_or_higher | **Optional.** Whether to force SSLv3 or higher.
637 http_sni | **Optional.** Whether to use SNI. Defaults to false.
638 http_auth_pair | **Optional.** Add 'username:password' authorization pair.
639 http_proxy_auth_pair | **Optional.** Add 'username:password' authorization pair for proxy.
640 http_ignore_body | **Optional.** Don't download the body, just the headers.
641 http_linespan | **Optional.** Allow regex to span newline.
642 http_expect_body_regex | **Optional.** A regular expression which the body must match against. Incompatible with http_ignore_body.
643 http_expect_body_eregi | **Optional.** A case-insensitive expression which the body must match against. Incompatible with http_ignore_body.
644 http_invertregex | **Optional.** Changes behavior of http_expect_body_regex and http_expect_body_eregi to return CRITICAL if found, OK if not.
645 http_warn_time | **Optional.** The warning threshold.
646 http_critical_time | **Optional.** The critical threshold.
647 http_expect | **Optional.** Comma-delimited list of strings, at least one of them is expected in the first (status) line of the server response. Default: HTTP/1.
648 http_certificate | **Optional.** Minimum number of days a certificate has to be valid. Port defaults to 443. When this option is used the URL is not checked. The first parameter defines the warning threshold (in days), the second parameter the critical threshold (in days). (Example `http_certificate = "30,20"`).
649 http_clientcert | **Optional.** Name of file contains the client certificate (PEM format).
650 http_privatekey | **Optional.** Name of file contains the private key (PEM format).
651 http_headerstring | **Optional.** String to expect in the response headers.
652 http_string | **Optional.** String to expect in the content.
653 http_post | **Optional.** URL encoded http POST data.
654 http_method | **Optional.** Set http method (for example: HEAD, OPTIONS, TRACE, PUT, DELETE).
655 http_maxage | **Optional.** Warn if document is more than seconds old.
656 http_contenttype | **Optional.** Specify Content-Type header when POSTing.
657 http_useragent | **Optional.** String to be sent in http header as User Agent.
658 http_header | **Optional.** Any other tags to be sent in http header.
659 http_extendedperfdata | **Optional.** Print additional perfdata. Defaults to false.
660 http_onredirect | **Optional.** How to handle redirect pages. Possible values: "ok" (default), "warning", "critical", "follow", "sticky" (like follow but stick to address), "stickyport" (like sticky but also to port)
661 http_pagesize | **Optional.** Minimum page size required:Maximum page size required.
662 http_timeout | **Optional.** Seconds before connection times out.
663 http_ipv4 | **Optional.** Use IPv4 connection. Defaults to false.
664 http_ipv6 | **Optional.** Use IPv6 connection. Defaults to false.
665 http_link | **Optional.** Wrap output in HTML link. Defaults to false.
666 http_verbose | **Optional.** Show details for command-line debugging. Defaults to false.
669 ### icmp <a id="plugin-check-command-icmp"></a>
671 The [check_icmp](https://www.monitoring-plugins.org/doc/man/check_icmp.html) plugin
672 check_icmp allows for checking multiple hosts at once compared to `check_ping`.
673 The main difference is that check_ping executes the system's ping(1) command and
674 parses its output while `check_icmp` talks ICMP itself. `check_icmp` must be installed with
677 Custom variables passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
680 ----------------|--------------
681 icmp_address | **Optional.** The host's address. This can either be a single address or an array of addresses. Defaults to "$address$".
682 icmp_wrta | **Optional.** The RTA warning threshold in milliseconds. Defaults to 100.
683 icmp_wpl | **Optional.** The packet loss warning threshold in %. Defaults to 5.
684 icmp_crta | **Optional.** The RTA critical threshold in milliseconds. Defaults to 200.
685 icmp_cpl | **Optional.** The packet loss critical threshold in %. Defaults to 15.
686 icmp_source | **Optional.** The source IP address to send packets from.
687 icmp_packets | **Optional.** The number of packets to send. Defaults to 5.
688 icmp_packet_interval | **Optional** The maximum packet interval. Defaults to 80 (milliseconds).
689 icmp_target_interval | **Optional.** The maximum target interval.
690 icmp_hosts_alive | **Optional.** The number of hosts which have to be alive for the check to succeed.
691 icmp_data_bytes | **Optional.** Payload size for each ICMP request. Defaults to 8.
692 icmp_timeout | **Optional.** The plugin timeout in seconds. Defaults to 10 (seconds).
693 icmp_ttl | **Optional.** The TTL on outgoing packets.
696 ### imap <a id="plugin-check-command-imap"></a>
698 The [check_imap](https://www.monitoring-plugins.org/doc/man/check_imap.html) plugin
699 tests IMAP connections with the specified host (or unix socket).
701 Custom variables passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
704 ----------------------|--------------
705 imap_address | **Optional.** The host's address. Defaults to "$address$" if the host's `address` attribute is set, "$address6$" otherwise.
706 imap_port | **Optional.** The port that should be checked. Defaults to 143.
707 imap_escape | **Optional.** Can use \\n, \\r, \\t or \\ in send or quit string. Must come before send or quit option. Default: nothing added to send, \\r\\n added to end of quit.
708 imap_send | **Optional.** String to send to the server.
709 imap_expect | **Optional.** String to expect in server response. Multiple strings must be defined as array.
710 imap_all | **Optional.** All expect strings need to occur in server response. Default is any.
711 imap_quit | **Optional.** String to send server to initiate a clean close of the connection.
712 imap_refuse | **Optional.** Accept TCP refusals with states ok, warn, crit (default: crit).
713 imap_mismatch | **Optional.** Accept expected string mismatches with states ok, warn, crit (default: warn).
714 imap_jail | **Optional.** Hide output from TCP socket.
715 imap_maxbytes | **Optional.** Close connection once more than this number of bytes are received.
716 imap_delay | **Optional.** Seconds to wait between sending string and polling for response.
717 imap_certificate_age | **Optional.** Minimum number of days a certificate has to be valid.
718 imap_ssl | **Optional.** Use SSL for the connection.
719 imap_warning | **Optional.** Response time to result in warning status (seconds).
720 imap_critical | **Optional.** Response time to result in critical status (seconds).
721 imap_timeout | **Optional.** Seconds before connection times out (default: 10).
722 imap_ipv4 | **Optional.** Use IPv4 connection. Defaults to false.
723 imap_ipv6 | **Optional.** Use IPv6 connection. Defaults to false.
726 ### ldap <a id="plugin-check-command-ldap"></a>
728 The [check_ldap](https://www.monitoring-plugins.org/doc/man/check_ldap.html) plugin
729 can be used to check LDAP servers.
731 The plugin can also be used for monitoring ldaps connections instead of the deprecated `check_ldaps`.
732 This can be ensured by enabling `ldap_starttls` or `ldap_ssl`.
734 Custom variables passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
737 ------------------------|--------------
738 ldap_address | **Optional.** Host name, IP Address, or unix socket (must be an absolute path). Defaults to "$address$" if the host's `address` attribute is set, "$address6$" otherwise.
739 ldap_port | **Optional.** Port number. Defaults to 389.
740 ldap_attr | **Optional.** LDAP attribute to search for (default: "(objectclass=*)")
741 ldap_base | **Required.** LDAP base (eg. ou=myunit,o=myorg,c=at).
742 ldap_bind | **Optional.** LDAP bind DN (if required).
743 ldap_pass | **Optional.** LDAP password (if required).
744 ldap_starttls | **Optional.** Use STARTSSL mechanism introduced in protocol version 3.
745 ldap_ssl | **Optional.** Use LDAPS (LDAP v2 SSL method). This also sets the default port to 636.
746 ldap_v2 | **Optional.** Use LDAP protocol version 2 (enabled by default).
747 ldap_v3 | **Optional.** Use LDAP protocol version 3 (disabled by default)
748 ldap_warning | **Optional.** Response time to result in warning status (seconds).
749 ldap_critical | **Optional.** Response time to result in critical status (seconds).
750 ldap_warning_entries | **Optional.** Number of found entries to result in warning status.
751 ldap_critical_entries | **Optional.** Number of found entries to result in critical status.
752 ldap_timeout | **Optional.** Seconds before connection times out (default: 10).
753 ldap_verbose | **Optional.** Show details for command-line debugging (disabled by default)
755 ### load <a id="plugin-check-command-load"></a>
757 The [check_load](https://www.monitoring-plugins.org/doc/man/check_load.html) plugin
758 tests the current system load average.
760 Custom variables passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
763 ----------------|--------------
764 load_wload1 | **Optional.** The 1-minute warning threshold. Defaults to 5.
765 load_wload5 | **Optional.** The 5-minute warning threshold. Defaults to 4.
766 load_wload15 | **Optional.** The 15-minute warning threshold. Defaults to 3.
767 load_cload1 | **Optional.** The 1-minute critical threshold. Defaults to 10.
768 load_cload5 | **Optional.** The 5-minute critical threshold. Defaults to 6.
769 load_cload15 | **Optional.** The 15-minute critical threshold. Defaults to 4.
770 load_percpu | **Optional.** Divide the load averages by the number of CPUs (when possible). Defaults to false.
772 ### mailq <a id="plugin-check-command-mailq"></a>
774 The [check_mailq](https://www.monitoring-plugins.org/doc/man/check_mailq.html) plugin
775 checks the number of messages in the mail queue (supports multiple sendmail queues, qmail).
777 Custom variables passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
780 ------------------------|--------------
781 mailq_warning | **Required.** Min. number of messages in queue to generate warning.
782 mailq_critical | **Required.** Min. number of messages in queue to generate critical alert ( w < c ).
783 mailq_domain_warning | **Optional.** Min. number of messages for same domain in queue to generate warning
784 mailq_domain_critical | **Optional.** Min. number of messages for same domain in queue to generate critical alert ( W < C ).
785 mailq_timeout | **Optional.** Plugin timeout in seconds (default = 15).
786 mailq_servertype | **Optional.** [ sendmail \| qmail \| postfix \| exim \| nullmailer ] (default = autodetect).
787 mailq_sudo | **Optional.** Use sudo to execute the mailq command.
789 ### mysql <a id="plugin-check-command-mysql"></a>
791 The [check_mysql](https://www.monitoring-plugins.org/doc/man/check_mysql.html) plugin
792 tests connections to a MySQL server.
794 Custom variables passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
797 ------------------------|---------------------------------------------------------------
798 mysql_hostname | **Optional.** Host name, IP Address, or unix socket (must be an absolute path).
799 mysql_port | **Optional.** Port number (default: 3306).
800 mysql_socket | **Optional.** Use the specified socket (has no effect if `mysql_hostname` is used).
801 mysql_ignore_auth | **Optional.** Ignore authentication failure and check for mysql connectivity only.
802 mysql_database | **Optional.** Check database with indicated name.
803 mysql_file | **Optional.** Read from the specified client options file.
804 mysql_group | **Optional.** Use a client options group.
805 mysql_username | **Optional.** Connect using the indicated username.
806 mysql_password | **Optional.** Use the indicated password to authenticate the connection.
807 mysql_check_slave | **Optional.** Check if the slave thread is running properly.
808 mysql_warning | **Optional.** Exit with WARNING status if slave server is more than INTEGER seconds behind master.
809 mysql_critical | **Optional.** Exit with CRITICAL status if slave server is more then INTEGER seconds behind master.
810 mysql_ssl | **Optional.** Use ssl encryption.
811 mysql_cacert | **Optional.** Path to CA signing the cert.
812 mysql_cert | **Optional.** Path to SSL certificate.
813 mysql_key | **Optional.** Path to private SSL key.
814 mysql_cadir | **Optional.** Path to CA directory.
815 mysql_ciphers | **Optional.** List of valid SSL ciphers.
818 ### mysql_query <a id="plugin-check-command-mysql-query"></a>
820 The [check_mysql_query](https://www.monitoring-plugins.org/doc/man/check_mysql_query.html) plugin
821 checks a query result against threshold levels.
822 The result from the query should be numeric. For extra security, create a user with minimal access.
824 **Note**: You must specify `mysql_query_password` with an empty string to force an empty password,
825 overriding any my.cnf settings.
827 Custom variables passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
830 ------------------------|---------------------------------------------------------------
831 mysql_query_hostname | **Optional.** Host name, IP Address, or unix socket (must be an absolute path).
832 mysql_query_port | **Optional.** Port number (default: 3306).
833 mysql_query_database | **Optional.** Check database with indicated name.
834 mysql_query_file | **Optional.** Read from the specified client options file.
835 mysql_query_group | **Optional.** Use a client options group.
836 mysql_query_username | **Optional.** Connect using the indicated username.
837 mysql_query_password | **Optional.** Use the indicated password to authenticate the connection.
838 mysql_query_execute | **Required.** SQL Query to run on the MySQL Server.
839 mysql_query_warning | **Optional.** Exit with WARNING status if query is outside of the range (format: start:end).
840 mysql_query_critical | **Optional.** Exit with CRITICAL status if query is outside of the range.
843 ### negate <a id="plugin-check-command-negate"></a>
845 The [negate](https://www.monitoring-plugins.org/doc/man/negate.html) plugin
846 negates the status of a plugin (returns OK for CRITICAL and vice-versa).
847 Additional switches can be used to control which state becomes what.
849 Custom variables passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
852 ----------------------|---------------------------------------------------------------
853 negate_timeout | **Optional.** Seconds before plugin times out (default: 11).
854 negate_timeout_result | **Optional.** Custom result on Negate timeouts, default to UNKNOWN.
855 negate_ok | **Optional.** OK, WARNING, CRITICAL or UNKNOWN.
856 negate_warning | Numeric values are accepted.
857 negate_critical | If nothing is specified,
858 negate_unknown | permutes OK and CRITICAL.
859 negate_substitute | **Optional.** Substitute output text as well. Will only substitute text in CAPITALS.
860 negate_command | **Required.** Command to be negated.
861 negate_arguments | **Optional.** Arguments for the negated command.
863 ### nrpe <a id="plugin-check-command-nrpe"></a>
865 The `check_nrpe` plugin can be used to query an [NRPE](https://icinga.com/docs/icinga1/latest/en/nrpe.html)
866 server or [NSClient++](https://www.nsclient.org). **Note**: This plugin
867 is considered insecure/deprecated.
869 Custom variables passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
872 ----------------|--------------
873 nrpe_address | **Optional.** The host's address. Defaults to "$address$" if the host's `address` attribute is set, "$address6$" otherwise.
874 nrpe_port | **Optional.** The NRPE port. Defaults to 5666.
875 nrpe_command | **Optional.** The command that should be executed.
876 nrpe_no_ssl | **Optional.** Whether to disable SSL or not. Defaults to `false`.
877 nrpe_timeout_unknown | **Optional.** Whether to set timeouts to unknown instead of critical state. Defaults to `false`.
878 nrpe_timeout | **Optional.** The timeout in seconds.
879 nrpe_arguments | **Optional.** Arguments that should be passed to the command. Multiple arguments must be defined as array.
880 nrpe_ipv4 | **Optional.** Use IPv4 connection. Defaults to false.
881 nrpe_ipv6 | **Optional.** Use IPv6 connection. Defaults to false.
882 nrpe_version_2 | **Optional.** Use this if you want to connect using NRPE v2 protocol. Defaults to false.
885 ### nscp <a id="plugin-check-command-nscp"></a>
887 The [check_nt](https://www.monitoring-plugins.org/doc/man/check_nt.html) plugin
888 collects data from the [NSClient++](https://www.nsclient.org) service.
890 Custom variables passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
893 ----------------|--------------
894 nscp_address | **Optional.** The host's address. Defaults to "$address$" if the host's `address` attribute is set, "$address6$" otherwise.
895 nscp_port | **Optional.** The NSClient++ port. Defaults to 12489.
896 nscp_password | **Optional.** The NSClient++ password.
897 nscp_variable | **Required.** The variable that should be checked.
898 nscp_params | **Optional.** Parameters for the query. Multiple parameters must be defined as array.
899 nscp_warn | **Optional.** The warning threshold.
900 nscp_crit | **Optional.** The critical threshold.
901 nscp_timeout | **Optional.** The query timeout in seconds.
902 nscp_showall | **Optional.** Use with SERVICESTATE to see working services or PROCSTATE for running processes. Defaults to false.
905 ### ntp_time <a id="plugin-check-command-ntp-time"></a>
907 The [check_ntp_time](https://www.monitoring-plugins.org/doc/man/check_ntp_time.html) plugin
908 checks the clock offset between the local host and a remote NTP server.
910 **Note**: If you want to monitor an NTP server, please use `ntp_peer`.
912 Custom variables passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
915 ----------------|--------------
916 ntp_address | **Optional.** The host's address. Defaults to "$address$" if the host's `address` attribute is set, "$address6$" otherwise.
917 ntp_port | **Optional.** Port number (default: 123).
918 ntp_quiet | **Optional.** Returns UNKNOWN instead of CRITICAL if offset cannot be found.
919 ntp_warning | **Optional.** Offset to result in warning status (seconds).
920 ntp_critical | **Optional.** Offset to result in critical status (seconds).
921 ntp_timeoffset | **Optional.** Expected offset of the ntp server relative to local server (seconds).
922 ntp_timeout | **Optional.** Seconds before connection times out (default: 10).
923 ntp_ipv4 | **Optional.** Use IPv4 connection. Defaults to false.
924 ntp_ipv6 | **Optional.** Use IPv6 connection. Defaults to false.
927 ### ntp_peer <a id="plugin-check-command-ntp-peer"></a>
929 The [check_ntp_peer](https://www.monitoring-plugins.org/doc/man/check_ntp_peer.html) plugin
930 checks the health of an NTP server. It supports checking the offset with the sync peer, the
931 jitter and stratum. This plugin will not check the clock offset between the local host and NTP
932 server; please use `ntp_time` for that purpose.
934 Custom variables passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
937 ----------------|--------------
938 ntp_address | **Optional.** The host's address. Defaults to "$address$" if the host's `address` attribute is set, "$address6$" otherwise.
939 ntp_port | **Optional.** The port to use. Default to 123.
940 ntp_quiet | **Optional.** Returns UNKNOWN instead of CRITICAL or WARNING if server isn't synchronized.
941 ntp_warning | **Optional.** Offset to result in warning status (seconds).
942 ntp_critical | **Optional.** Offset to result in critical status (seconds).
943 ntp_wstratum | **Optional.** Warning threshold for stratum of server's synchronization peer.
944 ntp_cstratum | **Optional.** Critical threshold for stratum of server's synchronization peer.
945 ntp_wjitter | **Optional.** Warning threshold for jitter.
946 ntp_cjitter | **Optional.** Critical threshold for jitter.
947 ntp_wsource | **Optional.** Warning threshold for number of usable time sources.
948 ntp_csource | **Optional.** Critical threshold for number of usable time sources.
949 ntp_timeout | **Optional.** Seconds before connection times out (default: 10).
950 ntp_ipv4 | **Optional.** Use IPv4 connection. Defaults to false.
951 ntp_ipv6 | **Optional.** Use IPv6 connection. Defaults to false.
954 ### pgsql <a id="plugin-check-command-pgsql"></a>
956 The [check_pgsql](https://www.monitoring-plugins.org/doc/man/check_pgsql.html) plugin
957 tests a PostgreSQL DBMS to determine whether it is active and accepting queries.
958 If a query is specified using the `pgsql_query` attribute, it will be executed after
959 connecting to the server. The result from the query has to be numeric in order
960 to compare it against the query thresholds if set.
962 Custom variables passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
965 ------------------------|---------------------------------------------------------------
966 pgsql_hostname | **Optional.** Host name, IP Address, or unix socket (must be an absolute path).
967 pgsql_port | **Optional.** Port number (default: 5432).
968 pgsql_database | **Optional.** Database to check (default: template1).
969 pgsql_username | **Optional.** Login name of user.
970 pgsql_password | **Optional.** Password (BIG SECURITY ISSUE).
971 pgsql_options | **Optional.** Connection parameters (keyword = value), see below.
972 pgsql_warning | **Optional.** Response time to result in warning status (seconds).
973 pgsql_critical | **Optional.** Response time to result in critical status (seconds).
974 pgsql_timeout | **Optional.** Seconds before connection times out (default: 10).
975 pgsql_query | **Optional.** SQL query to run. Only first column in first row will be read.
976 pgsql_query_warning | **Optional.** SQL query value to result in warning status (double).
977 pgsql_query_critical | **Optional.** SQL query value to result in critical status (double).
979 ### ping <a id="plugin-check-command-ping"></a>
981 The [check_ping](https://www.monitoring-plugins.org/doc/man/check_ping.html) plugin
982 uses the ping command to probe the specified host for packet loss (percentage) and
983 round trip average (milliseconds).
985 This command uses the host's `address` attribute if available and falls back to using
986 the `address6` attribute if the `address` attribute is not set.
988 Custom variables passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
991 ----------------|--------------
992 ping_address | **Optional.** The host's address. Defaults to "$address$" if the host's `address` attribute is set, "$address6$" otherwise.
993 ping_wrta | **Optional.** The RTA warning threshold in milliseconds. Defaults to 100.
994 ping_wpl | **Optional.** The packet loss warning threshold in %. Defaults to 5.
995 ping_crta | **Optional.** The RTA critical threshold in milliseconds. Defaults to 200.
996 ping_cpl | **Optional.** The packet loss critical threshold in %. Defaults to 15.
997 ping_packets | **Optional.** The number of packets to send. Defaults to 5.
998 ping_timeout | **Optional.** The plugin timeout in seconds. Defaults to 0 (no timeout).
1001 ### ping4 <a id="plugin-check-command-ping4"></a>
1003 The [check_ping](https://www.monitoring-plugins.org/doc/man/check_ping.html) plugin
1004 uses the ping command to probe the specified host for packet loss (percentage) and
1005 round trip average (milliseconds).
1007 This command uses the host's `address` attribute if not explicitly specified using
1008 the `ping_address` attribute.
1010 Custom variables passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
1013 ----------------|--------------
1014 ping_address | **Optional.** The host's IPv4 address. Defaults to "$address$".
1015 ping_wrta | **Optional.** The RTA warning threshold in milliseconds. Defaults to 100.
1016 ping_wpl | **Optional.** The packet loss warning threshold in %. Defaults to 5.
1017 ping_crta | **Optional.** The RTA critical threshold in milliseconds. Defaults to 200.
1018 ping_cpl | **Optional.** The packet loss critical threshold in %. Defaults to 15.
1019 ping_packets | **Optional.** The number of packets to send. Defaults to 5.
1020 ping_timeout | **Optional.** The plugin timeout in seconds. Defaults to 0 (no timeout).
1022 ### ping6 <a id="plugin-check-command-ping6"></a>
1024 The [check_ping](https://www.monitoring-plugins.org/doc/man/check_ping.html) plugin
1025 uses the ping command to probe the specified host for packet loss (percentage) and
1026 round trip average (milliseconds).
1028 This command uses the host's `address6` attribute if not explicitly specified using
1029 the `ping_address` attribute.
1031 Custom variables passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
1034 ----------------|--------------
1035 ping_address | **Optional.** The host's IPv6 address. Defaults to "$address6$".
1036 ping_wrta | **Optional.** The RTA warning threshold in milliseconds. Defaults to 100.
1037 ping_wpl | **Optional.** The packet loss warning threshold in %. Defaults to 5.
1038 ping_crta | **Optional.** The RTA critical threshold in milliseconds. Defaults to 200.
1039 ping_cpl | **Optional.** The packet loss critical threshold in %. Defaults to 15.
1040 ping_packets | **Optional.** The number of packets to send. Defaults to 5.
1041 ping_timeout | **Optional.** The plugin timeout in seconds. Defaults to 0 (no timeout).
1044 ### pop <a id="plugin-check-command-pop"></a>
1046 The [check_pop](https://www.monitoring-plugins.org/doc/man/check_pop.html) plugin
1047 tests POP connections with the specified host (or unix socket).
1049 Custom variables passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
1052 ---------------------|--------------
1053 pop_address | **Optional.** The host's address. Defaults to "$address$" if the host's `address` attribute is set, "$address6$" otherwise.
1054 pop_port | **Optional.** The port that should be checked. Defaults to 110.
1055 pop_escape | **Optional.** Can use \\n, \\r, \\t or \\ in send or quit string. Must come before send or quit option. Default: nothing added to send, \\r\\n added to end of quit.
1056 pop_send | **Optional.** String to send to the server.
1057 pop_expect | **Optional.** String to expect in server response. Multiple strings must be defined as array.
1058 pop_all | **Optional.** All expect strings need to occur in server response. Default is any.
1059 pop_quit | **Optional.** String to send server to initiate a clean close of the connection.
1060 pop_refuse | **Optional.** Accept TCP refusals with states ok, warn, crit (default: crit).
1061 pop_mismatch | **Optional.** Accept expected string mismatches with states ok, warn, crit (default: warn).
1062 pop_jail | **Optional.** Hide output from TCP socket.
1063 pop_maxbytes | **Optional.** Close connection once more than this number of bytes are received.
1064 pop_delay | **Optional.** Seconds to wait between sending string and polling for response.
1065 pop_certificate_age | **Optional.** Minimum number of days a certificate has to be valid.
1066 pop_ssl | **Optional.** Use SSL for the connection.
1067 pop_warning | **Optional.** Response time to result in warning status (seconds).
1068 pop_critical | **Optional.** Response time to result in critical status (seconds).
1069 pop_timeout | **Optional.** Seconds before connection times out (default: 10).
1070 pop_ipv4 | **Optional.** Use IPv4 connection. Defaults to false.
1071 pop_ipv6 | **Optional.** Use IPv6 connection. Defaults to false.
1074 ### procs <a id="plugin-check-command-processes"></a>
1076 The [check_procs](https://www.monitoring-plugins.org/doc/man/check_procs.html) plugin
1077 checks all processes and generates WARNING or CRITICAL states if the specified
1078 metric is outside the required threshold ranges. The metric defaults to number
1079 of processes. Search filters can be applied to limit the processes to check.
1081 Custom variables passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
1084 ---------------------|--------------
1085 procs_warning | **Optional.** The process count warning threshold. Defaults to 250.
1086 procs_critical | **Optional.** The process count critical threshold. Defaults to 400.
1087 procs_metric | **Optional.** Check thresholds against metric.
1088 procs_timeout | **Optional.** Seconds before plugin times out.
1089 procs_traditional | **Optional.** Filter own process the traditional way by PID instead of /proc/pid/exe. Defaults to false.
1090 procs_state | **Optional.** Only scan for processes that have one or more of the status flags you specify.
1091 procs_ppid | **Optional.** Only scan for children of the parent process ID indicated.
1092 procs_vsz | **Optional.** Only scan for processes with VSZ higher than indicated.
1093 procs_rss | **Optional.** Only scan for processes with RSS higher than indicated.
1094 procs_pcpu | **Optional.** Only scan for processes with PCPU higher than indicated.
1095 procs_user | **Optional.** Only scan for processes with user name or ID indicated.
1096 procs_argument | **Optional.** Only scan for processes with args that contain STRING.
1097 procs_argument_regex | **Optional.** Only scan for processes with args that contain the regex STRING.
1098 procs_command | **Optional.** Only scan for exact matches of COMMAND (without path).
1099 procs_nokthreads | **Optional.** Only scan for non kernel threads. Defaults to false.
1102 ### radius <a id="plugin-check-command-radius"></a>
1104 The [check_radius](https://www.monitoring-plugins.org/doc/man/check_radius.html) plugin
1105 checks a RADIUS server to see if it is accepting connections. The server to test
1106 must be specified in the invocation, as well as a user name and password. A configuration
1107 file may also be present. The format of the configuration file is described in the
1108 radiusclient library sources. The password option presents a substantial security
1109 issue because the password can possibly be determined by careful watching of the
1110 command line in a process listing. This risk is exacerbated because the plugin will
1111 typically be executed at regular predictable intervals. Please be sure that the
1112 password used does not allow access to sensitive system resources.
1115 Custom variables passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
1118 -------------------|--------------
1119 radius_address | **Optional.** The radius server's address. Defaults to "$address$" if the host's `address` attribute is set, "$address6$" otherwise.
1120 radius_config_file | **Required.** The radius configuration file.
1121 radius_username | **Required.** The radius username to test.
1122 radius_password | **Required.** The radius password to test.
1123 radius_port | **Optional.** The radius port number (default 1645).
1124 radius_nas_id | **Optional.** The NAS identifier.
1125 radius_nas_address | **Optional.** The NAS IP address.
1126 radius_expect | **Optional.** The response string to expect from the server.
1127 radius_retries | **Optional.** The number of times to retry a failed connection.
1128 radius_timeout | **Optional.** The number of seconds before connection times out (default: 10).
1130 ### rpc <a id="plugin-check-command-rpc"></a>
1132 The [check_rpc](https://www.monitoring-plugins.org/doc/man/check_rpc.html)
1133 plugin tests if a service is registered and running using `rpcinfo -H host -C rpc_command`.
1135 Custom variables passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
1139 rpc_address | **Optional.** The rpc host address. Defaults to "$address$ if the host `address` attribute is set, "$address6$" otherwise.
1140 rpc_command | **Required.** The programm name (or number).
1141 rpc_port | **Optional.** The port that should be checked.
1142 rpc_version | **Optional.** The version you want to check for (one or more).
1143 rpc_udp | **Optional.** Use UDP test. Defaults to false.
1144 rpc_tcp | **Optional.** Use TCP test. Defaults to false.
1145 rpc_verbose | **Optional.** Show verbose output. Defaults to false.
1147 ### simap <a id="plugin-check-command-simap"></a>
1149 The [check_simap](https://www.monitoring-plugins.org/doc/man/check_simap.html) plugin
1150 tests SIMAP connections with the specified host (or unix socket).
1152 Custom variables passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
1155 -----------------------|--------------
1156 simap_address | **Optional.** The host's address. Defaults to "$address$" if the host's `address` attribute is set, "$address6$" otherwise.
1157 simap_port | **Optional.** The port that should be checked. Defaults to 993.
1158 simap_escape | **Optional.** Can use \\n, \\r, \\t or \\ in send or quit string. Must come before send or quit option. Default: nothing added to send, \\r\\n added to end of quit.
1159 simap_send | **Optional.** String to send to the server.
1160 simap_expect | **Optional.** String to expect in server response. Multiple strings must be defined as array.
1161 simap_all | **Optional.** All expect strings need to occur in server response. Default is any.
1162 simap_quit | **Optional.** String to send server to initiate a clean close of the connection.
1163 simap_refuse | **Optional.** Accept TCP refusals with states ok, warn, crit (default: crit).
1164 simap_mismatch | **Optional.** Accept expected string mismatches with states ok, warn, crit (default: warn).
1165 simap_jail | **Optional.** Hide output from TCP socket.
1166 simap_maxbytes | **Optional.** Close connection once more than this number of bytes are received.
1167 simap_delay | **Optional.** Seconds to wait between sending string and polling for response.
1168 simap_certificate_age | **Optional.** Minimum number of days a certificate has to be valid.
1169 simap_ssl | **Optional.** Use SSL for the connection.
1170 simap_warning | **Optional.** Response time to result in warning status (seconds).
1171 simap_critical | **Optional.** Response time to result in critical status (seconds).
1172 simap_timeout | **Optional.** Seconds before connection times out (default: 10).
1173 simap_ipv4 | **Optional.** Use IPv4 connection. Defaults to false.
1174 simap_ipv6 | **Optional.** Use IPv6 connection. Defaults to false.
1176 ### smart <a id="plugin-check-command-smart"></a>
1178 The [check_ide_smart](https://www.monitoring-plugins.org/doc/man/check_ide_smart.html) plugin
1179 checks a local hard drive with the (Linux specific) SMART interface. Requires installation of `smartctl`.
1181 Custom variables passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
1184 ----------------|--------------
1185 smart_device | **Required.** The name of a local hard drive to monitor.
1188 ### smtp <a id="plugin-check-command-smtp"></a>
1190 The [check_smtp](https://www.monitoring-plugins.org/doc/man/check_smtp.html) plugin
1191 will attempt to open an SMTP connection with the host.
1193 Custom variables passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
1196 ----------------------|--------------
1197 smtp_address | **Optional.** The host's address. Defaults to "$address$" if the host's `address` attribute is set, "$address6$" otherwise.
1198 smtp_port | **Optional.** The port that should be checked. Defaults to 25.
1199 smtp_mail_from | **Optional.** Test a MAIL FROM command with the given email address.
1200 smtp_expect | **Optional.** String to expect in first line of server response (default: '220').
1201 smtp_command | **Optional.** SMTP command (may be used repeatedly).
1202 smtp_response | **Optional.** Expected response to command (may be used repeatedly).
1203 smtp_helo_fqdn | **Optional.** FQDN used for HELO
1204 smtp_certificate_age | **Optional.** Minimum number of days a certificate has to be valid.
1205 smtp_starttls | **Optional.** Use STARTTLS for the connection.
1206 smtp_authtype | **Optional.** SMTP AUTH type to check (default none, only LOGIN supported).
1207 smtp_authuser | **Optional.** SMTP AUTH username.
1208 smtp_authpass | **Optional.** SMTP AUTH password.
1209 smtp_ignore_quit | **Optional.** Ignore failure when sending QUIT command to server.
1210 smtp_warning | **Optional.** Response time to result in warning status (seconds).
1211 smtp_critical | **Optional.** Response time to result in critical status (seconds).
1212 smtp_timeout | **Optional.** Seconds before connection times out (default: 10).
1213 smtp_ipv4 | **Optional.** Use IPv4 connection. Defaults to false.
1214 smtp_ipv6 | **Optional.** Use IPv6 connection. Defaults to false.
1217 ### snmp <a id="plugin-check-command-snmp"></a>
1219 The [check_snmp](https://www.monitoring-plugins.org/doc/man/check_snmp.html) plugin
1220 checks the status of remote machines and obtains system information via SNMP.
1222 **Note**: This plugin uses the `snmpget` command included with the NET-SNMP package.
1224 Custom variables passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
1227 --------------------|--------------
1228 snmp_address | **Optional.** The host's address. Defaults to "$address$" if the host's `address` attribute is set, "$address6$" otherwise.
1229 snmp_oid | **Required.** The SNMP OID.
1230 snmp_community | **Optional.** The SNMP community. Defaults to "public".
1231 snmp_port | **Optional.** The SNMP port. Defaults to "161".
1232 snmp_retries | **Optional.** Number of retries to be used in the SNMP requests.
1233 snmp_warn | **Optional.** The warning threshold.
1234 snmp_crit | **Optional.** The critical threshold.
1235 snmp_string | **Optional.** Return OK state if the string matches exactly with the output value
1236 snmp_ereg | **Optional.** Return OK state if extended regular expression REGEX matches with the output value
1237 snmp_eregi | **Optional.** Return OK state if case-insensitive extended REGEX matches with the output value
1238 snmp_label | **Optional.** Prefix label for output value
1239 snmp_invert_search | **Optional.** Invert search result and return CRITICAL state if found
1240 snmp_units | **Optional.** Units label(s) for output value (e.g., 'sec.').
1241 snmp_version | **Optional.** Version to use. E.g. 1, 2, 2c or 3.
1242 snmp_miblist | **Optional.** MIB's to use, comma separated. Defaults to "ALL".
1243 snmp_rate_multiplier | **Optional.** Converts rate per second. For example, set to 60 to convert to per minute.
1244 snmp_rate | **Optional.** Boolean. Enable rate calculation.
1245 snmp_getnext | **Optional.** Boolean. Use SNMP GETNEXT. Defaults to false.
1246 snmp_timeout | **Optional.** The command timeout in seconds. Defaults to 10 seconds.
1247 snmp_offset | **Optional.** Add/subtract the specified OFFSET to numeric sensor data.
1248 snmp_output_delimiter | **Optional.** Separates output on multiple OID requests.
1249 snmp_perf_oids | **Optional.** Label performance data with OIDs instead of --label's.
1251 ### snmpv3 <a id="plugin-check-command-snmpv3"></a>
1253 Check command object for the [check_snmp](https://www.monitoring-plugins.org/doc/man/check_snmp.html)
1254 plugin, using SNMPv3 authentication and encryption options.
1256 Custom variables passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
1259 ---------------------|--------------
1260 snmpv3_address | **Optional.** The host's address. Defaults to "$address$" if the host's `address` attribute is set, "$address6$" otherwise.
1261 snmpv3_getnext | **Optional.** Use SNMP GETNEXT instead of SNMP GET.
1262 snmpv3_seclevel | **Optional.** The security level. Defaults to authPriv.
1263 snmpv3_auth_alg | **Optional.** The authentication algorithm. Defaults to SHA.
1264 snmpv3_user | **Required.** The username to log in with.
1265 snmpv3_context | **Optional.** The SNMPv3 context.
1266 snmpv3_auth_key | **Required,** The authentication key. Required if `snmpv3_seclevel` is set to `authPriv` otherwise optional.
1267 snmpv3_priv_key | **Required.** The encryption key.
1268 snmpv3_oid | **Required.** The SNMP OID.
1269 snmpv3_priv_alg | **Optional.** The encryption algorithm. Defaults to AES.
1270 snmpv3_warn | **Optional.** The warning threshold.
1271 snmpv3_crit | **Optional.** The critical threshold.
1272 snmpv3_string | **Optional.** Return OK state (for that OID) if STRING is an exact match.
1273 snmpv3_ereg | **Optional.** Return OK state (for that OID) if extended regular expression REGEX matches.
1274 snmpv3_eregi | **Optional.** Return OK state (for that OID) if case-insensitive extended REGEX matches.
1275 snmpv3_invert_search | **Optional.** Invert search result and return CRITICAL if found
1276 snmpv3_label | **Optional.** Prefix label for output value.
1277 snmpv3_units | **Optional.** Units label(s) for output value (e.g., 'sec.').
1278 snmpv3_rate_multiplier | **Optional.** Converts rate per second. For example, set to 60 to convert to per minute.
1279 snmpv3_rate | **Optional.** Boolean. Enable rate calculation.
1280 snmpv3_timeout | **Optional.** The command timeout in seconds. Defaults to 10 seconds.
1282 ### snmp-uptime <a id="plugin-check-command-snmp-uptime"></a>
1284 Check command object for the [check_snmp](https://www.monitoring-plugins.org/doc/man/check_snmp.html)
1285 plugin, using the uptime OID by default.
1287 Custom variables passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
1290 ----------------|--------------
1291 snmp_address | **Optional.** The host's address. Defaults to "$address$" if the host's `address` attribute is set, "$address6$" otherwise.
1292 snmp_oid | **Optional.** The SNMP OID. Defaults to "1.3.6.1.2.1.1.3.0".
1293 snmp_community | **Optional.** The SNMP community. Defaults to "public".
1296 ### spop <a id="plugin-check-command-spop"></a>
1298 The [check_spop](https://www.monitoring-plugins.org/doc/man/check_spop.html) plugin
1299 tests SPOP connections with the specified host (or unix socket).
1301 Custom variables passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
1304 ----------------------|--------------
1305 spop_address | **Optional.** The host's address. Defaults to "$address$" if the host's `address` attribute is set, "$address6$" otherwise.
1306 spop_port | **Optional.** The port that should be checked. Defaults to 995.
1307 spop_escape | **Optional.** Can use \\n, \\r, \\t or \\ in send or quit string. Must come before send or quit option. Default: nothing added to send, \\r\\n added to end of quit.
1308 spop_send | **Optional.** String to send to the server.
1309 spop_expect | **Optional.** String to expect in server response. Multiple strings must be defined as array.
1310 spop_all | **Optional.** All expect strings need to occur in server response. Default is any.
1311 spop_quit | **Optional.** String to send server to initiate a clean close of the connection.
1312 spop_refuse | **Optional.** Accept TCP refusals with states ok, warn, crit (default: crit).
1313 spop_mismatch | **Optional.** Accept expected string mismatches with states ok, warn, crit (default: warn).
1314 spop_jail | **Optional.** Hide output from TCP socket.
1315 spop_maxbytes | **Optional.** Close connection once more than this number of bytes are received.
1316 spop_delay | **Optional.** Seconds to wait between sending string and polling for response.
1317 spop_certificate_age | **Optional.** Minimum number of days a certificate has to be valid.
1318 spop_ssl | **Optional.** Use SSL for the connection.
1319 spop_warning | **Optional.** Response time to result in warning status (seconds).
1320 spop_critical | **Optional.** Response time to result in critical status (seconds).
1321 spop_timeout | **Optional.** Seconds before connection times out (default: 10).
1322 spop_ipv4 | **Optional.** Use IPv4 connection. Defaults to false.
1323 spop_ipv6 | **Optional.** Use IPv6 connection. Defaults to false.
1326 ### ssh <a id="plugin-check-command-ssh"></a>
1328 The [check_ssh](https://www.monitoring-plugins.org/doc/man/check_ssh.html) plugin
1329 connects to an SSH server at a specified host and port.
1331 Custom variables passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
1334 ----------------|--------------
1335 ssh_address | **Optional.** The host's address. Defaults to "$address$" if the host's `address` attribute is set, "$address6$" otherwise.
1336 ssh_port | **Optional.** The port that should be checked. Defaults to 22.
1337 ssh_timeout | **Optional.** Seconds before connection times out. Defaults to 10.
1338 ssh_ipv4 | **Optional.** Use IPv4 connection. Defaults to false.
1339 ssh_ipv6 | **Optional.** Use IPv6 connection. Defaults to false.
1342 ### ssl <a id="plugin-check-command-ssl"></a>
1344 Check command object for the [check_tcp](https://www.monitoring-plugins.org/doc/man/check_tcp.html) plugin,
1345 using ssl-related options.
1347 Custom variables passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
1350 ------------------------------|--------------
1351 ssl_address | **Optional.** The host's address. Defaults to "$address$" if the host's `address` attribute is set, "$address6$" otherwise.
1352 ssl_port | **Optional.** The port that should be checked. Defaults to 443.
1353 ssl_timeout | **Optional.** Timeout in seconds for the connect and handshake. The plugin default is 10 seconds.
1354 ssl_cert_valid_days_warn | **Optional.** Warning threshold for days before the certificate will expire. When used, the default for ssl_cert_valid_days_critical is 0.
1355 ssl_cert_valid_days_critical | **Optional.** Critical threshold for days before the certificate will expire. When used, ssl_cert_valid_days_warn must also be set.
1356 ssl_sni | **Optional.** The `server_name` that is send to select the SSL certificate to check. Important if SNI is used.
1359 ### ssmtp <a id="plugin-check-command-ssmtp"></a>
1361 The [check_ssmtp](https://www.monitoring-plugins.org/doc/man/check_ssmtp.html) plugin
1362 tests SSMTP connections with the specified host (or unix socket).
1364 Custom variables passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
1367 -----------------------|--------------
1368 ssmtp_address | **Optional.** The host's address. Defaults to "$address$" if the host's `address` attribute is set, "$address6$" otherwise.
1369 ssmtp_port | **Optional.** The port that should be checked. Defaults to 465.
1370 ssmtp_escape | **Optional.** Can use \\n, \\r, \\t or \\ in send or quit string. Must come before send or quit option. Default: nothing added to send, \\r\\n added to end of quit.
1371 ssmtp_send | **Optional.** String to send to the server.
1372 ssmtp_expect | **Optional.** String to expect in server response. Multiple strings must be defined as array.
1373 ssmtp_all | **Optional.** All expect strings need to occur in server response. Default is any.
1374 ssmtp_quit | **Optional.** String to send server to initiate a clean close of the connection.
1375 ssmtp_refuse | **Optional.** Accept TCP refusals with states ok, warn, crit (default: crit).
1376 ssmtp_mismatch | **Optional.** Accept expected string mismatches with states ok, warn, crit (default: warn).
1377 ssmtp_jail | **Optional.** Hide output from TCP socket.
1378 ssmtp_maxbytes | **Optional.** Close connection once more than this number of bytes are received.
1379 ssmtp_delay | **Optional.** Seconds to wait between sending string and polling for response.
1380 ssmtp_certificate_age | **Optional.** Minimum number of days a certificate has to be valid.
1381 ssmtp_ssl | **Optional.** Use SSL for the connection.
1382 ssmtp_warning | **Optional.** Response time to result in warning status (seconds).
1383 ssmtp_critical | **Optional.** Response time to result in critical status (seconds).
1384 ssmtp_timeout | **Optional.** Seconds before connection times out (default: 10).
1385 ssmtp_ipv4 | **Optional.** Use IPv4 connection. Defaults to false.
1386 ssmtp_ipv6 | **Optional.** Use IPv6 connection. Defaults to false.
1389 ### swap <a id="plugin-check-command-swap"></a>
1391 The [check_swap](https://www.monitoring-plugins.org/doc/man/check_swap.html) plugin
1392 checks the swap space on a local machine.
1394 Custom variables passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
1397 ----------------|--------------
1398 swap_wfree | **Optional.** The free swap space warning threshold in % (enable `swap_integer` for number values). Defaults to `50%`.
1399 swap_cfree | **Optional.** The free swap space critical threshold in % (enable `swap_integer` for number values). Defaults to `25%`.
1400 swap_integer | **Optional.** Specifies whether the thresholds are passed as number or percent value. Defaults to false (percent values).
1401 swap_allswaps | **Optional.** Conduct comparisons for all swap partitions, one by one. Defaults to false.
1402 swap_noswap | **Optional.** Resulting state when there is no swap regardless of thresholds. Possible values are "ok", "warning", "critical", "unknown". Defaults to "critical".
1405 ### tcp <a id="plugin-check-command-tcp"></a>
1407 The [check_tcp](https://www.monitoring-plugins.org/doc/man/check_tcp.html) plugin
1408 tests TCP connections with the specified host (or unix socket).
1410 Custom variables passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
1413 ----------------|--------------
1414 tcp_address | **Optional.** The host's address. Defaults to "$address$" if the host's `address` attribute is set, "$address6$" otherwise.
1415 tcp_port | **Required.** The port that should be checked.
1416 tcp_expect | **Optional.** String to expect in server response. Multiple strings must be defined as array.
1417 tcp_all | **Optional.** All expect strings need to occur in server response. Defaults to false.
1418 tcp_escape_send | **Optional.** Enable usage of \\n, \\r, \\t or \\\\ in send string.
1419 tcp_send | **Optional.** String to send to the server.
1420 tcp_escape_quit | **Optional.** Enable usage of \\n, \\r, \\t or \\\\ in quit string.
1421 tcp_quit | **Optional.** String to send server to initiate a clean close of the connection.
1422 tcp_refuse | **Optional.** Accept TCP refusals with states ok, warn, crit. Defaults to crit.
1423 tcp_mismatch | **Optional.** Accept expected string mismatches with states ok, warn, crit. Defaults to warn.
1424 tcp_jail | **Optional.** Hide output from TCP socket.
1425 tcp_maxbytes | **Optional.** Close connection once more than this number of bytes are received.
1426 tcp_delay | **Optional.** Seconds to wait between sending string and polling for response.
1427 tcp_certificate | **Optional.** Minimum number of days a certificate has to be valid. 1st value is number of days for warning, 2nd is critical (if not specified: 0) -- separated by comma.
1428 tcp_ssl | **Optional.** Use SSL for the connection. Defaults to false.
1429 tcp_wtime | **Optional.** Response time to result in warning status (seconds).
1430 tcp_ctime | **Optional.** Response time to result in critical status (seconds).
1431 tcp_timeout | **Optional.** Seconds before connection times out. Defaults to 10.
1432 tcp_ipv4 | **Optional.** Use IPv4 connection. Defaults to false.
1433 tcp_ipv6 | **Optional.** Use IPv6 connection. Defaults to false.
1436 ### udp <a id="plugin-check-command-udp"></a>
1438 The [check_udp](https://www.monitoring-plugins.org/doc/man/check_udp.html) plugin
1439 tests UDP connections with the specified host (or unix socket).
1441 Custom variables passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
1444 ----------------|--------------
1445 udp_address | **Optional.** The host's address. Defaults to "$address$" if the host's `address` attribute is set, "$address6$" otherwise.
1446 udp_port | **Required.** The port that should be checked.
1447 udp_send | **Required.** The payload to send in the UDP datagram.
1448 udp_expect | **Required.** The payload to expect in the response datagram.
1449 udp_quit | **Optional.** The payload to send to 'close' the session.
1450 udp_ipv4 | **Optional.** Use IPv4 connection. Defaults to false.
1451 udp_ipv6 | **Optional.** Use IPv6 connection. Defaults to false.
1454 ### ups <a id="plugin-check-command-ups"></a>
1456 The [check_ups](https://www.monitoring-plugins.org/doc/man/check_ups.html) plugin
1457 tests the UPS service on the specified host. [Network UPS Tools](http://www.networkupstools.org)
1458 must be running for this plugin to work.
1460 Custom variables passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
1463 ----------------|--------------
1464 ups_address | **Required.** The address of the host running upsd. Defaults to "$address$" if the host's `address` attribute is set, "$address6$" otherwise.
1465 ups_name | **Required.** The UPS name. Defaults to `ups`.
1466 ups_port | **Optional.** The port to which to connect. Defaults to 3493.
1467 ups_variable | **Optional.** The variable to monitor. Must be one of LINE, TEMP, BATTPCT or LOADPCT. If this is not set, the check only relies on the value of `ups.status`.
1468 ups_warning | **Optional.** The warning threshold for the selected variable.
1469 ups_critical | **Optional.** The critical threshold for the selected variable.
1470 ups_celsius | **Optional.** Display the temperature in degrees Celsius instead of Fahrenheit. Defaults to `false`.
1471 ups_timeout | **Optional.** The number of seconds before the connection times out. Defaults to 10.
1474 ### users <a id="plugin-check-command-users"></a>
1476 The [check_users](https://www.monitoring-plugins.org/doc/man/check_users.html) plugin
1477 checks the number of users currently logged in on the local system and generates an
1478 error if the number exceeds the thresholds specified.
1480 Custom variables passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
1483 ----------------|--------------
1484 users_wgreater | **Optional.** The user count warning threshold. Defaults to 20.
1485 users_cgreater | **Optional.** The user count critical threshold. Defaults to 50.
1489 ## Windows Plugins for Icinga 2 <a id="windows-plugins"></a>
1491 To allow a basic monitoring of Windows clients Icinga 2 comes with a set of Windows only plugins. While trying to mirror the functionalities of their linux cousins from the monitoring-plugins package, the differences between Windows and Linux are too big to be able use the same CheckCommands for both systems.
1493 A check-commands-windows.conf comes with Icinga 2, it assumes that the Windows Plugins are installed in the PluginDir set in your constants.conf. To enable them the following include directive is needed in you icinga2.conf:
1495 include <windows-plugins>
1497 One of the differences between the Windows plugins and their linux counterparts is that they consistently do not require thresholds to run, functioning like dummies without.
1500 ### Threshold syntax <a id="windows-plugins-thresholds"></a>
1502 So not specified differently the thresholds for the plugins all follow the same pattern
1505 :------------|:----------
1506 "29" | The threshold is 29.
1507 "!29" | The threshold is 29, but the negative of the result is returned.
1508 "[10-40]" | The threshold is a range from (including) 10 to 40, a value inside means the threshold has been exceeded.
1509 "![10-40]" | Same as above, but the result is inverted.
1512 ### disk-windows <a id="windows-plugins-disk-windows"></a>
1514 Check command object for the `check_disk.exe` plugin.
1515 Aggregates the disk space of all volumes and mount points it can find, or the ones defined in `disk_win_path`. Ignores removable storage like flash drives and discs (CD, DVD etc.).
1516 The data collection is instant and free disk space (default, see `disk_win_show_used`) is used for threshold computation.
1520 > Percentage based thresholds can be used by adding a '%' to the threshold
1526 :---------------------|:------------
1527 disk\_win\_warn | **Optional**. The warning threshold. Defaults to "20%".
1528 disk\_win\_crit | **Optional**. The critical threshold. Defaults to "10%".
1529 disk\_win\_path | **Optional**. Check only these paths, default checks all.
1530 disk\_win\_unit | **Optional**. Use this unit to display disk space, thresholds are interpreted in this unit. Defaults to "mb", possible values are: b, kb, mb, gb and tb.
1531 disk\_win\_exclude | **Optional**. Exclude these drives from check.
1532 disk\_win\_show\_used | **Optional**. Use used instead of free space.
1534 ### load-windows <a id="windows-plugins-load-windows"></a>
1536 Check command object for the `check_load.exe` plugin.
1537 This plugin collects the inverse of the performance counter `\Processor(_Total)\% Idle Time` two times, with a wait time of one second between the collection. To change this wait time use [`perfmon-windows`](10-icinga-template-library.md#windows-plugins-load-windows).
1542 :---------------|:------------
1543 load\_win\_warn | **Optional**. The warning threshold.
1544 load\_win\_crit | **Optional**. The critical threshold.
1547 ### memory-windows <a id="windows-plugins-memory-windows"></a>
1549 Check command object for the `check_memory.exe` plugin.
1550 The memory collection is instant and free memory is used for threshold computation.
1554 > Percentage based thresholds can be used by adding a '%' to the threshold
1555 > value. Keep in mind that memory\_win\_unit is applied before the
1556 > value is calculated.
1561 :-----------------|:------------
1562 memory\_win\_warn | **Optional**. The warning threshold. Defaults to "10%".
1563 memory\_win\_crit | **Optional**. The critical threshold. Defaults to "5%".
1564 memory\_win\_unit | **Optional**. The unit to display the received value in, thresholds are interpreted in this unit. Defaults to "mb" (megabyte), possible values are: b, kb, mb, gb and tb.
1565 memory\_win\_show\_used | **Optional**. Show used memory instead of the free memory.
1568 ### network-windows <a id="windows-plugins-network-windows"></a>
1570 Check command object for the `check_network.exe` plugin.
1571 Collects the total Bytes inbound and outbound for all interfaces in one second, to itemise interfaces or use a different collection interval use [`perfmon-windows`](10-icinga-template-library.md#windows-plugins-load-windows).
1576 :-------------------|:------------
1577 network\_win\_warn | **Optional**. The warning threshold.
1578 network\_win\_crit | **Optional**. The critical threshold.
1579 network\_no\_isatap | **Optional**. Do not print ISATAP interfaces.
1582 ### perfmon-windows <a id="windows-plugins-perfmon-windows"></a>
1584 Check command object for the `check_perfmon.exe` plugin.
1585 This plugins allows to collect data from a Performance Counter. After the first data collection a second one is done after `perfmon_win_wait` milliseconds. When you know `perfmon_win_counter` only requires one set of data to provide valid data you can set `perfmon_win_wait` to `0`.
1587 To receive a list of possible Performance Counter Objects run `check_perfmon.exe --print-objects` and to view an objects instances and counters run `check_perfmon.exe --print-object-info -P "name of object"`
1592 :---------------------|:------------
1593 perfmon\_win\_warn | **Optional**. The warning threshold.
1594 perfmon\_win\_crit | **Optional**. The critical threshold.
1595 perfmon\_win\_counter | **Required**. The Performance Counter to use. Ex. `\Processor(_Total)\% Idle Time`.
1596 perfmon\_win\_wait | **Optional**. Time in milliseconds to wait between data collection (default: 1000).
1597 perfmon\_win\_type | **Optional**. Format in which to expect performance values. Possible are: long, int64 and double (default).
1598 perfmon\_win\_syntax | **Optional**. Use this in the performance output instead of `perfmon\_win\_counter`. Exists for graphics compatibility reasons.
1601 ### ping-windows <a id="windows-plugins-ping-windows"></a>
1603 Check command object for the `check_ping.exe` plugin.
1604 ping-windows should automatically detect whether `ping_win_address` is an IPv4 or IPv6 address. If not, use ping4-windows and ping6-windows. Also note that check\_ping.exe waits at least `ping_win_timeout` milliseconds between the pings.
1609 :------------------|:------------
1610 ping\_win\_warn | **Optional**. The warning threshold. RTA and package loss separated by comma.
1611 ping\_win\_crit | **Optional**. The critical threshold. RTA and package loss separated by comma.
1612 ping\_win\_address | **Required**. An IPv4 or IPv6 address.
1613 ping\_win\_packets | **Optional**. Number of packages to send. Default: 5.
1614 ping\_win\_timeout | **Optional**. The timeout in milliseconds. Default: 1000
1617 ### procs-windows <a id="windows-plugins-procs-windows"></a>
1619 Check command object for `check_procs.exe` plugin.
1620 When using `procs_win_user` this plugins needs administrative privileges to access the processes of other users, to just enumerate them no additional privileges are required.
1625 :----------------|:------------
1626 procs\_win\_warn | **Optional**. The warning threshold.
1627 procs\_win\_crit | **Optional**. The critical threshold.
1628 procs\_win\_user | **Optional**. Count this users processes.
1631 ### service-windows <a id="windows-plugins-service-windows"></a>
1633 Check command object for `check_service.exe` plugin.
1634 This checks thresholds work different since the binary decision whether a service is running or not does not allow for three states. As a default `check_service.exe` will return CRITICAL when `service_win_service` is not running, the `service_win_warn` flag changes this to WARNING.
1639 :-------------------------|:------------
1640 service\_win\_warn | **Optional**. Warn when service is not running.
1641 service\_win\_description | **Optional**. If this is set, `service\_win\_service` looks at the service description.
1642 service\_win\_service | **Required**. Name of the service to check.
1645 ### swap-windows <a id="windows-plugins-swap-windows"></a>
1647 Check command object for `check_swap.exe` plugin.
1648 The data collection is instant.
1653 :--------------- | :------------
1654 swap\_win\_warn | **Optional**. The warning threshold. Defaults to "10%".
1655 swap\_win\_crit | **Optional**. The critical threshold. Defaults to "5%".
1656 swap\_win\_unit | **Optional**. The unit to display the received value in, thresholds are interpreted in this unit. Defaults to "mb" (megabyte).
1657 swap\_win\_show\_used | **Optional**. Show used swap instead of the free swap.
1659 ### update-windows <a id="windows-plugins-update-windows"></a>
1661 Check command object for `check_update.exe` plugin.
1662 Querying Microsoft for Windows updates can take multiple seconds to minutes. An update is treated as important when it has the WSUS flag for SecurityUpdates or CriticalUpdates.
1666 > The Network Services Account which runs Icinga 2 by default does not have the required
1667 > permissions to run this check.
1672 :-------------------|:------------
1673 update\_win\_warn | **Optional**. The warning threshold.
1674 update\_win\_crit | **Optional**. The critical threshold.
1675 update\_win\_reboot | **Optional**. Set to treat 'may need update' as 'definitely needs update'. Please Note that this is true for almost every update and is therefore not recommended.
1676 ignore\_reboot | **Optional**. Set to disable behavior of returning critical if any updates require a reboot.
1679 If a warning threshold is set but not a critical threshold, the critical threshold will be set to one greater than the set warning threshold.
1680 Unless the `ignore_reboot` flag is set, if any updates require a reboot the plugin will return critical.
1684 > If they are enabled, performance data will be shown in the web interface.
1685 > If run without the optional parameters, the plugin will output critical if any important updates are available.
1688 ### uptime-windows <a id="windows-plugins-uptime-windows"></a>
1690 Check command object for `check_uptime.exe` plugin.
1691 Uses GetTickCount64 to get the uptime, so boot time is not included.
1696 :-----------------|:------------
1697 uptime\_win\_warn | **Optional**. The warning threshold.
1698 uptime\_win\_crit | **Optional**. The critical threshold.
1699 uptime\_win\_unit | **Optional**. The unit to display the received value in, thresholds are interpreted in this unit. Defaults to "s"(seconds), possible values are ms (milliseconds), s, m (minutes), h (hours).
1702 ### users-windows <a id="windows-plugins-users-windows"></a>
1704 Check command object for `check_users.exe` plugin.
1709 :----------------|:------------
1710 users\_win\_warn | **Optional**. The warning threshold.
1711 users\_win\_crit | **Optional**. The critical threshold.
1714 ## Plugin Check Commands for NSClient++ <a id="nscp-plugin-check-commands"></a>
1716 There are two methods available for querying NSClient++:
1718 * 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)
1719 * Run a [local CLI check](10-icinga-template-library.md#nscp-check-local) (does not require NSClient++ as a service)
1721 Both methods have their advantages and disadvantages. One thing to
1722 note: If you rely on performance counter delta calculations such as
1723 CPU utilization, please use the HTTP API instead of the CLI sample call.
1725 For security reasons, it is advised to enable the NSClient++ HTTP API for local
1726 connection from the Icinga 2 client only. Remote connections to the HTTP API
1727 are not recommended with using the legacy HTTP API.
1729 ### nscp_api <a id="nscp-check-api"></a>
1731 `check_nscp_api` is part of the Icinga 2 plugins. This plugin is available for
1732 both, Windows and Linux/Unix.
1734 Verify that the ITL CheckCommand is included in the [icinga2.conf](04-configuration.md#icinga2-conf) configuration file:
1736 vim /etc/icinga2/icinga2.conf
1740 `check_nscp_api` runs queries against the NSClient++ API. Therefore NSClient++ needs to have
1741 the `webserver` module enabled, configured and loaded.
1743 You can install the webserver using the following CLI commands:
1745 ./nscp.exe web install
1746 ./nscp.exe web password — –set icinga
1748 Now you can define specific [queries](https://docs.nsclient.org/reference/check/CheckHelpers.html#queries)
1749 and integrate them into Icinga 2.
1751 The check plugin `check_nscp_api` can be integrated with the `nscp_api` CheckCommand object:
1756 :----------------------|:----------------------
1757 nscp\_api\_host | **Required**. NSCP API host address. Defaults to "$address$" if the host's `address` attribute is set, "$address6$" otherwise.
1758 nscp\_api\_port | **Optional**. NSCP API port. Defaults to `8443`.
1759 nscp\_api\_password | **Required**. NSCP API password. Please check the NSCP documentation for setup details.
1760 nscp\_api\_query | **Required**. NSCP API query endpoint. Refer to the NSCP documentation for possible values.
1761 nscp\_api\_arguments | **Optional**. NSCP API arguments dictionary either as single strings or key-value pairs using `=`. Refer to the NSCP documentation.
1763 `nscp_api_arguments` can be used to pass required thresholds to the executed check. The example below
1764 checks the CPU utilization and specifies warning and critical thresholds.
1767 check_nscp_api --host 10.0.10.148 --password icinga --query check_cpu --arguments show-all warning='load>40' critical='load>30'
1768 check_cpu CRITICAL: critical(5m: 48%, 1m: 36%), 5s: 0% | 'total 5m'=48%;40;30 'total 1m'=36%;40;30 'total 5s'=0%;40;30
1772 ### nscp-local <a id="nscp-check-local"></a>
1774 Icinga 2 can use the `nscp client` command to run arbitrary NSClient++ checks locally on the client.
1776 You can enable these check commands by adding the following the include directive in your
1777 [icinga2.conf](04-configuration.md#icinga2-conf) configuration file:
1781 You can also optionally specify an alternative installation directory for NSClient++ by adding
1782 the NscpPath constant in your [constants.conf](04-configuration.md#constants-conf) configuration
1785 const NscpPath = "C:\\Program Files (x86)\\NSClient++"
1787 By default Icinga 2 uses the Microsoft Installer API to determine where NSClient++ is installed. It should
1788 not be necessary to manually set this constant.
1790 Note that it is not necessary to run NSClient++ as a Windows service for these commands to work.
1792 The check command object for NSClient++ is available as `nscp-local`.
1794 Custom variables passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
1797 ----------------|--------------
1798 nscp_log_level | **Optional.** The log level. Defaults to "critical".
1799 nscp_load_all | **Optional.** Whether to load all modules. Defaults to false.
1800 nscp_modules | **Optional.** An array of NSClient++ modules to load. Defaults to `[ "CheckSystem" ]`.
1801 nscp_boot | **Optional.** Whether to use the --boot option. Defaults to true.
1802 nscp_query | **Required.** The NSClient++ query. Try `nscp client -q x` for a list.
1803 nscp_arguments | **Optional.** An array of query arguments.
1804 nscp_showall | **Optional.** Shows more details in plugin output, default to false.
1808 > In order to measure CPU load, you'll need a running NSClient++ service.
1809 > Therefore it is advised to use a local [nscp-api](06-distributed-monitoring.md#distributed-monitoring-windows-nscp-check-api)
1810 > check against its REST API.
1812 ### nscp-local-cpu <a id="nscp-check-local-cpu"></a>
1814 Check command object for the `check_cpu` NSClient++ plugin.
1817 --------------------|------------------
1818 nscp_cpu_time | **Optional.** Calculate average usage for the given time intervals. Value has to be an array, default to [ "1m", "5m", "15m" ].
1819 nscp_cpu_warning | **Optional.** Threshold for WARNING state in percent, default to 80.
1820 nscp_cpu_critical | **Optional.** Threshold for CRITICAL state in percent, default to 90.
1821 nscp_cpu_arguments | **Optional.** Additional arguments.
1822 nscp_cpu_showall | **Optional.** Shows more details in plugin output, default to false.
1824 ### nscp-local-memory <a id="nscp-check-local-memory"></a>
1826 Check command object for the `check_memory` NSClient++ plugin.
1829 ----------------------|------------------
1830 nscp_memory_committed | **Optional.** Check for committed memory, default to false.
1831 nscp_memory_physical | **Optional.** Check for physical memory, default to true.
1832 nscp_memory_free | **Optional.** Switch between checking free (true) or used memory (false), default to false.
1833 nscp_memory_warning | **Optional.** Threshold for WARNING state in percent or absolute (use MB, GB, ...), default to 80 (free=false) or 20 (free=true).
1834 nscp_memory_critical | **Optional.** Threshold for CRITICAL state in percent or absolute (use MB, GB, ...), default to 90 (free=false) or 10 (free=true).
1835 nscp_memory_arguments | **Optional.** Additional arguments.
1836 nscp_memory_showall | **Optional.** Shows more details in plugin output, default to false.
1838 ### nscp-local-os-version <a id="nscp-check-local-os-version"></a>
1840 Check command object for the `check_os_version` NSClient++ plugin.
1842 This command has the same custom variables like the `nscp-local` check command.
1844 ### nscp-local-pagefile <a id="nscp-check-local-pagefile"></a>
1846 Check command object for the `check_pagefile` NSClient++ plugin.
1848 This command has the same custom variables like the `nscp-local` check command.
1850 ### nscp-local-process <a id="nscp-check-local-process"></a>
1852 Check command object for the `check_process` NSClient++ plugin.
1854 This command has the same custom variables like the `nscp-local` check command.
1856 ### nscp-local-service <a id="nscp-check-local-service"></a>
1858 Check command object for the `check_service` NSClient++ plugin.
1861 -----------------------|------------------
1862 nscp_service_name | **Required.** Name of service to check.
1863 nscp_service_type | **Optional.** Type to check, default to state.
1864 nscp_service_ok | **Optional.** State for return an OK, i.e. for type=state running, stopped, ...
1865 nscp_service_otype | **Optional.** Dedicate type for nscp_service_ok, default to nscp_service_state.
1866 nscp_service_warning | **Optional.** State for return an WARNING.
1867 nscp_service_wtype | **Optional.** Dedicate type for nscp_service_warning, default to nscp_service_state.
1868 nscp_service_critical | **Optional.** State for return an CRITICAL.
1869 nscp_service_ctype | **Optional.** Dedicate type for nscp_service_critical, default to nscp_service_state.
1870 nscp_service_arguments | **Optional.** Additional arguments.
1871 nscp_service_showall | **Optional.** Shows more details in plugin output, default to true.
1873 ### nscp-local-uptime <a id="nscp-check-local-uptime"></a>
1875 Check command object for the `check_uptime` NSClient++ plugin.
1877 This command has the same custom variables like the `nscp-local` check command.
1879 ### nscp-local-version <a id="nscp-check-local-version"></a>
1881 Check command object for the `check_version` NSClient++ plugin.
1883 This command has the same custom variables like the `nscp-local` check command.
1884 In addition to that the default value for `nscp_modules` is set to `[ "CheckHelpers" ]`.
1886 ### nscp-local-disk <a id="nscp-check-local-disk"></a>
1888 Check command object for the `check_drivesize` NSClient++ plugin.
1891 -----------------------|------------------
1892 nscp_disk_drive | **Optional.** Drive character, default to all drives. Can be an array if multiple drives should be monitored.
1893 nscp_disk_exclude | **Optional.** Drive character, default to none. Can be an array of drive characters if multiple drives should be excluded.
1894 nscp_disk_free | **Optional.** Switch between checking free space (free=true) or used space (free=false), default to false.
1895 nscp_disk_warning | **Optional.** Threshold for WARNING in percent or absolute (use MB, GB, ...), default to 80 (used) or 20 percent (free).
1896 nscp_disk_critical | **Optional.** Threshold for CRITICAL in percent or absolute (use MB, GB, ...), default to 90 (used) or 10 percent (free).
1897 nscp_disk_arguments | **Optional.** Additional arguments.
1898 nscp_disk_showall | **Optional.** Shows more details in plugin output, default to true.
1899 nscp_modules | **Optional.** An array of NSClient++ modules to load. Defaults to `[ "CheckDisk" ]`.
1901 ### nscp-local-counter <a id="nscp-check-local-counter"></a>
1903 Check command object for the `check_pdh` NSClient++ plugin.
1906 -----------------------|------------------
1907 nscp_counter_name | **Required.** Performance counter name.
1908 nscp_counter_warning | **Optional.** WARNING Threshold.
1909 nscp_counter_critical | **Optional.** CRITICAL Threshold.
1910 nscp_counter_arguments | **Optional.** Additional arguments.
1911 nscp_counter_showall | **Optional.** Shows more details in plugin output, default to false.
1912 nscp_counter_perfsyntax | **Optional.** Apply performance data label, e.g. `Total Processor Time` to avoid special character problems. Defaults to `nscp_counter_name`.
1914 ### nscp-local-tasksched <a id="nscp-check-local-tasksched"></a>
1916 Check Command object for the `check_tasksched` NSClient++ plugin.
1917 You can check for a single task or for a complete folder (and sub folders) of tasks.
1920 -----------------------|------------------
1921 nscp_tasksched_name | **Optional.** Name of the task to check.
1922 nscp_tasksched_folder | **Optional.** The folder in which the tasks to check reside.
1923 nscp_tasksched_recursive | **Optional.** Recurse sub folder, defaults to true.
1924 nscp_tasksched_hidden | **Optional.** Look for hidden tasks, defaults to false.
1925 nscp_tasksched_warning | **Optional.** Filter which marks items which generates a warning state, defaults to `exit_code != 0`.
1926 nscp_tasksched_critical | **Optional.** Filter which marks items which generates a critical state, defaults to `exit_code < 0`.
1927 nscp_tasksched_emptystate | **Optional.** Return status to use when nothing matched filter, defaults to warning.
1928 nscp_tasksched_perfsyntax | **Optional.** Performance alias syntax., defaults to `%(title)`
1929 nscp_tasksched_detailsyntax | **Optional.** Detail level syntax, defaults to `%(folder)/%(title): %(exit_code) != 0`
1930 nscp_tasksched_arguments | **Optional.** Additional arguments.
1931 nscp_tasksched_showall | **Optional.** Shows more details in plugin output, default to false.
1932 nscp_modules | **Optional.** An array of NSClient++ modules to load. Defaults to `[ "CheckTaskSched" ]`.
1935 ## Plugin Check Commands for Manubulon SNMP <a id="snmp-manubulon-plugin-check-commands"></a>
1937 The `SNMP Manubulon Plugin Check Commands` provide configuration for plugin check
1938 commands provided by the [SNMP Manubulon project](http://nagios.manubulon.com/index_snmp.html).
1940 **Note:** Some plugin parameters are only available in Debian packages or in a
1941 [forked repository](https://github.com/dnsmichi/manubulon-snmp) with patches applied.
1943 The SNMP manubulon plugin check commands assume that the global constant named `ManubulonPluginDir`
1944 is set to the path where the Manubublon SNMP plugins are installed.
1946 You can enable these plugin check commands by adding the following the include directive in your
1947 [icinga2.conf](04-configuration.md#icinga2-conf) configuration file:
1951 ### Checks by Host Type
1953 **N/A** : Not available for this type.
1955 **SNMP** : Available for simple SNMP query.
1959 **Specific** : Script name for platform specific checks.
1962 Host type | Interface | storage | load/cpu | mem | process | env | specific
1963 ------------------------|------------|----------|-----------|-----|----------|-----|-------------------------
1964 Linux | Yes | Yes | Yes | Yes | Yes | No |
1965 Windows | Yes | Yes | Yes | Yes | Yes | No | check_snmp_win.pl
1966 Cisco router/switch | Yes | N/A | Yes | Yes | N/A | Yes |
1967 HP router/switch | Yes | N/A | Yes | Yes | N/A | No |
1968 Bluecoat proxy | Yes | SNMP | Yes | SNMP| No | Yes |
1969 CheckPoint on SPLAT | Yes | Yes | Yes | Yes | Yes | No | check_snmp_cpfw.pl
1970 CheckPoint on Nokia IP | Yes | Yes | Yes | No | ?? | No | check_snmp_vrrp.pl
1971 Boostedge | Yes | Yes | Yes | Yes | ?? | No | check_snmp_boostedge.pl
1972 AS400 | Yes | Yes | Yes | Yes | No | No |
1973 NetsecureOne Netbox | Yes | Yes | Yes | ?? | Yes | No |
1974 Radware Linkproof | Yes | N/A | SNMP | SNMP| No | No | check_snmp_linkproof_nhr <br> check_snmp_vrrp.pl
1975 IronPort | Yes | SNMP | SNMP | SNMP| No | Yes |
1976 Cisco CSS | Yes | ?? | Yes | Yes | No | ?? | check_snmp_css.pl
1979 ### snmp-env <a id="plugin-check-command-snmp-env"></a>
1981 Check command object for the [check_snmp_env.pl](http://nagios.manubulon.com/snmp_env.html) plugin.
1983 Custom variables passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
1987 ------------------------|--------------
1988 snmp_address | **Optional.** The host's address. Defaults to "$address$" if the host's `address` attribute is set, "$address6$" otherwise.
1989 snmp_nocrypt | **Optional.** Define SNMP encryption. If set to `false`, `snmp_v3` needs to be enabled. Defaults to `true` (no encryption).
1990 snmp_community | **Optional.** The SNMP community. Defaults to "public".
1991 snmp_port | **Optional.** The SNMP port connection.
1992 snmp_v2 | **Optional.** SNMP version to 2c. Defaults to false.
1993 snmp_v3 | **Optional.** SNMP version to 3. Defaults to false.
1994 snmp_login | **Optional.** SNMP version 3 username. Defaults to "snmpuser".
1995 snmp_password | **Required.** SNMP version 3 password. No value defined as default.
1996 snmp_v3_use_privpass | **Optional.** Define to use SNMP version 3 priv password. Defaults to false.
1997 snmp_v3_use_authprotocol| **Optional.** Define to use SNMP version 3 authentication protocol. Defaults to false.
1998 snmp_authprotocol | **Optional.** SNMP version 3 authentication protocol. Defaults to "md5,des".
1999 snmp_privpass | **Required.** SNMP version 3 priv password. No value defined as default.
2000 snmp_env_type | **Optional.** Environment Type [cisco|nokia|bc|iron|foundry|linux]. Defaults to "cisco".
2001 snmp_env_fan | **Optional.** Minimum fan rpm value (only needed for 'iron' & 'linux')
2002 snmp_env_celsius | **Optional.** Maximum temp in degrees celsius (only needed for 'iron' & 'linux')
2003 snmp_perf | **Optional.** Enable perfdata values. Defaults to true.
2004 snmp_timeout | **Optional.** The command timeout in seconds. Defaults to 5 seconds.
2006 ### snmp-load <a id="plugin-check-command-snmp-load"></a>
2008 Check command object for the [check_snmp_load.pl](http://nagios.manubulon.com/snmp_load.html) plugin.
2010 Custom variables passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
2014 ------------------------|--------------
2015 snmp_address | **Optional.** The host's address. Defaults to "$address$" if the host's `address` attribute is set, "$address6$" otherwise.
2016 snmp_nocrypt | **Optional.** Define SNMP encryption. If set to `false`, `snmp_v3` needs to be enabled. Defaults to `true` (no encryption).
2017 snmp_community | **Optional.** The SNMP community. Defaults to "public".
2018 snmp_port | **Optional.** The SNMP port connection.
2019 snmp_v2 | **Optional.** SNMP version to 2c. Defaults to false.
2020 snmp_v3 | **Optional.** SNMP version to 3. Defaults to false.
2021 snmp_login | **Optional.** SNMP version 3 username. Defaults to "snmpuser".
2022 snmp_password | **Required.** SNMP version 3 password. No value defined as default.
2023 snmp_v3_use_privpass | **Optional.** Define to use SNMP version 3 priv password. Defaults to false.
2024 snmp_v3_use_authprotocol| **Optional.** Define to use SNMP version 3 authentication protocol. Defaults to false.
2025 snmp_authprotocol | **Optional.** SNMP version 3 authentication protocol. Defaults to "md5,des".
2026 snmp_privpass | **Required.** SNMP version 3 priv password. No value defined as default.
2027 snmp_warn | **Optional.** The warning threshold. Change the `snmp_load_type` var to "netsl" for using 3 values.
2028 snmp_crit | **Optional.** The critical threshold. Change the `snmp_load_type` var to "netsl" for using 3 values.
2029 snmp_load_type | **Optional.** Load type. Defaults to "stand". Check all available types in the [snmp load](http://nagios.manubulon.com/snmp_load.html) documentation.
2030 snmp_perf | **Optional.** Enable perfdata values. Defaults to true.
2031 snmp_timeout | **Optional.** The command timeout in seconds. Defaults to 5 seconds.
2033 ### snmp-memory <a id="plugin-check-command-snmp-memory"></a>
2035 Check command object for the [check_snmp_mem.pl](http://nagios.manubulon.com/snmp_mem.html) plugin.
2037 Custom variables passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
2040 ------------------------|--------------
2041 snmp_address | **Optional.** The host's address. Defaults to "$address$" if the host's `address` attribute is set, "$address6$" otherwise.
2042 snmp_nocrypt | **Optional.** Define SNMP encryption. If set to `false`, `snmp_v3` needs to be enabled. Defaults to `true` (no encryption).
2043 snmp_community | **Optional.** The SNMP community. Defaults to "public".
2044 snmp_port | **Optional.** The SNMP port connection.
2045 snmp_v2 | **Optional.** SNMP version to 2c. Defaults to false.
2046 snmp_v3 | **Optional.** SNMP version to 3. Defaults to false.
2047 snmp_login | **Optional.** SNMP version 3 username. Defaults to "snmpuser".
2048 snmp_password | **Required.** SNMP version 3 password. No value defined as default.
2049 snmp_v3_use_privpass | **Optional.** Define to use SNMP version 3 priv password. Defaults to false.
2050 snmp_v3_use_authprotocol| **Optional.** Define to use SNMP version 3 authentication protocol. Defaults to false.
2051 snmp_authprotocol | **Optional.** SNMP version 3 authentication protocol. Defaults to "md5,des".
2052 snmp_privpass | **Required.** SNMP version 3 priv password. No value defined as default.
2053 snmp_warn | **Optional.** The warning threshold.
2054 snmp_crit | **Optional.** The critical threshold.
2055 snmp_is_cisco | **Optional.** Change OIDs for Cisco switches. Defaults to false.
2056 snmp_is_hp | **Optional.** Change OIDs for HP/Procurve switches. Defaults to false.
2057 snmp_perf | **Optional.** Enable perfdata values. Defaults to true.
2058 snmp_memcached | **Optional.** Include cached memory in used memory, Defaults to false.
2059 snmp_membuffer | **Optional.** Exclude buffered memory in used memory, Defaults to false.
2060 snmp_timeout | **Optional.** The command timeout in seconds. Defaults to 5 seconds.
2062 ### snmp-storage <a id="plugin-check-command-snmp-storage"></a>
2064 Check command object for the [check_snmp_storage.pl](http://nagios.manubulon.com/snmp_storage.html) plugin.
2066 Custom variables passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
2069 ------------------------|--------------
2070 snmp_address | **Optional.** The host's address. Defaults to "$address$" if the host's `address` attribute is set, "$address6$" otherwise.
2071 snmp_nocrypt | **Optional.** Define SNMP encryption. If set to `false`, `snmp_v3` needs to be enabled. Defaults to `true` (no encryption).
2072 snmp_community | **Optional.** The SNMP community. Defaults to "public".
2073 snmp_port | **Optional.** The SNMP port connection.
2074 snmp_v2 | **Optional.** SNMP version to 2c. Defaults to false.
2075 snmp_v3 | **Optional.** SNMP version to 3. Defaults to false.
2076 snmp_login | **Optional.** SNMP version 3 username. Defaults to "snmpuser".
2077 snmp_password | **Required.** SNMP version 3 password. No value defined as default.
2078 snmp_v3_use_privpass | **Optional.** Define to use SNMP version 3 priv password. Defaults to false.
2079 snmp_v3_use_authprotocol| **Optional.** Define to use SNMP version 3 authentication protocol. Defaults to false.
2080 snmp_authprotocol | **Optional.** SNMP version 3 authentication protocol. Defaults to "md5,des".
2081 snmp_privpass | **Required.** SNMP version 3 priv password. No value defined as default.
2082 snmp_warn | **Optional.** The warning threshold.
2083 snmp_crit | **Optional.** The critical threshold.
2084 snmp_storage_name | **Optional.** Storage name. Default to regex "^/$$". More options available in the [snmp storage](http://nagios.manubulon.com/snmp_storage.html) documentation.
2085 snmp_storage_type | **Optional.** Filter by storage type. Valid options are Other, Ram, VirtualMemory, FixedDisk, RemovableDisk, FloppyDisk, CompactDisk, RamDisk, FlashMemory, or NetworkDisk. No value defined as default.
2086 snmp_perf | **Optional.** Enable perfdata values. Defaults to true.
2087 snmp_exclude | **Optional.** Select all storages except the one(s) selected by -m. No action on storage type selection.
2088 snmp_timeout | **Optional.** The command timeout in seconds. Defaults to 5 seconds.
2089 snmp_storage_olength | **Optional.** Max-size of the SNMP message, usefull in case of Too Long responses.
2091 ### snmp-interface <a id="plugin-check-command-snmp-interface"></a>
2093 Check command object for the [check_snmp_int.pl](http://nagios.manubulon.com/snmp_int.html) plugin.
2095 Custom variables passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
2098 ----------------------------|--------------
2099 snmp_address | **Optional.** The host's address. Defaults to "$address$" if the host's `address` attribute is set, "$address6$" otherwise.
2100 snmp_nocrypt | **Optional.** Define SNMP encryption. If set to `false`, `snmp_v3` needs to be enabled. Defaults to `true` (no encryption).
2101 snmp_community | **Optional.** The SNMP community. Defaults to "public".
2102 snmp_port | **Optional.** The SNMP port connection.
2103 snmp_v2 | **Optional.** SNMP version to 2c. Defaults to false.
2104 snmp_v3 | **Optional.** SNMP version to 3. Defaults to false.
2105 snmp_login | **Optional.** SNMP version 3 username. Defaults to "snmpuser".
2106 snmp_password | **Required.** SNMP version 3 password. No value defined as default.
2107 snmp_v3_use_privpass | **Optional.** Define to use SNMP version 3 priv password. Defaults to false.
2108 snmp_v3_use_authprotocol | **Optional.** Define to use SNMP version 3 authentication protocol. Defaults to false.
2109 snmp_authprotocol | **Optional.** SNMP version 3 authentication protocol. Defaults to "md5,des".
2110 snmp_privpass | **Required.** SNMP version 3 priv password. No value defined as default.
2111 snmp_warn | **Optional.** The warning threshold.
2112 snmp_crit | **Optional.** The critical threshold.
2113 snmp_interface | **Optional.** Network interface name. Default to regex "eth0".
2114 snmp_interface_inverse | **Optional.** Inverse Interface check, down is ok. Defaults to false as it is missing.
2115 snmp_interface_perf | **Optional.** Check the input/output bandwidth of the interface. Defaults to true.
2116 snmp_interface_label | **Optional.** Add label before speed in output: in=, out=, errors-out=, etc.
2117 snmp_interface_bits_bytes | **Optional.** Output performance data in bits/s or Bytes/s. **Depends** on snmp_interface_kbits set to true. Defaults to true.
2118 snmp_interface_percent | **Optional.** Output performance data in % of max speed. Defaults to false.
2119 snmp_interface_kbits | **Optional.** Make the warning and critical levels in KBits/s. Defaults to true.
2120 snmp_interface_megabytes | **Optional.** Make the warning and critical levels in Mbps or MBps. **Depends** on snmp_interface_kbits set to true. Defaults to true.
2121 snmp_interface_64bit | **Optional.** Use 64 bits counters instead of the standard counters when checking bandwidth & performance data for interface >= 1Gbps. Defaults to false.
2122 snmp_interface_errors | **Optional.** Add error & discard to Perfparse output. Defaults to true.
2123 snmp_interface_noregexp | **Optional.** Do not use regexp to match interface name in description OID. Defaults to false.
2124 snmp_interface_delta | **Optional.** Delta time of perfcheck. Defaults to "300" (5 min).
2125 snmp_interface_warncrit_percent | **Optional.** Make the warning and critical levels in % of reported interface speed. If set, **snmp_interface_megabytes** needs to be set to false. Defaults to false.
2126 snmp_interface_ifname | **Optional.** Switch from IF-MIB::ifDescr to IF-MIB::ifName when looking up the interface's name.
2127 snmp_interface_ifalias | **Optional.** Switch from IF-MIB::ifDescr to IF-MIB::ifAlias when looking up the interface's name.
2128 snmp_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`.
2129 snmp_perf | **Optional.** Enable perfdata values. Defaults to true.
2130 snmp_timeout | **Optional.** The command timeout in seconds. Defaults to 5 seconds.
2132 ### snmp-process <a id="plugin-check-command-snmp-process"></a>
2134 Check command object for the [check_snmp_process.pl](http://nagios.manubulon.com/snmp_process.html) plugin.
2136 Custom variables passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
2139 ---------------------------|--------------
2140 snmp_address | **Optional.** The host's address. Defaults to "$address$" if the host's `address` attribute is set, "$address6$" otherwise.
2141 snmp_nocrypt | **Optional.** Define SNMP encryption. If set to `false`, `snmp_v3` needs to be enabled. Defaults to `true` (no encryption).
2142 snmp_community | **Optional.** The SNMP community. Defaults to "public".
2143 snmp_port | **Optional.** The SNMP port connection.
2144 snmp_v2 | **Optional.** SNMP version to 2c. Defaults to false.
2145 snmp_v3 | **Optional.** SNMP version to 3. Defaults to false.
2146 snmp_login | **Optional.** SNMP version 3 username. Defaults to "snmpuser".
2147 snmp_password | **Required.** SNMP version 3 password. No value defined as default.
2148 snmp_v3_use_privpass | **Optional.** Define to use SNMP version 3 priv password. Defaults to false.
2149 snmp_v3_use_authprotocol | **Optional.** Define to use SNMP version 3 authentication protocol. Defaults to false.
2150 snmp_authprotocol | **Optional.** SNMP version 3 authentication protocol. Defaults to "md5,des".
2151 snmp_privpass | **Required.** SNMP version 3 priv password. No value defined as default..
2152 snmp_warn | **Optional.** The warning threshold.
2153 snmp_crit | **Optional.** The critical threshold.
2154 snmp_process_name | **Optional.** Name of the process (regexp). No trailing slash!. Defaults to ".*".
2155 snmp_perf | **Optional.** Enable perfdata values. Defaults to true.
2156 snmp_timeout | **Optional.** The command timeout in seconds. Defaults to 5 seconds.
2157 snmp_process_use_params | **Optional.** Add process parameters to process name for regexp matching. Example: "named.*-t /var/named/chroot" will only select named process with this parameter. Defaults to false.
2158 snmp_process_mem_usage | **Optional.** Define to check memory usage for the process. Defaults to false.
2159 snmp_process_mem_threshold | **Optional.** Defines the warning and critical thresholds in Mb when snmp_process_mem_usage set to true. Example "512,1024". Defaults to "0,0".
2160 snmp_process_cpu_usage | **Optional.** Define to check CPU usage for the process. Defaults to false.
2161 snmp_process_cpu_threshold | **Optional.** Defines the warning and critical thresholds in % when snmp_process_cpu_usage set to true. If more than one CPU, value can be > 100% : 100%=1 CPU. Example "15,50". Defaults to "0,0".
2163 ### snmp-service <a id="plugin-check-command-snmp-service"></a>
2165 Check command object for the [check_snmp_win.pl](http://nagios.manubulon.com/snmp_windows.html) plugin.
2167 Custom variables passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
2170 ---------------------------|--------------
2171 snmp_address | **Optional.** The host's address. Defaults to "$address$" if the host's `address` attribute is set, "$address6$" otherwise.
2172 snmp_nocrypt | **Optional.** Define SNMP encryption. If set to `false`, `snmp_v3` needs to be enabled. Defaults to `true` (no encryption).
2173 snmp_community | **Optional.** The SNMP community. Defaults to "public".
2174 snmp_port | **Optional.** The SNMP port connection.
2175 snmp_v2 | **Optional.** SNMP version to 2c. Defaults to false.
2176 snmp_v3 | **Optional.** SNMP version to 3. Defaults to false.
2177 snmp_login | **Optional.** SNMP version 3 username. Defaults to "snmpuser".
2178 snmp_password | **Required.** SNMP version 3 password. No value defined as default.
2179 snmp_v3_use_privpass | **Optional.** Define to use SNMP version 3 priv password. Defaults to false.
2180 snmp_v3_use_authprotocol | **Optional.** Define to use SNMP version 3 authentication protocol. Defaults to false.
2181 snmp_authprotocol | **Optional.** SNMP version 3 authentication protocol. Defaults to "md5,des".
2182 snmp_privpass | **Required.** SNMP version 3 priv password. No value defined as default.
2183 snmp_timeout | **Optional.** The command timeout in seconds. Defaults to 5 seconds.
2184 snmp_service_name | **Optional.** Comma separated names of services (perl regular expressions can be used for every one). By default, it is not case sensitive. eg. ^dns$. Defaults to ".*".
2185 snmp_service_count | **Optional.** Compare matching services with a specified number instead of the number of names provided.
2186 snmp_service_showall | **Optional.** Show all services in the output, instead of only the non-active ones. Defaults to false.
2187 snmp_service_noregexp | **Optional.** Do not use regexp to match NAME in service description. Defaults to false.
2190 ## Contributed Plugin Check Commands <a id="plugin-contrib"></a>
2192 The contributed Plugin Check Commands provides various additional command definitions
2193 contributed by community members.
2195 These check commands assume that the global constant named `PluginContribDir`
2196 is set to the path where the user installs custom plugins and can be enabled by
2197 uncommenting the corresponding line in [icinga2.conf](04-configuration.md#icinga2-conf):
2200 vim /etc/icinga2/icinga2.conf
2202 include <plugin-contrib>
2205 This is enabled by default since Icinga 2 2.5.0.
2207 ### Big Data <a id="plugin-contrib-big-data"></a>
2209 This category contains plugins for various Big Data systems.
2211 #### cloudera_service_status <a id="plugin-contrib-command-cloudera_service_status"></a>
2213 The [cloudera_service_status](https://github.com/miso231/icinga2-cloudera-plugin) plugin
2214 uses Cloudera Manager API to monitor cluster services
2216 Custom variables passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
2219 ----------------------|-----------------------------------------------------------------
2220 cloudera_host | **Required.** Hostname of cloudera server.
2221 cloudera_port | **Optional.** Port where cloudera is listening. Defaults to 443.
2222 cloudera_user | **Required.** The username for the API connection.
2223 cloudera_pass | **Required.** The password for the API connection.
2224 cloudera_api_version | **Required.** API version of cloudera.
2225 cloudera_cluster | **Required.** The cluster name in cloudera manager.
2226 cloudera_service | **Required.** Name of cluster service to be checked.
2227 cloudera_verify_ssl | **Optional.** Verify SSL. Defaults to true.
2229 #### cloudera_hdfs_space <a id="plugin-contrib-command-cloudera_hdfs_space"></a>
2231 The [cloudera_hdfs_space](https://github.com/miso231/icinga2-cloudera-plugin) plugin
2232 connects to Hadoop Namenode and gets used capacity of selected disk
2234 Custom variables passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
2237 --------------------------|-----------------------------------------------------------------
2238 cloudera_hdfs_space_host | **Required.** Namenode host to connect to.
2239 cloudera_hdfs_space_port | **Optional.** Namenode port (default 50070).
2240 cloudera_hdfs_space_disk | **Required.** HDFS disk to check.
2241 cloudera_hdfs_space_warn | **Required.** Warning threshold in percent.
2242 cloudera_hdfs_space_crit | **Required.** Critical threshold in percent.
2244 #### cloudera_hdfs_files <a id="plugin-contrib-command-cloudera_hdfs_files"></a>
2246 The [cloudera_hdfs_files](https://github.com/miso231/icinga2-cloudera-plugin) plugin
2247 connects to Hadoop Namenode and gets total number of files on HDFS
2249 Custom variables passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
2252 --------------------------|-----------------------------------------------------------------
2253 cloudera_hdfs_files_host | **Required.** Namenode host to connect to.
2254 cloudera_hdfs_files_port | **Optional.** Namenode port (default 50070).
2255 cloudera_hdfs_files_warn | **Required.** Warning threshold.
2256 cloudera_hdfs_files_crit | **Required.** Critical threshold.
2257 cloudera_hdfs_files_max | **Required.** Max files count that causes problems (default 140,000,000).
2259 ### Databases <a id="plugin-contrib-databases"></a>
2261 This category contains plugins for various database servers.
2263 #### db2_health <a id="plugin-contrib-command-db2_health"></a>
2265 The [check_db2_health](https://labs.consol.de/nagios/check_db2_health/) plugin
2266 uses the `DBD::DB2` Perl library to monitor a [DB2](https://www.ibm.com/support/knowledgecenter/SSEPGG_11.1.0/)
2269 The Git repository is located on [GitHub](https://github.com/lausser/check_db2_health).
2271 Custom variables passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
2274 ---------------------------------|------------------------------------------------------------------------------------------------------------------------------
2275 db2_health_database | **Required.** The name of the database. (If it was catalogued locally, this parameter and `db2_health_not_catalogued = false` are the only you need. Otherwise you must specify database, hostname and port)
2276 db2_health_username | **Optional.** The username for the database connection.
2277 db2_health_password | **Optional.** The password for the database connection.
2278 db2_health_port | **Optional.** The port where DB2 is listening.
2279 db2_health_warning | **Optional.** The warning threshold depending on the mode.
2280 db2_health_critical | **Optional.** The critical threshold depending on the mode.
2281 db2_health_mode | **Required.** The mode uses predefined keywords for the different checks. For example "connection-time", "database-usage" or "sql".
2282 db2_health_method | **Optional.** This tells the plugin how to connect to the database. The only method implemented yet is “dbi” which is the default. (It means, the plugin uses the perl module DBD::DB2).
2283 db2_health_name | **Optional.** The tablespace, datafile, wait event, latch, enqueue depending on the mode or SQL statement to be executed with "db2_health_mode" sql.
2284 db2_health_name2 | **Optional.** If "db2_health_name" is a sql statement, "db2_health_name2" can be used to appear in the output and the performance data.
2285 db2_health_regexp | **Optional.** If set to true, "db2_health_name" will be interpreted as a regular expression. Defaults to false.
2286 db2_health_units | **Optional.** This is used for a better output of mode=sql and for specifying thresholds for mode=tablespace-free. Possible values are "%", "KB", "MB" and "GB".
2287 db2_health_maxinactivity | **Optional.** Used for the maximum amount of time a certain event has not happened.
2288 db2_health_mitigation | **Optional.** Classifies the severity of an offline tablespace.
2289 db2_health_lookback | **Optional.** How many days in the past db2_health check should look back to calculate exitcode.
2290 db2_health_report | **Optional.** Report can be used to output only the bad news. Possible values are "short", "long", "html". Defaults to `short`.
2291 db2_health_not_catalogued | **Optional.** Set this variable to false if you want to use a catalogued locally database. Defaults to `true`.
2292 db2_health_env_db2_home | **Required.** Specifies the location of the db2 client libraries as environment variable `DB2_HOME`. Defaults to "/opt/ibm/db2/V10.5".
2293 db2_health_env_db2_version | **Optional.** Specifies the DB2 version as environment variable `DB2_VERSION`.
2295 #### mssql_health <a id="plugin-contrib-command-mssql_health"></a>
2297 The [check_mssql_health](https://labs.consol.de/nagios/check_mssql_health/index.html) plugin
2298 uses the `DBD::Sybase` Perl library based on [FreeTDS](http://www.freetds.org/) to monitor a
2299 [MS SQL](https://www.microsoft.com/en-us/sql-server/) server.
2301 The Git repository is located on [GitHub](https://github.com/lausser/check_mssql_health).
2303 Custom variables passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
2306 ---------------------------------|------------------------------------------------------------------------------------------------------------------------------
2307 mssql_health_hostname | **Optional.** Specifies the database hostname or address. No default because you typically use "mssql_health_server".
2308 mssql_health_username | **Optional.** The username for the database connection.
2309 mssql_health_password | **Optional.** The password for the database connection.
2310 mssql_health_port | **Optional.** Specifies the database port. No default because you typically use "mssql_health_server".
2311 mssql_health_server | **Optional.** The name of a predefined connection (in freetds.conf).
2312 mssql_health_currentdb | **Optional.** The name of a database which is used as the current database for the connection.
2313 mssql_health_offlineok | **Optional.** Set this to true if offline databases are perfectly ok for you. Defaults to false.
2314 mssql_health_nooffline | **Optional.** Set this to true to ignore offline databases. Defaults to false.
2315 mssql_health_dbthresholds | **Optional.** With this parameter thresholds are read from the database table check_mssql_health_thresholds.
2316 mssql_health_notemp | **Optional.** Set this to true to ignore temporary databases/tablespaces. Defaults to false.
2317 mssql_health_commit | **Optional.** Set this to true to turn on autocommit for the dbd::sybase module. Defaults to false.
2318 mssql_health_method | **Optional.** How the plugin should connect to the database (dbi for the perl module `DBD::Sybase` (default) and `sqlrelay` for the SQLRelay proxy).
2319 mssql_health_mode | **Required.** The mode uses predefined keywords for the different checks. For example "connection-time", "database-free" or "sql".
2320 mssql_health_regexp | **Optional.** If set to true, "mssql_health_name" will be interpreted as a regular expression. Defaults to false.
2321 mssql_health_warning | **Optional.** The warning threshold depending on the mode.
2322 mssql_health_critical | **Optional.** The critical threshold depending on the mode.
2323 mssql_health_warningx | **Optional.** A possible override for the warning threshold.
2324 mssql_health_criticalx | **Optional.** A possible override for the critical threshold.
2325 mssql_health_units | **Optional.** This is used for a better output of mode=sql and for specifying thresholds for mode=tablespace-free. Possible values are "%", "KB", "MB" and "GB".
2326 mssql_health_name | **Optional.** Depending on the mode this could be the database name or a SQL statement.
2327 mssql_health_name2 | **Optional.** If "mssql_health_name" is a sql statement, "mssql_health_name2" can be used to appear in the output and the performance data.
2328 mssql_health_name3 | **Optional.** Additional argument used for 'database-file-free' mode for example.
2329 mssql_health_extraopts | **Optional.** Read command line arguments from an external file.
2330 mssql_health_blacklist | **Optional.** Blacklist some (missing/failed) components
2331 mssql_health_mitigation | **Optional.** The parameter allows you to change a critical error to a warning.
2332 mssql_health_lookback | **Optional.** The amount of time you want to look back when calculating average rates.
2333 mssql_health_environment | **Optional.** Add a variable to the plugin's environment.
2334 mssql_health_negate | **Optional.** Emulate the negate plugin. --negate warning=critical --negate unknown=critical.
2335 mssql_health_morphmessage | **Optional.** Modify the final output message.
2336 mssql_health_morphperfdata | **Optional.** The parameter allows you to change performance data labels.
2337 mssql_health_selectedperfdata | **Optional.** The parameter allows you to limit the list of performance data.
2338 mssql_health_report | **Optional.** Report can be used to output only the bad news. Possible values are "short", "long", "html". Defaults to `short`.
2339 mssql_health_multiline | **Optional.** Multiline output.
2340 mssql_health_withmymodulesdyndir | **Optional.** Add-on modules for the my-modes will be searched in this directory.
2341 mssql_health_statefilesdir | **Optional.** An alternate directory where the plugin can save files.
2342 mssql_health_isvalidtime | **Optional.** Signals the plugin to return OK if now is not a valid check time.
2343 mssql_health_timeout | **Optional.** Plugin timeout. Defaults to 15s.
2345 #### mysql_health <a id="plugin-contrib-command-mysql_health"></a>
2347 The [check_mysql_health](https://labs.consol.de/nagios/check_mysql_health/index.html) plugin
2348 uses the `DBD::MySQL` Perl library to monitor a
2349 [MySQL](https://dev.mysql.com/downloads/mysql/) or [MariaDB](https://mariadb.org/about/) database.
2351 The Git repository is located on [GitHub](https://github.com/lausser/check_mysql_health).
2353 Custom variables passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
2356 ---------------------------------|------------------------------------------------------------------------------------------------------------------------------
2357 mysql_health_hostname | **Required.** Specifies the database hostname or address. Defaults to "$address$" or "$address6$" if the `address` attribute is not set.
2358 mysql_health_port | **Optional.** Specifies the database port. Defaults to 3306 (or 1186 for "mysql_health_mode" cluster).
2359 mysql_health_socket | **Optional.** Specifies the database unix socket. No default.
2360 mysql_health_username | **Optional.** The username for the database connection.
2361 mysql_health_password | **Optional.** The password for the database connection.
2362 mysql_health_database | **Optional.** The database to connect to. Defaults to information_schema.
2363 mysql_health_warning | **Optional.** The warning threshold depending on the mode.
2364 mysql_health_critical | **Optional.** The critical threshold depending on the mode.
2365 mysql_health_warningx | **Optional.** The extended warning thresholds depending on the mode.
2366 mysql_health_criticalx | **Optional.** The extended critical thresholds depending on the mode.
2367 mysql_health_mode | **Required.** The mode uses predefined keywords for the different checks. For example "connection-time", "slave-lag" or "sql".
2368 mysql_health_method | **Optional.** How the plugin should connect to the database (`dbi` for using DBD::Mysql (default), `mysql` for using the mysql-Tool).
2369 mysql_health_commit | **Optional.** Turns on autocommit for the dbd::\* module.
2370 mysql_health_notemp | **Optional.** Ignore temporary databases/tablespaces.
2371 mysql_health_nooffline | **Optional.** Skip the offline databases.
2372 mysql_health_regexp | **Optional.** Parameter name/name2/name3 will be interpreted as (perl) regular expression.
2373 mysql_health_name | **Optional.** The name of a specific component to check.
2374 mysql_health_name2 | **Optional.** The secondary name of a component.
2375 mysql_health_name3 | **Optional.** The tertiary name of a component.
2376 mysql_health_units | **Optional.** This is used for a better output of mode=sql and for specifying thresholds for mode=tablespace-free. Possible values are "%", "KB", "MB" and "GB".
2377 mysql_health_labelformat | **Optional.** One of those formats pnp4nagios or groundwork. Defaults to pnp4nagios.
2378 mysql_health_extraopts | **Optional.** Read command line arguments from an external file.
2379 mysql_health_blacklist | **Optional.** Blacklist some (missing/failed) components
2380 mysql_health_mitigation | **Optional.** The parameter allows you to change a critical error to a warning.
2381 mysql_health_lookback | **Optional.** The amount of time you want to look back when calculating average rates.
2382 mysql_health_environment | **Optional.** Add a variable to the plugin's environment.
2383 mysql_health_morphmessage | **Optional.** Modify the final output message.
2384 mysql_health_morphperfdata | **Optional.** The parameter allows you to change performance data labels.
2385 mysql_health_selectedperfdata | **Optional.** The parameter allows you to limit the list of performance data.
2386 mysql_health_report | **Optional.** Can be used to shorten the output.
2387 mysql_health_multiline | **Optional.** Multiline output.
2388 mysql_health_negate | **Optional.** Emulate the negate plugin. --negate warning=critical --negate unknown=critical.
2389 mysql_health_withmymodulesdyndir | **Optional.** Add-on modules for the my-modes will be searched in this directory.
2390 mysql_health_statefilesdir | **Optional.** An alternate directory where the plugin can save files.
2391 mysql_health_isvalidtime | **Optional.** Signals the plugin to return OK if now is not a valid check time.
2392 mysql_health_timeout | **Optional.** Plugin timeout. Defaults to 60s.
2394 #### oracle_health <a id="plugin-contrib-command-oracle_health"></a>
2396 The [check_oracle_health](https://labs.consol.de/nagios/check_oracle_health/index.html) plugin
2397 uses the `DBD::Oracle` Perl library to monitor an [Oracle](https://www.oracle.com/database/) database.
2399 The Git repository is located on [GitHub](https://github.com/lausser/check_oracle_health).
2401 Custom variables passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
2404 ---------------------------------|------------------------------------------------------------------------------------------------------------------------------
2405 oracle_health_connect | **Required.** Specifies the database connection string (from tnsnames.ora).
2406 oracle_health_username | **Optional.** The username for the database connection.
2407 oracle_health_password | **Optional.** The password for the database connection.
2408 oracle_health_warning | **Optional.** The warning threshold depending on the mode.
2409 oracle_health_critical | **Optional.** The critical threshold depending on the mode.
2410 oracle_health_mode | **Required.** The mode uses predefined keywords for the different checks. For example "connection-time", "flash-recovery-area-usage" or "sql".
2411 oracle_health_method | **Optional.** How the plugin should connect to the database (`dbi` for using DBD::Oracle (default), `sqlplus` for using the sqlplus-Tool).
2412 oracle_health_name | **Optional.** The tablespace, datafile, wait event, latch, enqueue depending on the mode or SQL statement to be executed with "oracle_health_mode" sql.
2413 oracle_health_name2 | **Optional.** If "oracle_health_name" is a sql statement, "oracle_health_name2" can be used to appear in the output and the performance data.
2414 oracle_health_regexp | **Optional.** If set to true, "oracle_health_name" will be interpreted as a regular expression. Defaults to false.
2415 oracle_health_units | **Optional.** This is used for a better output of mode=sql and for specifying thresholds for mode=tablespace-free. Possible values are "%", "KB", "MB" and "GB".
2416 oracle_health_ident | **Optional.** If set to true, outputs instance and database names. Defaults to false.
2417 oracle_health_commit | **Optional.** Set this to true to turn on autocommit for the dbd::oracle module. Defaults to false.
2418 oracle_health_noperfdata | **Optional.** Set this to true if you want to disable perfdata. Defaults to false.
2419 oracle_health_timeout | **Optional.** Plugin timeout. Defaults to 60s.
2420 oracle_health_report | **Optional.** Select the plugin output format. Can be short or long. Default to long.
2425 --------------------|------------------------------------------------------------------------------------------------------------------------------------------
2426 ORACLE\_HOME | **Required.** Specifies the location of the oracle instant client libraries. Defaults to "/usr/lib/oracle/11.2/client64/lib". Can be overridden by setting the custom variable `oracle_home`.
2427 LD\_LIBRARY\_PATH | **Required.** Specifies the location of the oracle instant client libraries for the run-time shared library loader. Defaults to "/usr/lib/oracle/11.2/client64/lib". Can be overridden by setting the custom variable `oracle_ld_library_path`.
2428 TNS\_ADMIN | **Required.** Specifies the location of the tnsnames.ora including the database connection strings. Defaults to "/etc/icinga2/plugin-configs". Can be overridden by setting the custom variable `oracle_tns_admin`.
2430 #### postgres <a id="plugin-contrib-command-postgres"></a>
2432 The [check_postgres](https://bucardo.org/wiki/Check_postgres) plugin
2433 uses the `psql` binary to monitor a [PostgreSQL](https://www.postgresql.org/about/) database.
2435 The Git repository is located on [GitHub](https://github.com/bucardo/check_postgres).
2437 Custom variables passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
2440 ---------------------------------|------------------------------------------------------------------------------------------------------------------------------
2441 postgres_host | **Optional.** Specifies the database hostname or address. Defaults to "$address$" or "$address6$" if the `address` attribute is not set. If "postgres_unixsocket" is set to true, falls back to unix socket.
2442 postgres_port | **Optional.** Specifies the database port. Defaults to 5432.
2443 postgres_dbname | **Optional.** Specifies the database name to connect to. Defaults to "postgres" or "template1".
2444 postgres_dbuser | **Optional.** The username for the database connection. Defaults to "postgres".
2445 postgres_dbpass | **Optional.** The password for the database connection. You can use a .pgpass file instead.
2446 postgres_dbservice | **Optional.** Specifies the service name to use inside of pg_service.conf.
2447 postgres_warning | **Optional.** Specifies the warning threshold, range depends on the action.
2448 postgres_critical | **Optional.** Specifies the critical threshold, range depends on the action.
2449 postgres_include | **Optional.** Specifies name(s) items to specifically include (e.g. tables), depends on the action.
2450 postgres_exclude | **Optional.** Specifies name(s) items to specifically exclude (e.g. tables), depends on the action.
2451 postgres_includeuser | **Optional.** Include objects owned by certain users.
2452 postgres_excludeuser | **Optional.** Exclude objects owned by certain users.
2453 postgres_standby | **Optional.** Assume that the server is in continuous WAL recovery mode if set to true. Defaults to false.
2454 postgres_production | **Optional.** Assume that the server is in production mode if set to true. Defaults to false.
2455 postgres_action | **Required.** Determines the test executed.
2456 postgres_unixsocket | **Optional.** If "postgres_unixsocket" is set to true, the unix socket is used instead of an address. Defaults to false.
2457 postgres_query | **Optional.** Query for "custom_query" action.
2458 postgres_valtype | **Optional.** Value type of query result for "custom_query".
2459 postgres_reverse | **Optional.** If "postgres_reverse" is set, warning and critical values are reversed for "custom_query" action.
2460 postgres_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).
2462 #### mongodb <a id="plugin-contrib-command-mongodb"></a>
2464 The [check_mongodb.py](https://github.com/mzupan/nagios-plugin-mongodb) plugin
2465 uses the `pymongo` Python library to monitor a [MongoDB](https://docs.mongodb.com/manual/) instance.
2467 Custom variables passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
2470 ---------------------------------|------------------------------------------------------------------------------------------------------------------------------
2471 mongodb_host | **Required.** Specifies the hostname or address. Defaults to "$address$" if the host's `address` attribute is set, "$address6$" otherwise.
2472 mongodb_port | **Required.** The port mongodb is running on.
2473 mongodb_user | **Optional.** The username you want to login as.
2474 mongodb_passwd | **Optional.** The password you want to use for that user.
2475 mongodb_authdb | **Optional.** The database you want to authenticate against.
2476 mongodb_warning | **Optional.** The warning threshold we want to set.
2477 mongodb_critical | **Optional.** The critical threshold we want to set.
2478 mongodb_action | **Required.** The action you want to take.
2479 mongodb_maxlag | **Optional.** Get max replication lag (for replication_lag action only).
2480 mongodb_mappedmemory | **Optional.** Get mapped memory instead of resident (if resident memory can not be read).
2481 mongodb_perfdata | **Optional.** Enable output of Nagios performance data.
2482 mongodb_database | **Optional.** Specify the database to check.
2483 mongodb_alldatabases | **Optional.** Check all databases (action database_size).
2484 mongodb_ssl | **Optional.** Connect using SSL.
2485 mongodb_replicaset | **Optional.** Connect to replicaset.
2486 mongodb_replcheck | **Optional.** If set to true, will enable the mongodb_replicaset value needed for "replica_primary" check.
2487 mongodb_querytype | **Optional.** The query type to check [query\|insert\|update\|delete\|getmore\|command] from queries_per_second.
2488 mongodb_collection | **Optional.** Specify the collection to check.
2489 mongodb_sampletime | **Optional.** Time used to sample number of pages faults.
2491 #### elasticsearch <a id="plugin-contrib-command-elasticsearch"></a>
2493 The [check_elasticsearch](https://github.com/anchor/nagios-plugin-elasticsearch) plugin
2494 uses the HTTP API to monitor an [Elasticsearch](https://www.elastic.co/products/elasticsearch) node.
2496 Custom variables passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
2499 -----------------------------|-------------------------------------------------------------------------------------------------------
2500 elasticsearch_host | **Optional.** Hostname or network address to probe. Defaults to "$address$" if the host's `address` attribute is set, "$address6$" otherwise.
2501 elasticsearch_failuredomain | **Optional.** A comma-separated list of ElasticSearch attributes that make up your cluster's failure domain.
2502 elasticsearch_masternodes | **Optional.** Issue a warning if the number of master-eligible nodes in the cluster drops below this number. By default, do not monitor the number of nodes in the cluster.
2503 elasticsearch_port | **Optional.** TCP port to probe. The ElasticSearch API should be listening here. Defaults to 9200.
2504 elasticsearch_prefix | **Optional.** Optional prefix (e.g. 'es') for the ElasticSearch API. Defaults to ''.
2505 elasticsearch_yellowcritical | **Optional.** Instead of issuing a 'warning' for a yellow cluster state, issue a 'critical' alert. Defaults to false.
2507 #### redis <a id="plugin-contrib-command-redis"></a>
2509 The [check_redis.pl](https://github.com/willixix/naglio-plugins/blob/master/check_redis.pl) plugin
2510 uses the `Redis` Perl library to monitor a [Redis](https://redis.io/) instance. The plugin can
2511 measure response time, hitrate, memory utilization, check replication synchronization, etc. It is
2512 also possible to test data in a specified key and calculate averages or summaries on ranges.
2514 Custom variables passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
2517 -------------------------|--------------------------------------------------------------------------------------------------------------
2518 redis_hostname | **Required.** Hostname or IP Address to check. Defaults to "$address$" if the host's `address` attribute is set, "$address6$" otherwise.
2519 redis_port | **Optional.** Port number to query. Default to "6379".
2520 redis_database | **Optional.** Database name (usually a number) to query, needed for **redis_query**.
2521 redis_password | **Optional.** Password for Redis authentication. Safer alternative is to put them in a file and use **redis_credentials**.
2522 redis_credentials | **Optional.** Credentials file to read for Redis authentication.
2523 redis_timeout | **Optional.** Allows to set timeout for execution of this plugin.
2524 redis_variables | **Optional.** List of variables from info data to do threshold checks on.
2525 redis_warn | **Optional.** This option can only be used if **redis_variables** is used and the number of values listed here must exactly match number of variables specified.
2526 redis_crit | **Optional.** This option can only be used if **redis_variables** is used and the number of values listed here must exactly match number of variables specified.
2527 redis_perfparse | **Optional.** This should only be used with variables and causes variable data not only to be printed as part of main status line but also as perfparse compatible output. Defaults to false.
2528 redis_perfvars | **Optional.** This allows to list variables which values will go only into perfparse output (and not for threshold checking).
2529 redis_prev_perfdata | **Optional.** If set to true, previous performance data are used to calculate rate of change for counter statistics variables and for proper calculation of hitrate. Defaults to false.
2530 redis_rate_label | **Optional.** Prefix or Suffix label used to create a new variable which has rate of change of another base variable. You can specify PREFIX or SUFFIX or both as one string separated by ",". Default if not specified is suffix "_rate".
2531 redis_query | **Optional.** Option specifies key to query and optional variable name to assign the results to after.
2532 redis_option | **Optional.** Specifiers are separated by "," and must include NAME or PATTERN.
2533 redis_response_time | **Optional.** If this is used, plugin will measure and output connection response time in seconds. With **redis_perfparse** this would also be provided on perf variables.
2534 redis_hitrate | **Optional.** Calculates Hitrate and specify values are interpreted as WARNING and CRITICAL thresholds.
2535 redis_memory_utilization | **Optional.** This calculates percent of total memory on system used by redis. Total_memory on server must be specified with **redis_total_memory**. If you specify by itself, the plugin will just output this info. Parameter values are interpreted as WARNING and CRITICAL thresholds.
2536 redis_total_memory | **Optional.** Amount of memory on a system for memory utilization calculation. Use system memory or max_memory setting of redis.
2537 redis_replication_delay | **Optional.** Allows to set threshold on replication delay info.
2539 #### proxysql <a id="plugin-contrib-command-proxysql"></a>
2541 The [check_proxysql](https://github.com/sysown/proxysql-nagios) plugin,
2542 uses the `proxysql` binary to monitor [proxysql](https://proxysql.com/).
2544 Custom variables passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
2547 -----------------------------|----------------------------------------------------------------------------------
2548 proxysql_user | **Optional.** ProxySQL admin username (default=admin)
2549 proxysql_password | **Optional.** ProxySQL admin password (default=admin)
2550 proxysql_host | **Optional.** ProxySQL hostname / IP (default=127.0.0.1)
2551 proxysql_port | **Optional.** ProxySQL admin port (default=6032)
2552 proxysql_defaultfile | **Optional.** ProxySQL defaults file
2553 proxysql_type | **Required.** ProxySQL check type (one of conns,hg,rules,status,var)
2554 proxysql_name | **Optional.** ProxySQL variable name to check
2555 proxysql_lower | **Optional.** Alert if ProxySQL value are LOWER than defined WARN / CRIT thresholds (only applies to 'var' check type)
2556 proxysql_runtime | **Optional.** Force ProxySQL Nagios check to query the runtime_mysql_XXX tables rather than the mysql_XXX tables
2557 proxysql_warning | **Optional.** Warning threshold
2558 proxysql_critical | **Optional.** Critical threshold
2559 proxysql\_include\_hostgroup | **Optional.** ProxySQL hostgroup(s) to include (only applies to '--type hg' checks, accepts comma-separated list)
2560 proxysql\_ignore\_hostgroup | **Optional.** ProxySQL hostgroup(s) to ignore (only applies to '--type hg' checks, accepts comma-separated list)
2562 #### memcached <a id="plugin-contrib-command-memcached"></a>
2564 The [check_memcached](https://packages.debian.org/stretch/nagios-plugins-contrib) plugin
2565 is provided by the `nagios-plugin-contrib` package on Debian/Ubuntu.
2567 Custom variables passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
2570 --------------------------------|----------------------------------------------------------------------------------
2571 memcached_hostname | **Required.** Hostname or IP address (required) optional ':port' overrides -p
2572 memcached_port | **Optional.** Port number (default: 11211)
2573 memcached_verbose | **Optional.** verbose messages
2574 memcached_keep | **Optional.** Keep up to this many items in the history object in memcached (default: 30)
2575 memcached_minimum_stat_interval | **Optional.** Minimum time interval (in minutes) to use to analyse stats. (default: 30)
2576 memcached_warning_hits_misses | **Optional.** Generate warning if quotient of hits/misses falls below this value (default: 2.0)
2577 memcached_warning_evictions | **Optional.** Generate warning if number of evictions exceeds this threshold. 0=disable. (default: 10)
2578 memcached_timeout | **Optional.** timeout in seconds (default: 1.0)
2579 memcached_key | **Optional.** key name for history object (default: check_memcached)
2580 memcached_expiry | **Optional.** expiry time in seconds for history object (default: 7200)
2581 memcached_performance_output | **Optional.** output performance statistics as rate-per-minute figures (better suited to pnp4nagios)
2583 ### Hardware <a id="plugin-contrib-hardware"></a>
2585 This category includes all plugin check commands for various hardware checks.
2587 #### hpasm <a id="plugin-contrib-command-hpasm"></a>
2589 The [check_hpasm](https://labs.consol.de/de/nagios/check_hpasm/index.html) plugin
2590 monitors the hardware health of HP Proliant Servers, provided that the `hpasm`
2591 (HP Advanced Server Management) software is installed. It is also able to monitor
2592 the system health of HP Bladesystems and storage systems.
2594 The plugin can run in two different ways:
2596 1. Local execution using the `hpasmcli` command line tool.
2597 2. Remote SNMP query which invokes the HP Insight Tools on the remote node.
2599 You can either set or omit `hpasm_hostname` custom variable and select the corresponding node.
2601 The `hpasm_remote` attribute enables the plugin to execute remote SNMP queries if set to `true`.
2602 For compatibility reasons this attribute uses `true` as default value, and ensures that
2603 specifying the `hpasm_hostname` always enables remote checks.
2605 Custom variables passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
2608 --------------------------------|-----------------------------------------------------------------------
2609 hpasm_hostname | **Optional.** The host's address. Defaults to "$address$" if the host's `address` attribute is set, "$address6$" otherwise.
2610 hpasm_community | **Optional.** SNMP community of the server (SNMP v1/2 only).
2611 hpasm_protocol | **Optional.** The SNMP protocol to use (default: 2c, other possibilities: 1,3).
2612 hpasm_port | **Optional.** The SNMP port to use (default: 161).
2613 hpasm_blacklist | **Optional.** Blacklist some (missing/failed) components.
2614 hpasm_ignore-dimms | **Optional.** Ignore "N/A"-DIMM status on misc. servers (e.g. older DL320).
2615 hpasm_ignore-fan-redundancy | **Optional.** Ignore missing redundancy partners.
2616 hpasm_customthresholds | **Optional.** Use custom thresholds for certain temperatures.
2617 hpasm_eventrange | **Optional.** Period of time before critical IML events respectively become warnings or vanish. A range is described as a number and a unit (s, m, h, d), e.g. --eventrange 1h/20m.
2618 hpasm_perfdata | **Optional.** Output performance data. If your performance data string becomes too long and is truncated by Nagios, then you can use --perfdata=short instead. This will output temperature tags without location information.
2619 hpasm_username | **Optional.** The securityName for the USM security model (SNMPv3 only).
2620 hpasm_authpassword | **Optional.** The authentication password for SNMPv3.
2621 hpasm_authprotocol | **Optional.** The authentication protocol for SNMPv3 (md5\|sha).
2622 hpasm_privpassword | **Optional.** The password for authPriv security level.
2623 hpasm_privprotocol | **Optional.** The private protocol for SNMPv3 (des\|aes\|aes128\|3des\|3desde).
2624 hpasm_servertype | **Optional.** The type of the server: proliant (default) or bladesystem.
2625 hpasm_eval-nics | **Optional.** Check network interfaces (and groups). Try it and report me whyt you think about it. I need to build up some know how on this subject. If you get an error and think, it is not justified for your configuration, please tell me about it. (always send the output of "snmpwalk -On .... 1.3.6.1.4.1.232" and a description how you setup your nics and why it is correct opposed to the plugins error message.
2626 hpasm_remote | **Optional.** Run remote SNMP checks if enabled. Otherwise checks are executed locally using the `hpasmcli` binary. Defaults to `true`.
2628 #### openmanage <a id="plugin-contrib-command-openmanage"></a>
2630 The [check_openmanage](http://folk.uio.no/trondham/software/check_openmanage.html) plugin
2631 checks the hardware health of Dell PowerEdge (and some PowerVault) servers.
2632 It uses the Dell OpenManage Server Administrator (OMSA) software, which must be running on
2633 the monitored system. check_openmanage can be used remotely with SNMP or locally with icinga2 agent,
2634 check_by_ssh or similar, whichever suits your needs and particular taste.
2636 The plugin checks the health of the storage subsystem, power supplies, memory modules,
2637 temperature probes etc., and gives an alert if any of the components are faulty or operate outside normal parameters.
2639 Custom variables passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
2642 --------------------------------|-----------------------------------------------------------------------
2643 openmanage_all | **Optional.** Check everything, even log content
2644 openmanage_blacklist | **Optional.** Blacklist missing and/or failed components
2645 openmanage_check | **Optional.** Fine-tune which components are checked
2646 openmanage_community | **Optional.** SNMP community string [default=public]
2647 openmanage_config | **Optional.** Specify configuration file
2648 openmanage_critical | **Optional.** Custom temperature critical limits
2649 openmanage_extinfo | **Optional.** Append system info to alerts
2650 openmanage_fahrenheit | **Optional.** Use Fahrenheit as temperature unit
2651 openmanage_hostname | **Optional.** Hostname or IP (required for SNMP)
2652 openmanage_htmlinfo | **Optional.** HTML output with clickable links
2653 openmanage_info | **Optional.** Prefix any alerts with the service tag
2654 openmanage_ipv6 | **Optional.** Use IPv6 instead of IPv4 [default=no]
2655 openmanage_legacy_perfdata | **Optional.** Legacy performance data output
2656 openmanage_no_storage | **Optional.** Don't check storage
2657 openmanage_only | **Optional.** Only check a certain component or alert type
2658 openmanage_perfdata | **Optional.** Output performance data [default=no]
2659 openmanage_port | **Optional.** SNMP port number [default=161]
2660 openmanage_protocol | **Optional.** SNMP protocol version [default=2c]
2661 openmanage_short_state | **Optional.** Prefix alerts with alert state abbreviated
2662 openmanage_show_blacklist | **Optional.** Show blacklistings in OK output
2663 openmanage_state | **Optional.** Prefix alerts with alert state
2664 openmanage_tcp | **Optional.** Use TCP instead of UDP [default=no]
2665 openmanage_timeout | **Optional.** Plugin timeout in seconds [default=30]
2666 openmanage_vdisk_critical | **Optional.** Make any alerts on virtual disks critical
2667 openmanage_warning | **Optional.** Custom temperature warning limits
2669 #### lmsensors <a id="plugin-contrib-command-lmsensors"></a>
2671 The [check_lmsensors](https://github.com/jackbenny/check_temp) plugin,
2672 uses the `lm-sensors` binary to monitor temperature sensors.
2674 Custom variables passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
2677 ------------------------|----------------------------------------------------------------------------------
2678 lmsensors_warning | **Required.** Exit with WARNING status if above INTEGER degrees
2679 lmsensors_critical | **Required.** Exit with CRITICAL status if above INTEGER degrees
2680 lmsensors_sensor | **Optional.** Set what to monitor, for example CPU or MB (or M/B). Check sensors for the correct word. Default is CPU.
2682 #### hddtemp <a id="plugin-contrib-command-hddtemp"></a>
2684 The [check_hddtemp](https://github.com/vint21h/nagios-check-hddtemp) plugin,
2685 uses the `hddtemp` binary to monitor hard drive temperature.
2687 Custom variables passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
2690 ------------------------|----------------------------------------------------------------------------------
2691 hddtemp_server | **Required.** server name or address
2692 hddtemp_port | **Optional.** port number
2693 hddtemp_devices | **Optional.** comma separated devices list, or empty for all devices in hddtemp response
2694 hddtemp_separator | **Optional.** hddtemp separator
2695 hddtemp_warning | **Required.** warning temperature
2696 hddtemp_critical | **Required.** critical temperature
2697 hddtemp_timeout | **Optional.** receiving data from hddtemp operation network timeout
2698 hddtemp_performance | **Optional.** If set, return performance data
2699 hddtemp_quiet | **Optional.** If set, be quiet
2701 The following sane default value are specified:
2703 vars.hddtemp_server = "127.0.0.1"
2704 vars.hddtemp_warning = 55
2705 vars.hddtemp_critical = 60
2706 vars.hddtemp_performance = true
2707 vars.hddtemp_timeout = 5
2710 #### adaptec-raid <a id="plugin-contrib-command-adaptec-raid"></a>
2712 The [check_adaptec_raid](https://github.com/thomas-krenn/check_adaptec_raid) plugin
2713 uses the `arcconf` binary to monitor Adaptec RAID controllers.
2715 Custom variables passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
2718 --------------------------------|-----------------------------------------------------------------------
2719 adaptec_controller_number | **Required.** Controller number to monitor.
2720 arcconf_path | **Required.** Path to the `arcconf` binary, e.g. "/sbin/arcconf".
2722 #### lsi-raid <a id="plugin-contrib-command-lsi-raid"></a>
2724 The [check_lsi_raid](https://github.com/thomas-krenn/check_lsi_raid) plugin
2725 uses the `storcli` binary to monitor MegaRAID RAID controllers.
2727 Custom variables passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
2730 --------------------------------|-----------------------------------------------------------------------
2731 lsi_controller_number | **Optional.** Controller number to monitor.
2732 storcli_path | **Optional.** Path to the `storcli` binary, e.g. "/usr/sbin/storcli".
2733 lsi_enclosure_id | **Optional.** Enclosure numbers to be checked, comma-separated.
2734 lsi_ld_id | **Optional.** Logical devices to be checked, comma-separated.
2735 lsi_pd_id | **Optional.** Physical devices to be checked, comma-separated.
2736 lsi_temp_warning | **Optional.** RAID controller warning temperature.
2737 lsi_temp_critical | **Optional.** RAID controller critical temperature.
2738 lsi_pd_temp_warning | **Optional.** Disk warning temperature.
2739 lsi_pd_temp_critical | **Optional.** Disk critical temperature.
2740 lsi_bbu_temp_warning | **Optional.** Battery warning temperature.
2741 lsi_bbu_temp_critical | **Optional.** Battery critical temperature.
2742 lsi_cv_temp_warning | **Optional.** CacheVault warning temperature.
2743 lsi_cv_temp_critical | **Optional.** CacheVault critical temperature.
2744 lsi_ignored_media_errors | **Optional.** Warning threshold for media errors.
2745 lsi_ignored_other_errors | **Optional.** Warning threshold for other errors.
2746 lsi_ignored_predictive_fails | **Optional.** Warning threshold for predictive failures.
2747 lsi_ignored_shield_counters | **Optional.** Warning threshold for shield counter.
2748 lsi_ignored_bbm_counters | **Optional.** Warning threshold for BBM counter.
2749 lsi_bbu | **Optional.** Define if BBU is present and it's state should be checked.
2750 lsi_noenclosures | **Optional.** If set to true, does not check enclosures.
2751 lsi_nosudo | **Optional.** If set to true, does not use sudo when running storcli.
2752 lsi_nocleanlogs | **Optional.** If set to true, does not clean up the log files after executing storcli checks.
2755 #### smart-attributes <a id="plugin-contrib-command-smart-attributes"></a>
2757 The [check_smart_attributes](https://github.com/thomas-krenn/check_smart_attributes) plugin
2758 uses the `smartctl` binary to monitor SMART values of SSDs and HDDs.
2760 Custom variables passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
2763 --------------------------------|-----------------------------------------------------------------------
2764 smart_attributes_config_path | **Required.** Path to the smart attributes config file (e.g. check_smartdb.json).
2765 smart_attributes_device | **Required.** Device name (e.g. /dev/sda) to monitor.
2768 ### IcingaCLI <a id="plugin-contrib-icingacli"></a>
2770 This category includes all plugins using the icingacli provided by Icinga Web 2.
2772 The user running Icinga 2 needs sufficient permissions to read the Icinga Web 2 configuration directory. e.g. `usermod -a -G icingaweb2 icinga`. You need to restart, not reload Icinga 2 for the new group membership to work.
2774 #### Business Process <a id="plugin-contrib-icingacli-businessprocess"></a>
2776 This subcommand is provided by the [business process module](https://exchange.icinga.com/icinga/Business+Process)
2777 and executed as `icingacli businessprocess` CLI command.
2779 Custom variables passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
2782 ------------------------------------------|-----------------------------------------------------------------------------------------
2783 icingacli_businessprocess_process | **Required.** Business process to monitor.
2784 icingacli_businessprocess_config | **Optional.** Configuration file containing your business process without file extension.
2785 icingacli_businessprocess_details | **Optional.** Get details for root cause analysis. Defaults to false.
2786 icingacli_businessprocess_statetype | **Optional.** Define which state type to look at, `soft` or `hard`. Overrides the default value inside the businessprocess module, if configured.
2788 #### Director <a id="plugin-contrib-icingacli-director"></a>
2790 This 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.
2792 Custom variables passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
2795 ------------------------------------------|-----------------------------------------------------------------------------------------
2796 icingacli_director_check | **Optional.** Run only a specific test suite.
2797 icingacli_director_db | **Optional.** Use a specific Icinga Web DB resource.
2799 #### Elasticsearch <a id="plugin-contrib-icingacli-elasticsearch"></a>
2801 This subcommand is provided by the [elasticsearch_module](https://github.com/Icinga/icingaweb2-module-elasticsearch) and executed as `icingacli elasticsearch check`.
2803 * The value of `icingacli_elasticsearch_instance` is the same like in the configuration of the module.
2804 * 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`
2805 * The thresholds are just numerical values. They get checked against how many events match the filter within the given timeframe.
2806 * The value of `icingacli_elasticsearch_index` is an index pattern. e.g. `logstash*`
2809 ------------------------------------------|-----------------------------------------------------------------------------------------
2810 icingacli_elasticsearch_instance | **Required.** The Elasticsearch to connect to
2811 icingacli_elasticsearch_index | **Required.** Index pattern to use when searching
2812 icingacli_elasticsearch_critical | **Required.** Critical threshold
2813 icingacli_elasticsearch_warning | **Required.** Warning threshold
2814 icingacli_elasticsearch_filter | **Required.** Filter for events
2815 icingacli_elasticsearch_from | **Optional.** Negative value of time to search from now (Default: -5m)
2817 #### x509 <a id="plugin-contrib-icingacli-x509"></a>
2819 This 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.
2821 Custom variables passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
2824 ------------------------------------------|-----------------------------------------------------------------------------------------
2825 icingacli_x509_ip | **Required.** A hosts IP address [or]
2826 icingacli_x509_host | **Required.** A hosts name
2827 icingacli_x509_port | **Optional.** The port to check in particular
2828 icingacli_x509_warning | **Optional.** Less remaining time results in state WARNING (Default: 25%)
2829 icingacli_x509_critical | **Optional.** Less remaining time results in state CRITICAL (Default: 10%)
2830 icingacli_x509_allow_self_signed | **Optional.** Ignore if a certificate or its issuer has been self-signed (Default: false)
2832 ### IPMI Devices <a id="plugin-contrib-ipmi"></a>
2834 This category includes all plugins for IPMI devices.
2836 #### ipmi-sensor <a id="plugin-contrib-command-ipmi-sensor"></a>
2838 The [check_ipmi_sensor](https://github.com/thomas-krenn/check_ipmi_sensor_v3) plugin
2839 uses the `ipmimonitoring` binary to monitor sensor data for IPMI devices. Please
2840 read the [documentation](https://www.thomas-krenn.com/en/wiki/IPMI_Sensor_Monitoring_Plugin)
2841 for installation and configuration details.
2843 Custom variables passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
2846 ---------------------------------|-----------------------------------------------------------------------------------------------------
2847 ipmi_address | **Required.** Specifies the remote host (IPMI device) to check. Defaults to "$address$".
2848 ipmi_config_file | **Optional.** Path to the FreeIPMI configuration file. It should contain IPMI username, IPMI password, and IPMI privilege-level.
2849 ipmi_username | **Optional.** The IPMI username.
2850 ipmi_password | **Optional.** The IPMI password.
2851 ipmi_privilege_level | **Optional.** The IPMI privilege level of the IPMI user.
2852 ipmi_backward_compatibility_mode | **Optional.** Enable backward compatibility mode, useful for FreeIPMI 0.5.\* (this omits FreeIPMI options "--quiet-cache" and "--sdr-cache-recreate").
2853 ipmi_sensor_type | **Optional.** Limit sensors to query based on IPMI sensor type. Examples for IPMI sensor types are 'Fan', 'Temperature' and 'Voltage'.
2854 ipmi_sel_type | **Optional.** Limit SEL entries to specific types, run 'ipmi-sel -L' for a list of types. All sensors are populated to the SEL and per default all sensor types are monitored.
2855 ipmi_exclude_sensor_id | **Optional.** Exclude sensor matching ipmi_sensor_id.
2856 ipmi_exclude_sensor | **Optional.** Exclude sensor based on IPMI sensor type. (Comma-separated)
2857 ipmi_exclude_sel | **Optional.** Exclude SEL entries of specific sensor types. (comma-separated list).
2858 ipmi_sensor_id | **Optional.** Include sensor matching ipmi_sensor_id.
2859 ipmi_protocol_lan_version | **Optional.** Change the protocol LAN version. Defaults to "LAN_2_0".
2860 ipmi_number_of_active_fans | **Optional.** Number of fans that should be active. Otherwise a WARNING state is returned.
2861 ipmi_show_fru | **Optional.** Print the product serial number if it is available in the IPMI FRU data.
2862 ipmi_no_sel_checking | **Optional.** Turn off system event log checking via ipmi-sel.
2863 ipmi_no_thresholds | **Optional.** Turn off performance data thresholds from output-sensor-thresholds.
2864 ipmi_verbose | **Optional.** Be Verbose multi line output, also with additional details for warnings.
2865 ipmi_debug | **Optional.** Be Verbose debugging output, followed by normal multi line output.
2866 ipmi_unify_file | **Optional.** Path to the unify file to unify sensor names.
2868 #### ipmi-alive <a id="plugin-contrib-command-ipmi-alive"></a>
2870 The `ipmi-alive` check commands allows you to create a ping check for the IPMI Interface.
2872 Custom variables passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
2875 ---------------------------------|-----------------------------------------------------------------------------------------------------
2876 ping_address | **Optional.** The address of the IPMI interface. Defaults to "$address$" if the IPMI interface's `address` attribute is set, "$address6$" otherwise.
2877 ping_wrta | **Optional.** The RTA warning threshold in milliseconds. Defaults to 5000.
2878 ping_wpl | **Optional.** The packet loss warning threshold in %. Defaults to 100.
2879 ping_crta | **Optional.** The RTA critical threshold in milliseconds. Defaults to 5000.
2880 ping_cpl | **Optional.** The packet loss critical threshold in %. Defaults to 100.
2881 ping_packets | **Optional.** The number of packets to send. Defaults to 1.
2882 ping_timeout | **Optional.** The plugin timeout in seconds. Defaults to 0 (no timeout).
2885 ### Log Management <a id="plugins-contrib-log-management"></a>
2887 This category includes all plugins for log management, for example [Logstash](https://www.elastic.co/products/logstash).
2889 #### logstash <a id="plugins-contrib-command-logstash"></a>
2891 The [logstash](https://github.com/widhalmt/check_logstash) plugin connects to
2892 the Node API of Logstash. This plugin requires at least Logstash version 5.0.x.
2894 The Node API is not activated by default. You have to configure your Logstash
2895 installation in order to allow plugin connections.
2898 ---------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
2899 logstash_hostname | **Optional.** Hostname where Logstash is running. Defaults to `check_address`
2900 logstash_port | **Optional.** Port where Logstash is listening for API requests. Defaults to 9600
2901 logstash_filedesc_warn | **Optional.** Warning threshold of file descriptor usage in percent. Defaults to 85 (percent).
2902 logstash_filedesc_crit | **Optional.** Critical threshold of file descriptor usage in percent. Defaults to 95 (percent).
2903 logstash_heap_warn | **Optional.** Warning threshold of heap usage in percent. Defaults to 70 (percent).
2904 logstash_heap_crit | **Optional.** Critical threshold of heap usage in percent Defaults to 80 (percent).
2905 logstash_inflight_warn | **Optional.** Warning threshold of inflight events.
2906 logstash_inflight_crit | **Optional.** Critical threshold of inflight events.
2907 logstash_cpu_warn | **Optional.** Warning threshold for cpu usage in percent.
2908 logstash_cpu_crit | **Optional.** Critical threshold for cpu usage in percent.
2910 #### logfiles <a id="plugins-contrib-command-logfiles"></a>
2912 The [logfiles](https://labs.consol.de/nagios/check_logfiles/) plugin finds
2913 specified patterns in log files.
2916 ----------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
2917 logfiles_tag | **Optional.** A short unique descriptor for this search. It will appear in the output of the plugin and is used to separare the different services.
2918 logfiles_logfile | **Optional.** This is the name of the log file you want to scan.
2919 logfiles_rotation | **Optional.** This is the method how log files are rotated. One of the predefined methods or a regular expression, which helps identify the rotated archives. If this key is missing, check_logfiles assumes that the log file will be simply overwritten instead of rotated.
2920 logfiles_critical_pattern | **Optional.** A regular expression which will trigger a critical error.
2921 logfiles_warning_pattern | **Optional.** A regular expression which will trigger a warning error.
2922 logfiles_critical_exception | **Optional.** A regular expression, the exceptions which are not counted as critical errors.
2923 logfiles_warning_exception | **Optional.** A regular expression, the exceptions which are not counted as warning errors.
2924 logfiles_ok_pattern | **Optional.** A regular expression which resets the error counters.
2925 logfiles_no_protocol | **Optional.** Normally all the matched lines are written into a protocol file with this file’s name appearing in the plugin’s output. This option switches this off.
2926 logfiles_syslog_server | **Optional.** With this option you limit the pattern matching to lines originating from the host check_logfiles is running on.
2927 logfiles_syslog_client | **Optional.** With this option you limit the pattern matching to lines originating from the host named in this option.
2928 logfiles_sticky | **Optional.** Errors are propagated through successive runs.
2929 logfiles_unstick | **Optional.** Resets sticky errors.
2930 logfiles_config | **Optional.** The name of a configuration file.
2931 logfiles_configdir | **Optional.** The name of a configuration directory. Configfiles ending in .cfg or .conf are (recursively) imported.
2932 logfiles_searches | **Optional.** A list of tags of those searches which are to be run. Using this parameter, not all searches listed in the config file are run, but only those selected.
2933 logfiles_selectedsearches | **Optional.** A list of tags of those searches which are to be run. Using this parameter, not all searches listed in the config file are run, but only those selected.
2934 logfiles_report | **Optional.** This option turns on multiline output (Default: off). The setting html generates a table which display the last hits in the service details view. Possible values are: short, long, html or off.
2935 logfiles_max_length | **Optional.** With this parameter long lines are truncated (Default: off). Some programs (e.g. TrueScan) generate entries in the eventlog of such a length, that the output of the plugin becomes longer than 1024 characters. NSClient++ discards these.
2936 logfiles_winwarncrit | **Optional.** With this parameter messages in the eventlog are classified by the type WARNING/ERROR (Default: off). Replaces or complements warning/criticalpattern.
2937 logfiles_run_unique | **Optional.** This parameter prevents check_logfiles from starting when there’s already another instance using the same config file. (exits with UNKNOWN).
2938 logfiles_timeout | **Optional.** This parameter causes an abort of a running search after a defined number of seconds. It is an aborted in a controlled manner, so that the lines which have been read so far, are used for the computation of the final result.
2939 logfiles_warning | **Optional.** Complex handler-scripts can be provided with a warning-parameter this way. Inside the scripts the value is accessible as the macro CL_WARNING.
2940 logfiles_critical | **Optional.** Complex handler-scripts can be provided with a critical-parameter this way. Inside the scripts the value is accessible as the macro CL_CRITICAL.
2943 ### Metrics <a id="plugin-contrib-metrics"></a>
2945 This category includes all plugins for metric-based checks.
2947 #### graphite <a id="plugin-contrib-command-graphite"></a>
2949 The [check_graphite](https://github.com/obfuscurity/nagios-scripts) plugin
2950 uses the `rest-client` Ruby library to monitor a [Graphite](https://graphiteapp.org) instance.
2952 Custom variables passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
2955 ------------------------------------|-----------------------------------------------------------------------------------------------------
2956 graphite_url | **Required.** Target url.
2957 graphite_metric | **Required.** Metric path string.
2958 graphite_shortname | **Optional.** Metric short name (used for performance data).
2959 graphite_duration | **Optional.** Length, in minute of data to parse (default: 5).
2960 graphite_function | **Optional.** Function applied to metrics for thresholds (default: average).
2961 graphite_warning | **Required.** Warning threshold.
2962 graphite_critical | **Required.** Critical threshold.
2963 graphite_units | **Optional.** Adds a text tag to the metric count in the plugin output. Useful to identify the metric units. Doesn't affect data queries.
2964 graphite_message | **Optional.** Text message to output (default: "metric count:").
2965 graphite_zero_on_error | **Optional.** Return 0 on a graphite 500 error.
2966 graphite_link_graph | **Optional.** Add a link in the plugin output, showing a 24h graph for this metric in graphite.
2968 ### Network Components <a id="plugin-contrib-network-components"></a>
2970 This category includes all plugins for various network components like routers, switches and firewalls.
2972 #### interfacetable <a id="plugin-contrib-command-interfacetable"></a>
2974 The [check_interfacetable_v3t](http://www.tontonitch.com/tiki/tiki-index.php?page=Nagios+plugins+-+interfacetable_v3t) plugin
2975 generates a html page containing information about the monitored node and all of its interfaces.
2977 The Git repository is located on [GitHub](https://github.com/Tontonitch/interfacetable_v3t).
2979 Custom variables passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
2982 ------------------------------------|-----------------------------------------------------------------------------------------------------
2983 interfacetable_hostquery | **Required.** Specifies the remote host to poll. Defaults to "$address$".
2984 interfacetable_hostdisplay | **Optional.** Specifies the hostname to display in the HTML link. Defaults to "$host.display_name$".
2985 interfacetable_regex | **Optional.** Interface names and property names for some other options will be interpreted as regular expressions. Defaults to false.
2986 interfacetable_outputshort | **Optional.** Reduce the verbosity of the plugin output. Defaults to false.
2987 interfacetable_exclude | **Optional.** Comma separated list of interfaces globally excluded from the monitoring.
2988 interfacetable_include | **Optional.** Comma separated list of interfaces globally included in the monitoring.
2989 interfacetable_aliasmatching | **Optional.** Allow you to specify alias in addition to interface names. Defaults to false.
2990 interfacetable_excludetraffic | **Optional.** Comma separated list of interfaces excluded from traffic checks.
2991 interfacetable_includetraffic | **Optional.** Comma separated list of interfaces included for traffic checks.
2992 interfacetable_warningtraffic | **Optional.** Interface traffic load percentage leading to a warning alert.
2993 interfacetable_criticaltraffic | **Optional.** Interface traffic load percentage leading to a critical alert.
2994 interfacetable_pkt | **Optional.** Add unicast/non-unicast pkt stats for each interface.
2995 interfacetable_trafficwithpkt | **Optional.** Enable traffic calculation using pkt counters instead of octet counters. Useful when using 32-bit counters to track the load on > 1GbE interfaces. Defaults to false.
2996 interfacetable_trackproperty | **Optional.** List of tracked properties.
2997 interfacetable_excludeproperty | **Optional.** Comma separated list of interfaces excluded from the property tracking.
2998 interfacetable_includeproperty | **Optional.** Comma separated list of interfaces included in the property tracking.
2999 interfacetable_community | **Optional.** Specifies the snmp v1/v2c community string. Defaults to "public" if using snmp v1/v2c, ignored using v3.
3000 interfacetable_snmpv2 | **Optional.** Use snmp v2c. Defaults to false.
3001 interfacetable_login | **Optional.** Login for snmpv3 authentication.
3002 interfacetable_passwd | **Optional.** Auth password for snmpv3 authentication.
3003 interfacetable_privpass | **Optional.** Priv password for snmpv3 authentication.
3004 interfacetable_protocols | **Optional.** Authentication protocol,Priv protocol for snmpv3 authentication.
3005 interfacetable_domain | **Optional.** SNMP transport domain.
3006 interfacetable_contextname | **Optional.** Context name for the snmp requests.
3007 interfacetable_port | **Optional.** SNMP port. Defaults to standard port.
3008 interfacetable_64bits | **Optional.** Use SNMP 64-bits counters. Defaults to false.
3009 interfacetable_maxrepetitions | **Optional.** Increasing this value may enhance snmp query performances by gathering more results at one time.
3010 interfacetable_snmptimeout | **Optional.** Define the Transport Layer timeout for the snmp queries.
3011 interfacetable_snmpretries | **Optional.** Define the number of times to retry sending a SNMP message.
3012 interfacetable_snmpmaxmsgsize | **Optional.** Size of the SNMP message in octets, useful in case of too long responses. Be careful with network filters. Range 484 - 65535. Apply only to netsnmp perl bindings. The default is 1472 octets for UDP/IPv4, 1452 octets for UDP/IPv6, 1460 octets for TCP/IPv4, and 1440 octets for TCP/IPv6.
3013 interfacetable_unixsnmp | **Optional.** Use unix snmp utilities for snmp requests. Defaults to false, which means use the perl bindings.
3014 interfacetable_enableperfdata | **Optional.** Enable port performance data. Defaults to false.
3015 interfacetable_perfdataformat | **Optional.** Define which performance data will be generated. Possible values are "full" (default), "loadonly", "globalonly".
3016 interfacetable_perfdatathreshold | **Optional.** Define which thresholds are printed in the generated performance data. Possible values are "full" (default), "loadonly", "globalonly".
3017 interfacetable_perfdatadir | **Optional.** When specified, the performance data are also written directly to a file, in the specified location.
3018 interfacetable_perfdataservicedesc | **Optional.** Specify additional parameters for output performance data to PNP. Defaults to "$service.name$", only affects **interfacetable_perfdatadir**.
3019 interfacetable_grapher | **Optional.** Specify the used graphing solution. Possible values are "pnp4nagios" (default), "nagiosgrapher", "netwaysgrapherv2" and "ingraph".
3020 interfacetable_grapherurl | **Optional.** Graphing system url. Default depends on **interfacetable_grapher**.
3021 interfacetable_portperfunit | **Optional.** Traffic could be reported in bits (counters) or in bps (calculated value).
3022 interfacetable_nodetype | **Optional.** Specify the node type, for specific information to be printed / specific oids to be used. Possible values: "standard" (default), "cisco", "hp", "netscreen", "netapp", "bigip", "bluecoat", "brocade", "brocade-nos", "nortel", "hpux".
3023 interfacetable_duplex | **Optional.** Add the duplex mode property for each interface in the interface table. Defaults to false.
3024 interfacetable_stp | **Optional.** Add the stp state property for each interface in the interface table. Defaults to false.
3025 interfacetable_vlan | **Optional.** Add the vlan attribution property for each interface in the interface table. Defaults to false. This option is available only for the following nodetypes: "cisco", "hp", "nortel"
3026 interfacetable_noipinfo | **Optional.** Remove the ip information for each interface from the interface table. Defaults to false.
3027 interfacetable_alias | **Optional.** Add the alias information for each interface in the interface table. Defaults to false.
3028 interfacetable_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.
3029 interfacetable_htmltablelinktarget | **Optional.** Specifies the windows or the frame where the [details] link will load the generated html page. Possible values are: "_blank", "_self" (default), "_parent", "_top", or a frame name.
3030 interfacetable_delta | **Optional.** Set the delta used for interface throughput calculation in seconds.
3031 interfacetable_ifs | **Optional.** Input field separator. Defaults to ",".
3032 interfacetable_cache | **Optional.** Define the retention time of the cached data in seconds.
3033 interfacetable_noifloadgradient | **Optional.** Disable color gradient from green over yellow to red for the load percentage. Defaults to false.
3034 interfacetable_nohuman | **Optional.** Do not translate bandwidth usage in human readable format. Defaults to false.
3035 interfacetable_snapshot | **Optional.** Force the plugin to run like if it was the first launch. Defaults to false.
3036 interfacetable_timeout | **Optional.** Define the global timeout limit of the plugin in seconds. Defaults to "15s".
3037 interfacetable_css | **Optional.** Define the css stylesheet used by the generated html files. Possible values are "classic", "icinga" or "icinga-alternate1".
3038 interfacetable_config | **Optional.** Specify a config file to load.
3039 interfacetable_noconfigtable | **Optional.** Disable configuration table on the generated HTML page. Defaults to false.
3040 interfacetable_notips | **Optional.** Disable the tips in the generated html tables. Defaults to false.
3041 interfacetable_defaulttablesorting | **Optional.** Default table sorting can be "index" (default) or "name".
3042 interfacetable_tablesplit | **Optional.** Generate multiple interface tables, one per interface type. Defaults to false.
3043 interfacetable_notype | **Optional.** Remove the interface type for each interface. Defaults to false.
3045 #### iftraffic <a id="plugin-contrib-command-iftraffic"></a>
3047 The [check_iftraffic](https://exchange.icinga.com/exchange/iftraffic) plugin
3048 checks the utilization of a given interface name using the SNMP protocol.
3050 Custom variables passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
3053 ------------------------|---------------------------------------------------------
3054 iftraffic_address | **Required.** Specifies the remote host. Defaults to "$address$".
3055 iftraffic_community | **Optional.** SNMP community. Defaults to "public'" if omitted.
3056 iftraffic_version | **Optional.** SNMP version to use. Defaults to "1" if omitted. Requires v1.0.2+.
3057 iftraffic_interface | **Required.** Queried interface name.
3058 iftraffic_bandwidth | **Required.** Interface maximum speed in kilo/mega/giga/bits per second.
3059 iftraffic_units | **Optional.** Interface units can be one of these values: `g` (gigabits/s),`m` (megabits/s), `k` (kilobits/s),`b` (bits/s)
3060 iftraffic_warn | **Optional.** Percent of bandwidth usage necessary to result in warning status (defaults to `85`).
3061 iftraffic_crit | **Optional.** Percent of bandwidth usage necessary to result in critical status (defaults to `98`).
3062 iftraffic_max_counter | **Optional.** Maximum counter value of net devices in kilo/mega/giga/bytes.
3064 #### iftraffic64 <a id="plugin-contrib-command-iftraffic64"></a>
3066 The [check_iftraffic64](https://exchange.icinga.com/exchange/check_iftraffic64) plugin
3067 checks the utilization of a given interface name using the SNMP protocol.
3069 Custom variables passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
3072 ------------------------|---------------------------------------------------------
3073 iftraffic64_address | **Required.** Specifies the remote host. Defaults to "$address$".
3074 iftraffic64_community | **Optional.** SNMP community. Defaults to "public'" if omitted.
3075 iftraffic64_interface | **Required.** Queried interface name.
3076 iftraffic64_bandwidth | **Required.** Interface maximum speed in kilo/mega/giga/bits per second.
3077 iftraffic64_units | **Optional.** Interface units can be one of these values: `g` (gigabits/s),`m` (megabits/s), `k` (kilobits/s),`b` (bits/s)
3078 iftraffic64_warn | **Optional.** Percent of bandwidth usage necessary to result in warning status (defaults to `85`).
3079 iftraffic64_crit | **Optional.** Percent of bandwidth usage necessary to result in critical status (defaults to `98`).
3080 iftraffic64_max_counter | **Optional.** Maximum counter value of net devices in kilo/mega/giga/bytes.
3082 #### interfaces <a id="plugin-contrib-command-interfaces"></a>
3084 The [check_interfaces](https://git.netways.org/plugins/check_interfaces) plugin
3085 uses SNMP to monitor network interfaces and their utilization.
3087 Custom variables passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
3090 --------------------------|---------------------------------------------------------
3091 interfaces_address | **Optional.** The host's address. Defaults to "$address$" if the host's `address` attribute is set, "$address6$" otherwise.
3092 interfaces_regex | **Optional.** Interface list regexp.
3093 interfaces_exclude_regex | **Optional.** Interface list negative regexp.
3094 interfaces_errors | **Optional.** Number of in errors (CRC errors for cisco) to consider a warning (default 50).
3095 interface_out_errors | **Optional.** Number of out errors (collisions for cisco) to consider a warning (default same as in errors).
3096 interfaces_perfdata | **Optional.** perfdata from last check result.
3097 interfaces_prefix | **Optional.** Prefix interface names with this label.
3098 interfaces_lastcheck | **Optional.** Last checktime (unixtime).
3099 interfaces_bandwidth | **Optional.** Bandwidth warn level in percent.
3100 interfaces_speed | **Optional.** Override speed detection with this value (bits per sec).
3101 interfaces_trim | **Optional.** Cut this number of characters from the start of interface descriptions.
3102 interfaces_mode | **Optional.** Special operating mode (default,cisco,nonbulk,bintec).
3103 interfaces_auth_proto | **Optional.** SNMPv3 Auth Protocol (SHA\|MD5)
3104 interfaces_auth_phrase | **Optional.** SNMPv3 Auth Phrase
3105 interfaces_priv_proto | **Optional.** SNMPv3 Privacy Protocol (AES\|DES)
3106 interfaces_priv_phrase | **Optional.** SNMPv3 Privacy Phrase
3107 interfaces_user | **Optional.** SNMPv3 User
3108 interfaces_down_is_ok | **Optional.** Disables critical alerts for down interfaces.
3109 interfaces_aliases | **Optional.** Retrieves the interface description.
3110 interfaces_match_aliases | **Optional.** Also match against aliases (Option --aliases automatically enabled).
3111 interfaces_timeout | **Optional.** Sets the SNMP timeout (in ms).
3112 interfaces_sleep | **Optional.** Sleep between every SNMP query (in ms).
3113 interfaces_names | **Optional.** If set to true, use ifName instead of ifDescr.
3115 #### nwc_health <a id="plugin-contrib-command-nwc_health"></a>
3117 The [check_nwc_health](https://labs.consol.de/de/nagios/check_nwc_health/index.html) plugin
3118 uses SNMP to monitor network components. The plugin is able to generate interface statistics,
3119 check hardware (CPU, memory, fan, power, etc.), monitor firewall policies, HRSP, load-balancer
3120 pools, processor and memory usage.
3122 Currently the following network components are supported: Cisco IOS, Cisco Nexus, Cisco ASA,
3123 Cisco PIX, F5 BIG-IP, CheckPoint Firewall1, Juniper NetScreen, HP Procurve, Nortel, Brocade 4100/4900,
3124 EMC DS 4700, EMC DS 24, Allied Telesyn. Blue Coat SG600, Cisco Wireless Lan Controller 5500,
3125 Brocade ICX6610-24-HPOE, Cisco UC Telefonzeugs, FOUNDRY-SN-AGENT-MIB, FRITZ!BOX 7390, FRITZ!DECT 200,
3126 Juniper IVE, Pulse-Gateway MAG4610, Cisco IronPort AsyncOS, Foundry, etc. A complete list can be
3127 found in the plugin [documentation](https://labs.consol.de/nagios/check_nwc_health/index.html).
3129 Custom variables passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
3132 --------------------------------|---------------------------------------------------------
3133 nwc_health_hostname | **Optional.** The host's address. Defaults to "$address$" if the host's `address` attribute is set, "$address6$" otherwise.
3134 nwc_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).
3135 nwc_health_timeout | **Optional.** Seconds before plugin times out (default: 15)
3136 nwc_health_blacklist | **Optional.** Blacklist some (missing/failed) components.
3137 nwc_health_port | **Optional.** The SNMP port to use (default: 161).
3138 nwc_health_domain | **Optional.** The transport domain to use (default: udp/ipv4, other possible values: udp6, udp/ipv6, tcp, tcp4, tcp/ipv4, tcp6, tcp/ipv6).
3139 nwc_health_protocol | **Optional.** The SNMP protocol to use (default: 2c, other possibilities: 1,3).
3140 nwc_health_community | **Optional.** SNMP community of the server (SNMP v1/2 only).
3141 nwc_health_username | **Optional.** The securityName for the USM security model (SNMPv3 only).
3142 nwc_health_authpassword | **Optional.** The authentication password for SNMPv3.
3143 nwc_health_authprotocol | **Optional.** The authentication protocol for SNMPv3 (md5\|sha).
3144 nwc_health_privpassword | **Optional.** The password for authPriv security level.
3145 nwc_health_privprotocol | **Optional.** The private protocol for SNMPv3 (des\|aes\|aes128\|3des\|3desde).
3146 nwc_health_contextengineid | **Optional.** The context engine id for SNMPv3 (10 to 64 hex characters).
3147 nwc_health_contextname | **Optional.** The context name for SNMPv3 (empty represents the default context).
3148 nwc_health_community2 | **Optional.** SNMP community which can be used to switch the context during runtime.
3149 nwc_health_name | **Optional.** The name of an interface (ifDescr).
3150 nwc_health_drecksptkdb | **Optional.** This parameter must be used instead of --name, because Devel::ptkdb is stealing the latter from the command line.
3151 nwc_health_alias | **Optional.** The alias name of a 64bit-interface (ifAlias)
3152 nwc_health_regexp | **Optional.** A flag indicating that --name is a regular expression
3153 nwc_health_ifspeedin | **Optional.** Override the ifspeed oid of an interface (only inbound)
3154 nwc_health_ifspeedout | **Optional.** Override the ifspeed oid of an interface (only outbound)
3155 nwc_health_ifspeed | **Optional.** Override the ifspeed oid of an interface
3156 nwc_health_units | **Optional.** One of %, B, KB, MB, GB, Bit, KBi, MBi, GBi. (used for e.g. mode interface-usage)
3157 nwc_health_name2 | **Optional.** The secondary name of a component.
3158 nwc_health_name3 | **Optional.** The tertiary name of a component.
3159 nwc_health_role | **Optional.** The role of this device in a hsrp group (active/standby/listen).
3160 nwc_health_report | **Optional.** Can be used to shorten the output. Possible values are: 'long' (default), 'short' (to shorten if available), or 'html' (to produce some html outputs if available)
3161 nwc_health_lookback | **Optional.** The amount of time you want to look back when calculating average rates. Use it for mode interface-errors or interface-usage. Without --lookback the time between two runs of check_nwc_health is the base for calculations. If you want your checkresult to be based for example on the past hour, use --lookback 3600.
3162 nwc_health_warning | **Optional.** The warning threshold
3163 nwc_health_critical | **Optional.** The critical threshold
3164 nwc_health_warningx | **Optional.** The extended warning thresholds
3165 nwc_health_criticalx | **Optional.** The extended critical thresholds
3166 nwc_health_mitigation | **Optional.** The parameter allows you to change a critical error to a warning (1) or ok (0).
3167 nwc_health_selectedperfdata | **Optional.** The parameter allows you to limit the list of performance data. It's a perl regexp. Only matching perfdata show up in the output.
3168 nwc_health_morphperfdata | **Optional.** The parameter allows you to change performance data labels. It's a perl regexp and a substitution. --morphperfdata '(.*)ISATAP(.*)'='$1patasi$2'
3169 nwc_health_negate | **Optional.** The parameter allows you to map exit levels, such as warning=critical.
3170 nwc_health_mymodules-dyn-dir | **Optional.** A directory where own extensions can be found.
3171 nwc_health_servertype | **Optional.** The type of the network device: cisco (default). Use it if auto-detection is not possible.
3172 nwc_health_statefilesdir | **Optional.** An alternate directory where the plugin can save files.
3173 nwc_health_oids | **Optional.** A list of oids which are downloaded and written to a cache file. Use it together with --mode oidcache.
3174 nwc_health_offline | **Optional.** The maximum number of seconds since the last update of cache file before it is considered too old.
3175 nwc_health_multiline | **Optional.** Multiline output
3177 #### printer_health <a id="plugin-contrib-command-printer_health"></a>
3179 The [check_printer_health](https://labs.consol.de/nagios/check_printer_health/index.html) plugin
3180 uses SNMP to monitor printer. The plugin is able to generate supply statistics and check hardware.
3181 A complete list can be found in the plugin [documentation](https://labs.consol.de/nagios/check_printer_health/index.html).
3183 Custom variables passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
3186 --------------------------------|---------------------------------------------------------
3187 printer_health_hostname | **Required.** The host's address. Defaults to "$address$" if the host's `address` attribute is set, "$address6$" otherwise.
3188 printer_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).
3189 printer_health_timeout | **Optional.** Seconds before plugin times out (default: 15)
3190 printer_health_blacklist | **Optional.** Blacklist some (missing/failed) components.
3191 printer_health_port | **Optional.** The SNMP port to use (default: 161).
3192 printer_health_domain | **Optional.** The transport domain to use (default: udp/ipv4, other possible values: udp6, udp/ipv6, tcp, tcp4, tcp/ipv4, tcp6, tcp/ipv6).
3193 printer_health_protocol | **Optional.** The SNMP protocol to use (default: 2c, other possibilities: 1,3).
3194 printer_health_community | **Optional.** SNMP community of the server (SNMP v1/2 only).
3195 printer_health_username | **Optional.** The securityName for the USM security model (SNMPv3 only).
3196 printer_health_authpassword | **Optional.** The authentication password for SNMPv3.
3197 printer_health_authprotocol | **Optional.** The authentication protocol for SNMPv3 (md5\|sha).
3198 printer_health_privpassword | **Optional.** The password for authPriv security level.
3199 printer_health_privprotocol | **Optional.** The private protocol for SNMPv3 (des\|aes\|aes128\|3des\|3desde).
3200 printer_health_contextengineid | **Optional.** The context engine id for SNMPv3 (10 to 64 hex characters).
3201 printer_health_contextname | **Optional.** The context name for SNMPv3 (empty represents the default context).
3202 printer_health_community2 | **Optional.** SNMP community which can be used to switch the context during runtime.
3203 printer_health_name | **Optional.** The name of an interface (ifDescr).
3204 printer_health_regexp | **Optional.** A flag indicating that --name is a regular expression
3205 printer_health_ifspeedin | **Optional.** Override the ifspeed oid of an interface (only inbound)
3206 printer_health_ifspeedout | **Optional.** Override the ifspeed oid of an interface (only outbound)
3207 printer_health_ifspeed | **Optional.** Override the ifspeed oid of an interface
3208 printer_health_units | **Optional.** One of %, B, KB, MB, GB, Bit, KBi, MBi, GBi. (used for e.g. mode interface-usage)
3209 printer_health_name2 | **Optional.** The secondary name of a component.
3210 printer_health_name3 | **Optional.** The teritary name of a component.
3211 printer_health_role | **Optional.** The role of this device in a hsrp group (active/standby/listen).
3212 printer_health_report | **Optional.** Can be used to shorten the output. Possible values are: 'long' (default), 'short' (to shorten if available), or 'html' (to produce some html outputs if available)
3213 printer_health_lookback | **Optional.** The amount of time you want to look back when calculating average rates. Use it for mode interface-errors or interface-usage. Without --lookback the time between two runs of `check_printer_health` is the base for calculations. If you want your checkresult to be based for example on the past hour, use --lookback 3600.
3214 printer_health_warning | **Optional.** The warning threshold
3215 printer_health_critical | **Optional.** The critical threshold
3216 printer_health_warningx | **Optional.** The extended warning thresholds
3217 printer_health_criticalx | **Optional.** The extended critical thresholds
3218 printer_health_mitigation | **Optional.** The parameter allows you to change a critical error to a warning (1) or ok (0).
3219 printer_health_selectedperfdata | **Optional.** The parameter allows you to limit the list of performance data. It's a perl regexp. Only matching perfdata show up in the output.
3220 printer_health_morphperfdata | **Optional.** The parameter allows you to change performance data labels. It's a perl regexp and a substitution. --morphperfdata '(.*)ISATAP(.*)'='$1patasi$2'
3221 printer_health_negate | **Optional.** The parameter allows you to map exit levels, such as warning=critical.
3222 printer_health_mymodules-dyn-dir | **Optional.** A directory where own extensions can be found.
3223 printer_health_servertype | **Optional.** The type of the network device: cisco (default). Use it if auto-detection is not possible.
3224 printer_health_statefilesdir | **Optional.** An alternate directory where the plugin can save files.
3225 printer_health_oids | **Optional.** A list of oids which are downloaded and written to a cache file. Use it together with --mode oidcache.
3226 printer_health_offline | **Optional.** The maximum number of seconds since the last update of cache file before it is considered too old.
3227 printer_health_multiline | **Optional.** Multiline output
3230 ### Network Services <a id="plugin-contrib-network-services"></a>
3232 This category contains plugins which receive details about network services
3234 #### lsyncd <a id="plugin-contrib-command-lsyncd"></a>
3236 The [check_lsyncd](https://github.com/ohitz/check_lsyncd) plugin,
3237 uses the `lsyncd` status file to monitor [lsyncd](https://axkibe.github.io/lsyncd/).
3239 Custom variables passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
3242 ------------------------|---------------------------------------------------------------------------
3243 lsyncd_statfile | **Optional.** Set status file path (default: /var/run/lsyncd.status).
3244 lsyncd_warning | **Optional.** Warning if more than N delays (default: 10).
3245 lsyncd_critical | **Optional.** Critical if more then N delays (default: 100).
3247 #### fail2ban <a id="plugin-contrib-command-fail2ban"></a>
3249 The [check_fail2ban](https://github.com/fail2ban/fail2ban/tree/master/files/nagios) plugin
3250 uses the `fail2ban-client` binary to monitor [fail2ban](http://www.fail2ban.org) jails.
3252 The plugin requires `sudo` permissions.
3253 You can add a sudoers file to allow your monitoring user to use the plugin, i.e. edit /etc/sudoers.d/icinga and add:
3255 icinga ALL=(root) NOPASSWD:/usr/lib/nagios/plugins/check_fail2ban
3258 and set the correct permissions:
3260 chown -c root: /etc/sudoers.d/icinga
3261 chmod -c 0440 /etc/sudoers.d/icinga
3264 Custom variables passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
3267 ------------------------|---------------------------------------------------------------------------
3268 fail2ban_display | **Optional.** To modify the output display, default is 'CHECK FAIL2BAN ACTIVITY'
3269 fail2ban_path | **Optional.** Specify the path to the tw_cli binary, default value is /usr/bin/fail2ban-client
3270 fail2ban_warning | **Optional.** Specify a warning threshold, default is 1
3271 fail2ban_critical | **Optional.** Specify a critical threshold, default is 2
3272 fail2ban_socket | **Optional.** Specify a socket path, default is unset
3273 fail2ban_perfdata | **Optional.** If set to true, activate the perfdata output, default value for the plugin is set to true.
3275 ### Operating System <a id="plugin-contrib-operating-system"></a>
3277 This category contains plugins which receive details about your operating system
3278 or the guest system.
3280 #### mem <a id="plugin-contrib-command-mem"></a>
3282 The [check_mem.pl](https://github.com/justintime/nagios-plugins) plugin checks the
3283 memory usage on linux and unix hosts. It is able to count cache memory as free when
3284 compared to thresholds. More details can be found on [this blog entry](http://sysadminsjourney.com/content/2009/06/04/new-and-improved-checkmempl-nagios-plugin).
3286 Custom variables passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
3289 -------------|-----------------------------------------------------------------------------------------------------------------------
3290 mem_used | **Optional.** Tell the plugin to check for used memory in opposite of **mem_free**. Must specify one of these as true.
3291 mem_free | **Optional.** Tell the plugin to check for free memory in opposite of **mem_used**. Must specify one of these as true.
3292 mem_cache | **Optional.** If set to true, plugin will count cache as free memory. Defaults to false.
3293 mem_warning | **Required.** Specify the warning threshold as number interpreted as percent.
3294 mem_critical | **Required.** Specify the critical threshold as number interpreted as percent.
3296 #### running_kernel <a id="plugin-contrib-command-running_kernel"></a>
3298 The [check_running_kernel](https://packages.debian.org/stretch/nagios-plugins-contrib) plugin
3299 is provided by the `nagios-plugin-contrib` package on Debian/Ubuntu.
3304 ---------------------------|-------------
3305 running\_kernel\_use\_sudo | Whether to run the plugin with `sudo`. Defaults to false except on Ubuntu where it defaults to true.
3307 #### iostats <a id="plugin-contrib-command-iostats"></a>
3309 The [check_iostats](https://github.com/dnsmichi/icinga-plugins/blob/master/scripts/check_iostats) plugin
3310 uses the `iostat` binary to monitor I/O on a Linux host. The default thresholds are rather high
3311 so you can use a grapher for baselining before setting your own.
3313 Custom variables passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
3316 ---------------|-----------------------------------------------------------------------------------------------------------------------
3317 iostats\_disk | **Required.** The device to monitor without path. e.g. sda or vda. (default: sda).
3318 iostats\_warning\_tps | **Required.** Warning threshold for tps (default: 3000).
3319 iostats\_warning\_read | **Required.** Warning threshold for KB/s reads (default: 50000).
3320 iostats\_warning\_write | **Required.** Warning threshold for KB/s writes (default: 10000).
3321 iostats\_warning\_wait | **Required.** Warning threshold for % iowait (default: 50).
3322 iostats\_critical\_tps | **Required.** Critical threshold for tps (default: 5000).
3323 iostats\_critical\_read | **Required.** Critical threshold for KB/s reads (default: 80000).
3324 iostats\_critical\_write | **Required.** Critical threshold for KB/s writes (default: 25000).
3325 iostats\_critical\_wait | **Required.** Critical threshold for % iowait (default: 80).
3327 #### iostat <a id="plugin-contrib-command-iostat"></a>
3329 The [check_iostat](https://github.com/dnsmichi/icinga-plugins/blob/master/scripts/check_iostat) plugin
3330 uses the `iostat` binary to monitor disk I/O on a Linux host. The default thresholds are rather high
3331 so you can use a grapher for baselining before setting your own.
3333 Custom variables passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
3336 ---------------|-----------------------------------------------------------------------------------------------------------------------
3337 iostat\_disk | **Required.** The device to monitor without path. e.g. sda or vda. (default: sda).
3338 iostat\_wtps | **Required.** Warning threshold for tps (default: 100).
3339 iostat\_wread | **Required.** Warning threshold for KB/s reads (default: 100).
3340 iostat\_wwrite | **Required.** Warning threshold for KB/s writes (default: 100).
3341 iostat\_ctps | **Required.** Critical threshold for tps (default: 200).
3342 iostat\_cread | **Required.** Critical threshold for KB/s reads (default: 200).
3343 iostat\_cwrite | **Required.** Critical threshold for KB/s writes (default: 200).
3345 #### yum <a id="plugin-contrib-command-yum"></a>
3347 The [check_yum](https://github.com/calestyo/check_yum) plugin checks the YUM package
3348 management system for package updates.
3349 The plugin requires the `yum-plugin-security` package to differentiate between security and normal updates.
3351 Custom variables passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
3354 ------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
3355 yum_all_updates | **Optional.** Set to true to not distinguish between security and non-security updates, but returns critical for any available update. This may be used if the YUM security plugin is absent or you want to maintain every single package at the latest version. You may want to use **yum_warn_on_any_update** instead of this option. Defaults to false.
3356 yum_warn_on_any_update | **Optional.** Set to true to warn if there are any (non-security) package updates available. Defaults to false.
3357 yum_cache_only | **Optional.** If set to true, plugin runs entirely from cache and does not update the cache when running YUM. Useful if you have `yum makecache` cronned. Defaults to false.
3358 yum_no_warn_on_lock | **Optional.** If set to true, returns OK instead of WARNING when YUM is locked and fails to check for updates due to another instance running. Defaults to false.
3359 yum_no_warn_on_updates | **Optional.** If set to true, returns OK instead of WARNING even when updates are available. The plugin output still shows the number of available updates. Defaults to false.
3360 yum_enablerepo | **Optional.** Explicitly enables a repository when calling YUM. Can take a comma separated list of repositories. Note that enabling repositories can lead to unexpected results, for example when protected repositories are enabled.
3361 yum_disablerepo | **Optional.** Explicitly disables a repository when calling YUM. Can take a comma separated list of repositories. Note that enabling repositories can lead to unexpected results, for example when protected repositories are enabled.
3362 yum_installroot | **Optional.** Specifies another installation root directory (for example a chroot).
3363 yum_timeout | **Optional.** Set a timeout in seconds after which the plugin will exit (defaults to 55 seconds).
3365 ### Storage <a id="plugins-contrib-storage"></a>
3367 This category includes all plugins for various storage and object storage technologies.
3369 #### glusterfs <a id="plugins-contrib-command-glusterfs"></a>
3371 The [glusterfs](https://www.unixadm.org/software/nagios-stuff/checks/check_glusterfs) plugin
3372 is used to check the GlusterFS storage health on the server.
3373 The plugin requires `sudo` permissions.
3375 Custom variables passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
3378 ---------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
3379 glusterfs_perfdata | **Optional.** Print perfdata of all or the specified volume.
3380 glusterfs_warnonfailedheal | **Optional.** Warn if the *heal-failed* log contains entries. The log can be cleared by restarting glusterd.
3381 glusterfs_volume | **Optional.** Only check the specified *VOLUME*. If --volume is not set, all volumes are checked.
3382 glusterfs_disk_warning | **Optional.** Warn if disk usage is above *DISKWARN*. Defaults to 90 (percent).
3383 glusterfs_disk_critical | **Optional.** Return a critical error if disk usage is above *DISKCRIT*. Defaults to 95 (percent).
3384 glusterfs_inode_warning | **Optional.** Warn if inode usage is above *DISKWARN*. Defaults to 90 (percent).
3385 glusterfs_inode_critical | **Optional.** Return a critical error if inode usage is above *DISKCRIT*. Defaults to 95 (percent).
3387 #### ceph <a id="plugins-contrib-command-ceph"></a>
3389 The [ceph plugin](https://github.com/ceph/ceph-nagios-plugins)
3390 is used to check the Ceph storage health on the server.
3392 Custom variables passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
3395 -----------------|---------------------------------------------------------
3396 ceph_exec_dir | **Optional.** Ceph executable. Default /usr/bin/ceph.
3397 ceph_conf_file | **Optional.** Alternative ceph conf file.
3398 ceph_mon_address | **Optional.** Ceph monitor address[:port].
3399 ceph_client_id | **Optional.** Ceph client id.
3400 ceph_client_name | **Optional.** Ceph client name.
3401 ceph_client_key | **Optional.** Ceph client keyring file.
3402 ceph_whitelist | **Optional.** Whitelist regexp for ceph health warnings.
3403 ceph_details | **Optional.** Run 'ceph health detail'.
3405 #### btrfs <a id="plugins-contrib-command-btrfs"></a>
3407 The [btrfs plugin](https://github.com/knorrie/python-btrfs/)
3408 is used to check the btrfs storage health on the server.
3410 The plugin requires `sudo` permissions.
3411 You can add a sudoers file to allow your monitoring user to use the plugin, i.e. edit /etc/sudoers.d/icinga and add:
3413 icinga ALL=(root) NOPASSWD:/usr/lib/nagios/plugins/check_btrfs
3416 and set the correct permissions:
3418 chown -c root: /etc/sudoers.d/icinga
3419 chmod -c 0440 /etc/sudoers.d/icinga
3422 [monitoring-plugins-btrfs](https://packages.debian.org/monitoring-plugins-btrfs) provide the necessary binary on debian/ubuntu.
3424 Custom variables passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
3427 -----------------|---------------------------------------------------------
3428 btrfs_awg | **Optional.** Exit with WARNING status if less than the specified amount of disk space (in GiB) is unallocated
3429 btrfs_acg | **Optional.** Exit with CRITICAL status if less than the specified amount of disk space (in GiB) is unallocated
3430 btrfs_awp | **Optional.** Exit with WARNING status if more than the specified percent of disk space is allocated
3431 btrfs_acp | **Optional.** Exit with CRITICAL status if more than the specified percent of disk space is allocated
3432 btrfs_mountpoint | **Required.** Path to the BTRFS mountpoint
3434 ### Virtualization <a id="plugin-contrib-virtualization"></a>
3436 This category includes all plugins for various virtualization technologies.
3438 #### esxi_hardware <a id="plugin-contrib-command-esxi-hardware"></a>
3440 The [check_esxi_hardware.py](https://www.claudiokuenzler.com/monitoring-plugins/check_esxi_hardware.php) plugin
3441 uses the [pywbem](https://pywbem.github.io/pywbem/) Python library to monitor the hardware of ESXi servers
3442 through the [VMWare API](https://www.vmware.com/support/pubs/sdk_pubs.html) and CIM service.
3444 Custom variables passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
3447 ------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
3448 esxi_hardware_host | **Required.** Specifies the host to monitor. Defaults to "$address$".
3449 esxi_hardware_user | **Required.** Specifies the user for polling. Must be a local user of the root group on the system. Can also be provided as a file path file:/path/to/.passwdfile, then first string of file is used.
3450 esxi_hardware_pass | **Required.** Password of the user. Can also be provided as a file path file:/path/to/.passwdfile, then second string of file is used.
3451 esxi_hardware_port | **Optional.** Specifies the CIM port to connect to. Defaults to 5989.
3452 esxi_hardware_vendor | **Optional.** Defines the vendor of the server: "auto", "dell", "hp", "ibm", "intel", "unknown" (default).
3453 esxi_hardware_html | **Optional.** Add web-links to hardware manuals for Dell servers (use your country extension). Only useful with **esxi_hardware_vendor** = dell.
3454 esxi_hardware_ignore | **Optional.** Comma separated list of CIM elements to ignore.
3455 esxi_hardware_regex | **Optional.** Allow regular expression lookups of elements in ignore list. Defaults to false.
3456 esxi_hardware_perfdata | **Optional.** Add performcedata for graphers like PNP4Nagios to the output. Defaults to false.
3457 esxi_hardware_nopower | **Optional.** Do not collect power performance data, when **esxi_hardware_perfdata** is set to true. Defaults to false.
3458 esxi_hardware_novolts | **Optional.** Do not collect voltage performance data, when **esxi_hardware_perfdata** is set to true. Defaults to false.
3459 esxi_hardware_nocurrent | **Optional.** Do not collect current performance data, when **esxi_hardware_perfdata** is set to true. Defaults to false.
3460 esxi_hardware_notemp | **Optional.** Do not collect temperature performance data, when **esxi_hardware_perfdata** is set to true. Defaults to false.
3461 esxi_hardware_nofan | **Optional.** Do not collect fan performance data, when **esxi_hardware_perfdata** is set to true. Defaults to false.
3462 esxi_hardware_nolcd | **Optional.** Do not collect lcd/display status data. Defaults to false.
3464 #### VMware <a id="plugin-contrib-vmware"></a>
3466 Check commands for the [check_vmware_esx](https://github.com/BaldMansMojo/check_vmware_esx) plugin.
3468 **vmware-esx-dc-volumes**
3470 Check command object for the `check_vmware_esx` plugin. Shows all datastore volumes info.
3472 Custom variables passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
3475 ------------------------|--------------
3476 vmware_datacenter | **Required.** Datacenter/vCenter hostname.
3477 vmware_cluster | **Optional.** ESX or ESXi clustername.
3478 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
3479 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
3480 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
3481 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
3482 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
3483 vmware_sessionfile | **Optional.** Session file name enhancement.
3484 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
3485 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
3486 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
3487 vmware_password | **Optional.** The username's password. No value defined as default.
3488 vmware_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
3489 vmware_subselect | **Optional.** Volume name to be checked the free space.
3490 vmware_gigabyte | **Optional.** Output in GB instead of MB.
3491 vmware_usedspace | **Optional.** Output used space instead of free. Defaults to "false".
3492 vmware_alertonly | **Optional.** List only alerting volumes. Defaults to "false".
3493 vmware_exclude | **Optional.** Blacklist volumes name. No value defined as default.
3494 vmware_include | **Optional.** Whitelist volumes name. No value defined as default.
3495 vmware_isregexp | **Optional.** Treat blacklist and whitelist expressions as regexp.
3496 vmware_dc_volume_used | **Optional.** Output used space instead of free. Defaults to "true".
3497 vmware_warn | **Optional.** The warning threshold for volumes. Defaults to "80%".
3498 vmware_crit | **Optional.** The critical threshold for volumes. Defaults to "90%".
3501 **vmware-esx-dc-runtime-info**
3503 Check command object for the `check_vmware_esx` plugin. Shows all runtime info for the datacenter/Vcenter.
3505 Custom variables passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
3508 ------------------------|--------------
3509 vmware_datacenter | **Required.** Datacenter/vCenter hostname.
3510 vmware_cluster | **Optional.** ESX or ESXi clustername.
3511 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
3512 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
3513 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
3514 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
3515 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
3516 vmware_sessionfile | **Optional.** Session file name enhancement.
3517 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
3518 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
3519 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
3520 vmware_password | **Optional.** The username's password. No value defined as default.
3521 vmware_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
3524 **vmware-esx-dc-runtime-listvms**
3526 Check command object for the `check_vmware_esx` plugin. List of vmware machines and their power state. BEWARE!! In larger environments systems can cause trouble displaying the informations needed due to the mass of data. Use **vmware_alertonly** to avoid this.
3528 Custom variables passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
3531 ------------------------|--------------
3532 vmware_datacenter | **Required.** Datacenter/vCenter hostname.
3533 vmware_cluster | **Optional.** ESX or ESXi clustername.
3534 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
3535 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
3536 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
3537 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
3538 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
3539 vmware_sessionfile | **Optional.** Session file name enhancement.
3540 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
3541 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
3542 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
3543 vmware_password | **Optional.** The username's password. No value defined as default.
3544 vmware_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
3545 vmware_alertonly | **Optional.** List only alerting VMs. Important here to avoid masses of data.
3546 vmware_exclude | **Optional.** Blacklist VMs name. No value defined as default.
3547 vmware_include | **Optional.** Whitelist VMs name. No value defined as default.
3548 vmware_isregexp | **Optional.** Treat blacklist and whitelist expressions as regexp.
3549 vmware_multiline | **Optional.** Multiline output in overview. This mean technically that a multiline output uses a HTML **\<br\>** for the GUI. No value defined as default.
3552 **vmware-esx-dc-runtime-listhost**
3554 Check command object for the `check_vmware_esx` plugin. List of VMware ESX hosts and their power state.
3556 Custom variables passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
3559 ------------------------|--------------
3560 vmware_datacenter | **Required.** Datacenter/vCenter hostname.
3561 vmware_cluster | **Optional.** ESX or ESXi clustername.
3562 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
3563 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
3564 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
3565 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
3566 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
3567 vmware_sessionfile | **Optional.** Session file name enhancement.
3568 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
3569 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
3570 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
3571 vmware_password | **Optional.** The username's password. No value defined as default.
3572 vmware_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
3573 vmware_alertonly | **Optional.** List only alerting hosts. Important here to avoid masses of data.
3574 vmware_exclude | **Optional.** Blacklist VMware ESX hosts. No value defined as default.
3575 vmware_include | **Optional.** Whitelist VMware ESX hosts. No value defined as default.
3576 vmware_isregexp | **Optional.** Treat blacklist and whitelist expressions as regexp.
3577 vmware_multiline | **Optional.** Multiline output in overview. This mean technically that a multiline output uses a HTML **\<br\>** for the GUI. No value defined as default.
3580 **vmware-esx-dc-runtime-listcluster**
3582 Check command object for the `check_vmware_esx` plugin. List of VMware clusters and their states.
3584 Custom variables passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
3587 ------------------------|--------------
3588 vmware_datacenter | **Required.** Datacenter/vCenter hostname.
3589 vmware_cluster | **Optional.** ESX or ESXi clustername.
3590 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
3591 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
3592 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
3593 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
3594 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
3595 vmware_sessionfile | **Optional.** Session file name enhancement.
3596 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
3597 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
3598 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
3599 vmware_password | **Optional.** The username's password. No value defined as default.
3600 vmware_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
3601 vmware_alertonly | **Optional.** List only alerting hosts. Important here to avoid masses of data.
3602 vmware_exclude | **Optional.** Blacklist VMware cluster. No value defined as default.
3603 vmware_include | **Optional.** Whitelist VMware cluster. No value defined as default.
3604 vmware_isregexp | **Optional.** Treat blacklist and whitelist expressions as regexp.
3605 vmware_multiline | **Optional.** Multiline output in overview. This mean technically that a multiline output uses a HTML **\<br\>** for the GUI. No value defined as default.
3608 **vmware-esx-dc-runtime-issues**
3610 Check command object for the `check_vmware_esx` plugin. All issues for the host.
3612 Custom variables passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
3615 ------------------------|--------------
3616 vmware_datacenter | **Required.** Datacenter/vCenter hostname.
3617 vmware_cluster | **Optional.** ESX or ESXi clustername.
3618 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
3619 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
3620 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
3621 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
3622 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
3623 vmware_sessionfile | **Optional.** Session file name enhancement.
3624 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
3625 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
3626 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
3627 vmware_password | **Optional.** The username's password. No value defined as default.
3628 vmware_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
3629 vmware_exclude | **Optional.** Blacklist issues. No value defined as default.
3630 vmware_include | **Optional.** Whitelist issues. No value defined as default.
3631 vmware_isregexp | **Optional.** Treat blacklist and whitelist expressions as regexp.
3632 vmware_multiline | **Optional.** Multiline output in overview. This mean technically that a multiline output uses a HTML **\<br\>** for the GUI. No value defined as default.
3635 **vmware-esx-dc-runtime-status**
3637 Check command object for the `check_vmware_esx` plugin. Overall object status (gray/green/red/yellow).
3639 Custom variables passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
3642 ------------------------|--------------
3643 vmware_datacenter | **Required.** Datacenter/vCenter hostname.
3644 vmware_cluster | **Optional.** ESX or ESXi clustername.
3645 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
3646 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
3647 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
3648 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
3649 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
3650 vmware_sessionfile | **Optional.** Session file name enhancement.
3651 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
3652 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
3653 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
3654 vmware_password | **Optional.** The username's password. No value defined as default.
3655 vmware_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
3658 **vmware-esx-dc-runtime-tools**
3660 Check command object for the `check_vmware_esx` plugin. Vmware Tools status.
3662 Custom variables passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
3665 ------------------------|--------------
3666 vmware_datacenter | **Required.** Datacenter/vCenter hostname.
3667 vmware_cluster | **Optional.** ESX or ESXi clustername.
3668 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
3669 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
3670 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
3671 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
3672 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
3673 vmware_sessionfile | **Optional.** Session file name enhancement.
3674 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
3675 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
3676 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
3677 vmware_password | **Optional.** The username's password. No value defined as default.
3678 vmware_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
3679 vmware_poweredonly | **Optional.** List only VMs which are powered on. No value defined as default.
3680 vmware_alertonly | **Optional.** List only alerting VMs. Important here to avoid masses of data.
3681 vmware_exclude | **Optional.** Blacklist VMs. No value defined as default.
3682 vmware_include | **Optional.** Whitelist VMs. No value defined as default.
3683 vmware_isregexp | **Optional.** Treat blacklist and whitelist expressions as regexp.
3684 vmware_multiline | **Optional.** Multiline output in overview. This mean technically that a multiline output uses a HTML **\<br\>** for the GUI. No value defined as default.
3685 vmware_openvmtools | **Optional** Prevent CRITICAL state for installed and running Open VM Tools.
3688 **vmware-esx-soap-host-check**
3690 Check command object for the `check_vmware_esx` plugin. Simple check to verify a successful connection to VMware SOAP API.
3692 Custom variables passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
3695 ------------------------|--------------
3696 vmware_host | **Required.** ESX or ESXi hostname.
3697 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. In case the check is done through a Datacenter/vCenter host.
3698 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
3699 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
3700 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
3701 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
3702 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
3703 vmware_sessionfile | **Optional.** Session file name enhancement.
3704 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
3705 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
3706 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
3707 vmware_password | **Optional.** The username's password. No value defined as default.
3708 vmware_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
3711 **vmware-esx-soap-host-uptime**
3713 Check command object for the `check_vmware_esx` plugin. Displays uptime of the VMware host.
3715 Custom variables passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
3718 ------------------------|--------------
3719 vmware_host | **Required.** ESX or ESXi hostname.
3720 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. In case the check is done through a Datacenter/vCenter host.
3721 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
3722 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
3723 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
3724 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
3725 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
3726 vmware_sessionfile | **Optional.** Session file name enhancement.
3727 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
3728 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
3729 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
3730 vmware_password | **Optional.** The username's password. No value defined as default.
3731 vmware_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
3734 **vmware-esx-soap-host-cpu**
3736 Check command object for the `check_vmware_esx` plugin. CPU usage in percentage.
3738 Custom variables passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
3741 ------------------------|--------------
3742 vmware_host | **Required.** ESX or ESXi hostname.
3743 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. In case the check is done through a Datacenter/vCenter host.
3744 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
3745 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
3746 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
3747 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
3748 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
3749 vmware_sessionfile | **Optional.** Session file name enhancement.
3750 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
3751 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
3752 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
3753 vmware_password | **Optional.** The username's password. No value defined as default.
3754 vmware_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
3755 vmware_warn | **Optional.** The warning threshold in percent. Defaults to "80%".
3756 vmware_crit | **Optional.** The critical threshold in percent. Defaults to "90%".
3759 **vmware-esx-soap-host-cpu-ready**
3761 Check command object for the `check_vmware_esx` plugin. Percentage of time that the virtual machine was ready, but could not get scheduled to run on the physical CPU. CPU ready time is dependent on the number of virtual machines on the host and their CPU loads. High or growing ready time can be a hint CPU bottlenecks.
3763 Custom variables passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
3766 ------------------------|--------------
3767 vmware_host | **Required.** ESX or ESXi hostname.
3768 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. In case the check is done through a Datacenter/vCenter host.
3769 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
3770 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
3771 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
3772 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
3773 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
3774 vmware_sessionfile | **Optional.** Session file name enhancement.
3775 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
3776 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
3777 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
3778 vmware_password | **Optional.** The username's password. No value defined as default.
3779 vmware_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
3782 **vmware-esx-soap-host-cpu-wait**
3784 Check command object for the `check_vmware_esx` plugin. CPU time spent in wait state. The wait total includes time spent the CPU idle, CPU swap wait, and CPU I/O wait states. High or growing wait time can be a hint I/O bottlenecks.
3786 Custom variables passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
3789 ------------------------|--------------
3790 vmware_host | **Required.** ESX or ESXi hostname.
3791 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. In case the check is done through a Datacenter/vCenter host.
3792 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
3793 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
3794 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
3795 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
3796 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
3797 vmware_sessionfile | **Optional.** Session file name enhancement.
3798 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
3799 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
3800 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
3801 vmware_password | **Optional.** The username's password. No value defined as default.
3802 vmware_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
3805 **vmware-esx-soap-host-cpu-usage**
3807 Check command object for the `check_vmware_esx` plugin. Actively used CPU of the host, as a percentage of the total available CPU. Active CPU is approximately equal to the ratio of the used CPU to the available CPU.
3809 Custom variables passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
3812 ------------------------|--------------
3813 vmware_host | **Required.** ESX or ESXi hostname.
3814 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. In case the check is done through a Datacenter/vCenter host.
3815 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
3816 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
3817 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
3818 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
3819 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
3820 vmware_sessionfile | **Optional.** Session file name enhancement.
3821 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
3822 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
3823 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
3824 vmware_password | **Optional.** The username's password. No value defined as default.
3825 vmware_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
3826 vmware_warn | **Optional.** The warning threshold in percent. Defaults to "80%".
3827 vmware_crit | **Optional.** The critical threshold in percent. Defaults to "90%".
3830 **vmware-esx-soap-host-mem**
3832 Check command object for the `check_vmware_esx` plugin. All mem info(except overall and no thresholds).
3834 Custom variables passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
3837 ------------------------|--------------
3838 vmware_host | **Required.** ESX or ESXi hostname.
3839 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. In case the check is done through a Datacenter/vCenter host.
3840 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
3841 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
3842 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
3843 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
3844 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
3845 vmware_sessionfile | **Optional.** Session file name enhancement.
3846 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
3847 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
3848 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
3849 vmware_password | **Optional.** The username's password. No value defined as default.
3850 vmware_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
3853 **vmware-esx-soap-host-mem-usage**
3855 Check command object for the `check_vmware_esx` plugin. Average mem usage in percentage.
3857 Custom variables passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
3860 ------------------------|--------------
3861 vmware_host | **Required.** ESX or ESXi hostname.
3862 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. In case the check is done through a Datacenter/vCenter host.
3863 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
3864 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
3865 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
3866 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
3867 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
3868 vmware_sessionfile | **Optional.** Session file name enhancement.
3869 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
3870 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
3871 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
3872 vmware_password | **Optional.** The username's password. No value defined as default.
3873 vmware_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
3874 vmware_warn | **Optional.** The warning threshold in percent. Defaults to "80%".
3875 vmware_crit | **Optional.** The critical threshold in percent. Defaults to "90%".
3878 **vmware-esx-soap-host-mem-consumed**
3880 Check command object for the `check_vmware_esx` plugin. Amount of machine memory used on the host. Consumed memory includes Includes memory used by the Service Console, the VMkernel vSphere services, plus the total consumed metrics for all running virtual machines in MB.
3882 Custom variables passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
3885 ------------------------|--------------
3886 vmware_host | **Required.** ESX or ESXi hostname.
3887 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. In case the check is done through a Datacenter/vCenter host.
3888 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
3889 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
3890 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
3891 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
3892 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
3893 vmware_sessionfile | **Optional.** Session file name enhancement.
3894 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
3895 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
3896 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
3897 vmware_password | **Optional.** The username's password. No value defined as default.
3898 vmware_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
3899 vmware_warn | **Optional.** The warning threshold in percent. No value defined as default.
3900 vmware_crit | **Optional.** The critical threshold in percent. No value defined as default.
3903 **vmware-esx-soap-host-mem-swapused**
3905 Check command object for the `check_vmware_esx` plugin. Amount of memory that is used by swap. Sum of memory swapped of all powered on VMs and vSphere services on the host in MB. In case of an error all VMs with their swap used will be displayed.
3907 Custom variables passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
3910 ------------------------|--------------
3911 vmware_host | **Required.** ESX or ESXi hostname.
3912 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. In case the check is done through a Datacenter/vCenter host.
3913 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
3914 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
3915 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
3916 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
3917 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
3918 vmware_sessionfile | **Optional.** Session file name enhancement.
3919 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
3920 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
3921 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
3922 vmware_password | **Optional.** The username's password. No value defined as default.
3923 vmware_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
3924 vmware_warn | **Optional.** The warning threshold in percent. No value defined as default.
3925 vmware_crit | **Optional.** The critical threshold in percent. No value defined as default.
3926 vmware_multiline | **Optional.** Multiline output in overview. This mean technically that a multiline output uses a HTML **\<br\>** for the GUI. No value defined as default.
3929 **vmware-esx-soap-host-mem-overhead**
3931 Check command object for the `check_vmware_esx` plugin. Additional mem used by VM Server in MB.
3933 Custom variables passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
3936 ------------------------|--------------
3937 vmware_host | **Required.** ESX or ESXi hostname.
3938 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. In case the check is done through a Datacenter/vCenter host.
3939 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
3940 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
3941 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
3942 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
3943 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
3944 vmware_sessionfile | **Optional.** Session file name enhancement.
3945 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
3946 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
3947 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
3948 vmware_password | **Optional.** The username's password. No value defined as default.
3949 vmware_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
3950 vmware_warn | **Optional.** The warning threshold in percent. No value defined as default.
3951 vmware_crit | **Optional.** The critical threshold in percent. No value defined as default.
3954 **vmware-esx-soap-host-mem-memctl**
3956 Check command object for the `check_vmware_esx` plugin. The sum of all vmmemctl values in MB for all powered-on virtual machines, plus vSphere services on the host. If the balloon target value is greater than the balloon value, the VMkernel inflates the balloon, causing more virtual machine memory to be reclaimed. If the balloon target value is less than the balloon value, the VMkernel deflates the balloon, which allows the virtual machine to consume additional memory if needed (used by VM memory control driver). In case of an error all VMs with their vmmemctl values will be displayed.
3958 Custom variables passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
3961 ------------------------|--------------
3962 vmware_host | **Required.** ESX or ESXi hostname.
3963 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. In case the check is done through a Datacenter/vCenter host.
3964 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
3965 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
3966 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
3967 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
3968 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
3969 vmware_sessionfile | **Optional.** Session file name enhancement.
3970 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
3971 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
3972 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
3973 vmware_password | **Optional.** The username's password. No value defined as default.
3974 vmware_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
3975 vmware_warn | **Optional.** The warning threshold in percent. No value defined as default.
3976 vmware_crit | **Optional.** The critical threshold in percent. No value defined as default.
3977 vmware_multiline | **Optional.** Multiline output in overview. This mean technically that a multiline output uses a HTML **\<br\>** for the GUI. No value defined as default.
3980 **vmware-esx-soap-host-net**
3982 Check command object for the `check_vmware_esx` plugin. Shows net info.
3984 Custom variables passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
3987 ------------------------|--------------
3988 vmware_host | **Required.** ESX or ESXi hostname.
3989 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. In case the check is done through a Datacenter/vCenter host.
3990 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
3991 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
3992 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
3993 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
3994 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
3995 vmware_sessionfile | **Optional.** Session file name enhancement.
3996 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
3997 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
3998 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
3999 vmware_password | **Optional.** The username's password. No value defined as default.
4000 vmware_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
4001 vmware_exclude | **Optional.** Blacklist NICs. No value defined as default.
4002 vmware_isregexp | **Optional.** Treat blacklist expression as regexp.
4005 **vmware-esx-soap-host-net-usage**
4007 Check command object for the `check_vmware_esx` plugin. Overall network usage in KBps(Kilobytes per Second).
4009 Custom variables passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
4012 ------------------------|--------------
4013 vmware_host | **Required.** ESX or ESXi hostname.
4014 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. In case the check is done through a Datacenter/vCenter host.
4015 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
4016 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
4017 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
4018 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
4019 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
4020 vmware_sessionfile | **Optional.** Session file name enhancement.
4021 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
4022 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
4023 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
4024 vmware_password | **Optional.** The username's password. No value defined as default.
4025 vmware_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
4026 vmware_warn | **Optional.** The warning threshold in KBps(Kilobytes per Second). No value defined as default.
4027 vmware_crit | **Optional.** The critical threshold in KBps(Kilobytes per Second). No value defined as default.
4030 **vmware-esx-soap-host-net-receive**
4032 Check command object for the `check_vmware_esx` plugin. Data receive in KBps(Kilobytes per Second).
4034 Custom variables passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
4037 ------------------------|--------------
4038 vmware_host | **Required.** ESX or ESXi hostname.
4039 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. In case the check is done through a Datacenter/vCenter host.
4040 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
4041 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
4042 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
4043 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
4044 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
4045 vmware_sessionfile | **Optional.** Session file name enhancement.
4046 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
4047 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
4048 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
4049 vmware_password | **Optional.** The username's password. No value defined as default.
4050 vmware_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
4051 vmware_warn | **Optional.** The warning threshold in KBps(Kilobytes per Second). No value defined as default.
4052 vmware_crit | **Optional.** The critical threshold in KBps(Kilobytes per Second). No value defined as default.
4055 **vmware-esx-soap-host-net-send**
4057 Check command object for the `check_vmware_esx` plugin. Data send in KBps(Kilobytes per Second).
4059 Custom variables passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
4062 ------------------------|--------------
4063 vmware_host | **Required.** ESX or ESXi hostname.
4064 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. In case the check is done through a Datacenter/vCenter host.
4065 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
4066 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
4067 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
4068 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
4069 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
4070 vmware_sessionfile | **Optional.** Session file name enhancement.
4071 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
4072 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
4073 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
4074 vmware_password | **Optional.** The username's password. No value defined as default.
4075 vmware_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
4076 vmware_warn | **Optional.** The warning threshold in KBps(Kilobytes per Second). No value defined as default.
4077 vmware_crit | **Optional.** The critical threshold in KBps(Kilobytes per Second). No value defined as default.
4080 **vmware-esx-soap-host-net-nic**
4082 Check command object for the `check_vmware_esx` plugin. Check all active NICs.
4084 Custom variables passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
4087 ------------------------|--------------
4088 vmware_host | **Required.** ESX or ESXi hostname.
4089 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. In case the check is done through a Datacenter/vCenter host.
4090 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
4091 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
4092 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
4093 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
4094 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
4095 vmware_sessionfile | **Optional.** Session file name enhancement.
4096 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
4097 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
4098 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
4099 vmware_password | **Optional.** The username's password. No value defined as default.
4100 vmware_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
4101 vmware_exclude | **Optional.** Blacklist NICs. No value defined as default.
4102 vmware_isregexp | **Optional.** Treat blacklist expression as regexp.
4105 **vmware-esx-soap-host-volumes**
4107 Check command object for the `check_vmware_esx` plugin. Shows all datastore volumes info.
4109 Custom variables passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
4112 ------------------------|--------------
4113 vmware_host | **Required.** ESX or ESXi hostname.
4114 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. In case the check is done through a Datacenter/vCenter host.
4115 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
4116 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
4117 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
4118 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
4119 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
4120 vmware_sessionfile | **Optional.** Session file name enhancement.
4121 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
4122 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
4123 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
4124 vmware_password | **Optional.** The username's password. No value defined as default.
4125 vmware_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
4126 vmware_subselect | **Optional.** Volume name to be checked the free space.
4127 vmware_gigabyte | **Optional.** Output in GB instead of MB.
4128 vmware_usedspace | **Optional.** Output used space instead of free. Defaults to "false".
4129 vmware_alertonly | **Optional.** List only alerting volumes. Defaults to "false".
4130 vmware_exclude | **Optional.** Blacklist volumes name. No value defined as default.
4131 vmware_include | **Optional.** Whitelist volumes name. No value defined as default.
4132 vmware_isregexp | **Optional.** Treat blacklist and whitelist expressions as regexp.
4133 vmware_warn | **Optional.** The warning threshold for volumes. Defaults to "80%".
4134 vmware_crit | **Optional.** The critical threshold for volumes. Defaults to "90%".
4135 vmware_spaceleft | **Optional.** This has to be used in conjunction with thresholds as mentioned above.
4138 **vmware-esx-soap-host-io**
4140 Check command object for the `check_vmware_esx` plugin. Shows all disk io info. Without subselect no thresholds can be given. All I/O values are aggregated from historical intervals over the past 24 hours with a 5 minute sample rate.
4142 Custom variables passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
4145 ------------------------|--------------
4146 vmware_host | **Required.** ESX or ESXi hostname.
4147 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. In case the check is done through a Datacenter/vCenter host.
4148 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
4149 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
4150 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
4151 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
4152 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
4153 vmware_sessionfile | **Optional.** Session file name enhancement.
4154 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
4155 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
4156 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
4157 vmware_password | **Optional.** The username's password. No value defined as default.
4158 vmware_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
4161 **vmware-esx-soap-host-io-aborted**
4163 Check command object for the `check_vmware_esx` plugin. Number of aborted SCSI commands.
4165 Custom variables passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
4168 ------------------------|--------------
4169 vmware_host | **Required.** ESX or ESXi hostname.
4170 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. In case the check is done through a Datacenter/vCenter host.
4171 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
4172 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
4173 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
4174 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
4175 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
4176 vmware_sessionfile | **Optional.** Session file name enhancement.
4177 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
4178 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
4179 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
4180 vmware_password | **Optional.** The username's password. No value defined as default.
4181 vmware_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
4182 vmware_warn | **Optional.** The warning threshold. No value defined as default.
4183 vmware_crit | **Optional.** The critical threshold. No value defined as default.
4186 **vmware-esx-soap-host-io-resets**
4188 Check command object for the `check_vmware_esx` plugin. Number of SCSI bus resets.
4190 Custom variables passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
4193 ------------------------|--------------
4194 vmware_host | **Required.** ESX or ESXi hostname.
4195 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. In case the check is done through a Datacenter/vCenter host.
4196 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
4197 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
4198 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
4199 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
4200 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
4201 vmware_sessionfile | **Optional.** Session file name enhancement.
4202 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
4203 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
4204 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
4205 vmware_password | **Optional.** The username's password. No value defined as default.
4206 vmware_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
4207 vmware_warn | **Optional.** The warning threshold. No value defined as default.
4208 vmware_crit | **Optional.** The critical threshold. No value defined as default.
4211 **vmware-esx-soap-host-io-read**
4213 Check command object for the `check_vmware_esx` plugin. Average number of kilobytes read from the disk each second.
4215 Custom variables passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
4218 ------------------------|--------------
4219 vmware_host | **Required.** ESX or ESXi hostname.
4220 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. In case the check is done through a Datacenter/vCenter host.
4221 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
4222 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
4223 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
4224 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
4225 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
4226 vmware_sessionfile | **Optional.** Session file name enhancement.
4227 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
4228 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
4229 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
4230 vmware_password | **Optional.** The username's password. No value defined as default.
4231 vmware_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
4232 vmware_warn | **Optional.** The warning threshold. No value defined as default.
4233 vmware_crit | **Optional.** The critical threshold. No value defined as default.
4236 **vmware-esx-soap-host-io-read-latency**
4238 Check command object for the `check_vmware_esx` plugin. Average amount of time (ms) to process a SCSI read command issued from the Guest OS to the virtual machine.
4240 Custom variables passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
4243 ------------------------|--------------
4244 vmware_host | **Required.** ESX or ESXi hostname.
4245 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. In case the check is done through a Datacenter/vCenter host.
4246 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
4247 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
4248 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
4249 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
4250 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
4251 vmware_sessionfile | **Optional.** Session file name enhancement.
4252 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
4253 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
4254 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
4255 vmware_password | **Optional.** The username's password. No value defined as default.
4256 vmware_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
4257 vmware_warn | **Optional.** The warning threshold. No value defined as default.
4258 vmware_crit | **Optional.** The critical threshold. No value defined as default.
4261 **vmware-esx-soap-host-io-write**
4263 Check command object for the `check_vmware_esx` plugin. Average number of kilobytes written to disk each second.
4265 Custom variables passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
4268 ------------------------|--------------
4269 vmware_host | **Required.** ESX or ESXi hostname.
4270 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. In case the check is done through a Datacenter/vCenter host.
4271 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
4272 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
4273 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
4274 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
4275 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
4276 vmware_sessionfile | **Optional.** Session file name enhancement.
4277 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
4278 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
4279 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
4280 vmware_password | **Optional.** The username's password. No value defined as default.
4281 vmware_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
4282 vmware_warn | **Optional.** The warning threshold. No value defined as default.
4283 vmware_crit | **Optional.** The critical threshold. No value defined as default.
4286 **vmware-esx-soap-host-io-write-latency**
4288 Check command object for the `check_vmware_esx` plugin. Average amount of time (ms) taken to process a SCSI write command issued by the Guest OS to the virtual machine.
4290 Custom variables passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
4293 ------------------------|--------------
4294 vmware_host | **Required.** ESX or ESXi hostname.
4295 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. In case the check is done through a Datacenter/vCenter host.
4296 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
4297 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
4298 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
4299 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
4300 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
4301 vmware_sessionfile | **Optional.** Session file name enhancement.
4302 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
4303 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
4304 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
4305 vmware_password | **Optional.** The username's password. No value defined as default.
4306 vmware_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
4307 vmware_warn | **Optional.** The warning threshold. No value defined as default.
4308 vmware_crit | **Optional.** The critical threshold. No value defined as default.
4311 **vmware-esx-soap-host-io-usage**
4313 Check command object for the `check_vmware_esx` plugin. Aggregated disk I/O rate. For hosts, this metric includes the rates for all virtual machines running on the host.
4315 Custom variables passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
4318 ------------------------|--------------
4319 vmware_host | **Required.** ESX or ESXi hostname.
4320 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. In case the check is done through a Datacenter/vCenter host.
4321 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
4322 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
4323 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
4324 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
4325 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
4326 vmware_sessionfile | **Optional.** Session file name enhancement.
4327 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
4328 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
4329 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
4330 vmware_password | **Optional.** The username's password. No value defined as default.
4331 vmware_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
4332 vmware_warn | **Optional.** The warning threshold. No value defined as default.
4333 vmware_crit | **Optional.** The critical threshold. No value defined as default.
4336 **vmware-esx-soap-host-io-kernel-latency**
4338 Check command object for the `check_vmware_esx` plugin. Average amount of time (ms) spent by VMkernel processing each SCSI command.
4340 Custom variables passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
4343 ------------------------|--------------
4344 vmware_host | **Required.** ESX or ESXi hostname.
4345 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. In case the check is done through a Datacenter/vCenter host.
4346 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
4347 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
4348 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
4349 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
4350 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
4351 vmware_sessionfile | **Optional.** Session file name enhancement.
4352 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
4353 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
4354 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
4355 vmware_password | **Optional.** The username's password. No value defined as default.
4356 vmware_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
4357 vmware_warn | **Optional.** The warning threshold. No value defined as default.
4358 vmware_crit | **Optional.** The critical threshold. No value defined as default.
4361 **vmware-esx-soap-host-io-device-latency**
4363 Check command object for the `check_vmware_esx` plugin. Average amount of time (ms) to complete a SCSI command from the physical device.
4365 Custom variables passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
4368 ------------------------|--------------
4369 vmware_host | **Required.** ESX or ESXi hostname.
4370 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. In case the check is done through a Datacenter/vCenter host.
4371 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
4372 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
4373 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
4374 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
4375 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
4376 vmware_sessionfile | **Optional.** Session file name enhancement.
4377 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
4378 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
4379 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
4380 vmware_password | **Optional.** The username's password. No value defined as default.
4381 vmware_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
4382 vmware_warn | **Optional.** The warning threshold. No value defined as default.
4383 vmware_crit | **Optional.** The critical threshold. No value defined as default.
4386 **vmware-esx-soap-host-io-queue-latency**
4388 Check command object for the `check_vmware_esx` plugin. Average amount of time (ms) spent in the VMkernel queue.
4390 Custom variables passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
4393 ------------------------|--------------
4394 vmware_host | **Required.** ESX or ESXi hostname.
4395 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. In case the check is done through a Datacenter/vCenter host.
4396 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
4397 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
4398 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
4399 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
4400 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
4401 vmware_sessionfile | **Optional.** Session file name enhancement.
4402 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
4403 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
4404 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
4405 vmware_password | **Optional.** The username's password. No value defined as default.
4406 vmware_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
4407 vmware_warn | **Optional.** The warning threshold. No value defined as default.
4408 vmware_crit | **Optional.** The critical threshold. No value defined as default.
4411 **vmware-esx-soap-host-io-total-latency**
4413 Check command object for the `check_vmware_esx` plugin. Average amount of time (ms) taken during the collection interval to process a SCSI command issued by the guest OS to the virtual machine. The sum of kernelWriteLatency and deviceWriteLatency.
4415 Custom variables passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
4418 ------------------------|--------------
4419 vmware_host | **Required.** ESX or ESXi hostname.
4420 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. In case the check is done through a Datacenter/vCenter host.
4421 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
4422 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
4423 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
4424 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
4425 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
4426 vmware_sessionfile | **Optional.** Session file name enhancement.
4427 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
4428 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
4429 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
4430 vmware_password | **Optional.** The username's password. No value defined as default.
4431 vmware_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
4432 vmware_warn | **Optional.** The warning threshold. No value defined as default.
4433 vmware_crit | **Optional.** The critical threshold. No value defined as default.
4436 **vmware-esx-soap-host-media**
4438 Check command object for the `check_vmware_esx` plugin. List vm's with attached host mounted media like cd,dvd or floppy drives. This is important for monitoring because a virtual machine with a mount cd or dvd drive can not be moved to another host.
4440 Custom variables passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
4443 ------------------------|--------------
4444 vmware_host | **Required.** ESX or ESXi hostname.
4445 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. In case the check is done through a Datacenter/vCenter host.
4446 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
4447 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
4448 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
4449 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
4450 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
4451 vmware_sessionfile | **Optional.** Session file name enhancement.
4452 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
4453 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
4454 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
4455 vmware_password | **Optional.** The username's password. No value defined as default.
4456 vmware_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
4457 vmware_exclude | **Optional.** Blacklist VMs name. No value defined as default.
4458 vmware_include | **Optional.** Whitelist VMs name. No value defined as default.
4459 vmware_isregexp | **Optional.** Treat blacklist and whitelist expressions as regexp.
4460 vmware_multiline | **Optional.** Multiline output in overview. This mean technically that a multiline output uses a HTML **\<br\>** for the GUI. No value defined as default.
4463 **vmware-esx-soap-host-service**
4465 Check command object for the `check_vmware_esx` plugin. Shows host service info.
4467 Custom variables passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
4470 ------------------------|--------------
4471 vmware_host | **Required.** ESX or ESXi hostname.
4472 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. In case the check is done through a Datacenter/vCenter host.
4473 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
4474 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
4475 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
4476 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
4477 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
4478 vmware_sessionfile | **Optional.** Session file name enhancement.
4479 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
4480 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
4481 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
4482 vmware_password | **Optional.** The username's password. No value defined as default.
4483 vmware_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
4484 vmware_exclude | **Optional.** Blacklist services name. No value defined as default.
4485 vmware_include | **Optional.** Whitelist services name. No value defined as default.
4486 vmware_isregexp | **Optional.** Treat blacklist and whitelist expressions as regexp.
4487 vmware_multiline | **Optional.** Multiline output in overview. This mean technically that a multiline output uses a HTML **\<br\>** for the GUI. No value defined as default.
4490 **vmware-esx-soap-host-runtime**
4492 Check command object for the `check_vmware_esx` plugin. Shows runtime info: VMs, overall status, connection state, health, storagehealth, temperature and sensor are represented as one value and without thresholds.
4494 Custom variables passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
4497 ------------------------|--------------
4498 vmware_host | **Required.** ESX or ESXi hostname.
4499 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. In case the check is done through a Datacenter/vCenter host.
4500 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
4501 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
4502 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
4503 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
4504 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
4505 vmware_sessionfile | **Optional.** Session file name enhancement.
4506 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
4507 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
4508 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
4509 vmware_password | **Optional.** The username's password. No value defined as default.
4510 vmware_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
4511 vmware_exclude | **Optional.** Blacklist VMs name. No value defined as default.
4512 vmware_include | **Optional.** Whitelist VMs name. No value defined as default.
4513 vmware_isregexp | **Optional.** Treat blacklist and whitelist expressions as regexp.
4516 **vmware-esx-soap-host-runtime-con**
4518 Check command object for the `check_vmware_esx` plugin. Shows connection state.
4520 Custom variables passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
4523 ------------------------|--------------
4524 vmware_host | **Required.** ESX or ESXi hostname.
4525 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. In case the check is done through a Datacenter/vCenter host.
4526 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
4527 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
4528 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
4529 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
4530 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
4531 vmware_sessionfile | **Optional.** Session file name enhancement.
4532 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
4533 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
4534 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
4535 vmware_password | **Optional.** The username's password. No value defined as default.
4536 vmware_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
4539 **vmware-esx-soap-host-runtime-listvms**
4541 Check command object for the `check_vmware_esx` plugin. List of VMware machines and their status.
4543 Custom variables passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
4546 ------------------------|--------------
4547 vmware_host | **Required.** ESX or ESXi hostname.
4548 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. In case the check is done through a Datacenter/vCenter host.
4549 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
4550 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
4551 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
4552 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
4553 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
4554 vmware_sessionfile | **Optional.** Session file name enhancement.
4555 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
4556 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
4557 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
4558 vmware_password | **Optional.** The username's password. No value defined as default.
4559 vmware_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
4560 vmware_exclude | **Optional.** Blacklist VMs name. No value defined as default.
4561 vmware_include | **Optional.** Whitelist VMs name. No value defined as default.
4562 vmware_isregexp | **Optional.** Treat blacklist and whitelist expressions as regexp.
4563 vmware_multiline | **Optional.** Multiline output in overview. This mean technically that a multiline output uses a HTML **\<br\>** for the GUI. No value defined as default.
4566 **vmware-esx-soap-host-runtime-status**
4568 Check command object for the `check_vmware_esx` plugin. Overall object status (gray/green/red/yellow).
4570 Custom variables passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
4573 ------------------------|--------------
4574 vmware_host | **Required.** ESX or ESXi hostname.
4575 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. In case the check is done through a Datacenter/vCenter host.
4576 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
4577 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
4578 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
4579 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
4580 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
4581 vmware_sessionfile | **Optional.** Session file name enhancement.
4582 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
4583 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
4584 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
4585 vmware_password | **Optional.** The username's password. No value defined as default.
4586 vmware_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
4589 **vmware-esx-soap-host-runtime-health**
4591 Check command object for the `check_vmware_esx` plugin. Checks cpu/storage/memory/sensor status.
4593 Custom variables passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
4596 ------------------------|--------------
4597 vmware_host | **Required.** ESX or ESXi hostname.
4598 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. In case the check is done through a Datacenter/vCenter host.
4599 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
4600 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
4601 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
4602 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
4603 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
4604 vmware_sessionfile | **Optional.** Session file name enhancement.
4605 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
4606 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
4607 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
4608 vmware_password | **Optional.** The username's password. No value defined as default.
4609 vmware_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
4610 vmware_exclude | **Optional.** Blacklist status name. No value defined as default.
4611 vmware_include | **Optional.** Whitelist status name. No value defined as default.
4612 vmware_isregexp | **Optional.** Treat blacklist and whitelist expressions as regexp.
4615 **vmware-esx-soap-host-runtime-health-listsensors**
4617 Check command object for the `check_vmware_esx` plugin. List all available sensors(use for listing purpose only).
4619 Custom variables passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
4622 ------------------------|--------------
4623 vmware_host | **Required.** ESX or ESXi hostname.
4624 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. In case the check is done through a Datacenter/vCenter host.
4625 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
4626 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
4627 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
4628 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
4629 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
4630 vmware_sessionfile | **Optional.** Session file name enhancement.
4631 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
4632 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
4633 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
4634 vmware_password | **Optional.** The username's password. No value defined as default.
4635 vmware_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
4636 vmware_exclude | **Optional.** Blacklist status name. No value defined as default.
4637 vmware_include | **Optional.** Whitelist status name. No value defined as default.
4638 vmware_isregexp | **Optional.** Treat blacklist and whitelist expressions as regexp.
4641 **vmware-esx-soap-host-runtime-health-nostoragestatus**
4643 Check command object for the `check_vmware_esx` plugin. This is to avoid a double alarm if you use **vmware-esx-soap-host-runtime-health** and **vmware-esx-soap-host-runtime-storagehealth**.
4645 Custom variables passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
4648 ------------------------|--------------
4649 vmware_host | **Required.** ESX or ESXi hostname.
4650 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. In case the check is done through a Datacenter/vCenter host.
4651 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
4652 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
4653 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
4654 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
4655 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
4656 vmware_sessionfile | **Optional.** Session file name enhancement.
4657 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
4658 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
4659 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
4660 vmware_password | **Optional.** The username's password. No value defined as default.
4661 vmware_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
4662 vmware_exclude | **Optional.** Blacklist status name. No value defined as default.
4663 vmware_include | **Optional.** Whitelist status name. No value defined as default.
4664 vmware_isregexp | **Optional.** Treat blacklist and whitelist expressions as regexp.
4667 **vmware-esx-soap-host-runtime-storagehealth**
4669 Check command object for the `check_vmware_esx` plugin. Local storage status check.
4671 Custom variables passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
4674 ------------------------|--------------
4675 vmware_host | **Required.** ESX or ESXi hostname.
4676 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. In case the check is done through a Datacenter/vCenter host.
4677 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
4678 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
4679 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
4680 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
4681 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
4682 vmware_sessionfile | **Optional.** Session file name enhancement.
4683 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
4684 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
4685 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
4686 vmware_password | **Optional.** The username's password. No value defined as default.
4687 vmware_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
4688 vmware_exclude | **Optional.** Blacklist storage name. No value defined as default.
4689 vmware_include | **Optional.** Whitelist storage name. No value defined as default.
4690 vmware_isregexp | **Optional.** Treat blacklist and whitelist expressions as regexp.
4691 vmware_multiline | **Optional.** Multiline output in overview. This mean technically that a multiline output uses a HTML **\<br\>** for the GUI. No value defined as default.
4694 **vmware-esx-soap-host-runtime-temp**
4696 Check command object for the `check_vmware_esx` plugin. Lists all temperature sensors.
4698 Custom variables passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
4701 ------------------------|--------------
4702 vmware_host | **Required.** ESX or ESXi hostname.
4703 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. In case the check is done through a Datacenter/vCenter host.
4704 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
4705 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
4706 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
4707 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
4708 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
4709 vmware_sessionfile | **Optional.** Session file name enhancement.
4710 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
4711 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
4712 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
4713 vmware_password | **Optional.** The username's password. No value defined as default.
4714 vmware_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
4715 vmware_exclude | **Optional.** Blacklist sensor name. No value defined as default.
4716 vmware_include | **Optional.** Whitelist sensor name. No value defined as default.
4717 vmware_isregexp | **Optional.** Treat blacklist and whitelist expressions as regexp.
4718 vmware_multiline | **Optional.** Multiline output in overview. This mean technically that a multiline output uses a HTML **\<br\>** for the GUI. No value defined as default.
4721 **vmware-esx-soap-host-runtime-issues**
4723 Check command object for the `check_vmware_esx` plugin. Lists all configuration issues for the host.
4725 Custom variables passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
4728 ------------------------|--------------
4729 vmware_host | **Required.** ESX or ESXi hostname.
4730 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. In case the check is done through a Datacenter/vCenter host.
4731 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
4732 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
4733 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
4734 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
4735 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
4736 vmware_sessionfile | **Optional.** Session file name enhancement.
4737 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
4738 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
4739 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
4740 vmware_password | **Optional.** The username's password. No value defined as default.
4741 vmware_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
4742 vmware_exclude | **Optional.** Blacklist configuration issues. No value defined as default.
4743 vmware_include | **Optional.** Whitelist configuration issues. No value defined as default.
4744 vmware_isregexp | **Optional.** Treat blacklist and whitelist expressions as regexp.
4745 vmware_multiline | **Optional.** Multiline output in overview. This mean technically that a multiline output uses a HTML **\<br\>** for the GUI. No value defined as default.
4748 **vmware-esx-soap-host-storage**
4750 Check command object for the `check_vmware_esx` plugin. Shows Host storage info.
4752 Custom variables passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
4755 ------------------------|--------------
4756 vmware_host | **Required.** ESX or ESXi hostname.
4757 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. In case the check is done through a Datacenter/vCenter host.
4758 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
4759 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
4760 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
4761 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
4762 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
4763 vmware_sessionfile | **Optional.** Session file name enhancement.
4764 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
4765 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
4766 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
4767 vmware_password | **Optional.** The username's password. No value defined as default.
4768 vmware_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
4769 vmware_exclude | **Optional.** Blacklist adapters, luns and paths. No value defined as default.
4770 vmware_include | **Optional.** Whitelist adapters, luns and paths. No value defined as default.
4771 vmware_isregexp | **Optional.** Treat blacklist and whitelist expressions as regexp.
4774 **vmware-esx-soap-host-storage-adapter**
4776 Check command object for the `check_vmware_esx` plugin. List host bus adapters.
4778 Custom variables passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
4781 ------------------------|--------------
4782 vmware_host | **Required.** ESX or ESXi hostname.
4783 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. In case the check is done through a Datacenter/vCenter host.
4784 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
4785 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
4786 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
4787 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
4788 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
4789 vmware_sessionfile | **Optional.** Session file name enhancement.
4790 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
4791 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
4792 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
4793 vmware_password | **Optional.** The username's password. No value defined as default.
4794 vmware_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
4795 vmware_exclude | **Optional.** Blacklist adapters. No value defined as default.
4796 vmware_include | **Optional.** Whitelist adapters. No value defined as default.
4797 vmware_isregexp | **Optional.** Treat blacklist and whitelist expressions as regexp.
4798 vmware_multiline | **Optional.** Multiline output in overview. This mean technically that a multiline output uses a HTML **\<br\>** for the GUI. No value defined as default.
4801 **vmware-esx-soap-host-storage-lun**
4803 Check command object for the `check_vmware_esx` plugin. List SCSI logical units. The listing will include: LUN, canonical name of the disc, all of displayed name which is not part of the canonical name and status.
4805 Custom variables passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
4808 ------------------------|--------------
4809 vmware_host | **Required.** ESX or ESXi hostname.
4810 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. In case the check is done through a Datacenter/vCenter host.
4811 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
4812 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
4813 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
4814 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
4815 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
4816 vmware_sessionfile | **Optional.** Session file name enhancement.
4817 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
4818 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
4819 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
4820 vmware_password | **Optional.** The username's password. No value defined as default.
4821 vmware_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
4822 vmware_exclude | **Optional.** Blacklist luns. No value defined as default.
4823 vmware_include | **Optional.** Whitelist luns. No value defined as default.
4824 vmware_isregexp | **Optional.** Treat blacklist and whitelist expressions as regexp.
4825 vmware_multiline | **Optional.** Multiline output in overview. This mean technically that a multiline output uses a HTML **\<br\>** for the GUI. No value defined as default.
4828 **vmware-esx-soap-host-storage-path**
4830 Check command object for the `check_vmware_esx` plugin. List multipaths and the associated paths.
4832 Custom variables passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
4835 ------------------------|--------------
4836 vmware_host | **Required.** ESX or ESXi hostname.
4837 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. In case the check is done through a Datacenter/vCenter host.
4838 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
4839 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
4840 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
4841 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
4842 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
4843 vmware_sessionfile | **Optional.** Session file name enhancement.
4844 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
4845 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
4846 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
4847 vmware_password | **Optional.** The username's password. No value defined as default.
4848 vmware_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
4849 vmware_alertonly | **Optional.** List only alerting units. Important here to avoid masses of data. Defaults to "false".
4850 vmware_exclude | **Optional.** Blacklist paths. No value defined as default.
4851 vmware_include | **Optional.** Whitelist paths. No value defined as default.
4852 vmware_isregexp | **Optional.** Treat blacklist and whitelist expressions as regexp.
4853 vmware_multiline | **Optional.** Multiline output in overview. This mean technically that a multiline output uses a HTML **\<br\>** for the GUI. No value defined as default.
4854 vmware_standbyok | **Optional.** For storage systems where a standby multipath is ok and not a warning. Defaults to false.
4857 **vmware-esx-soap-vm-cpu**
4859 Check command object for the `check_vmware_esx` plugin. Shows all CPU usage info.
4861 Custom variables passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
4864 ------------------------|--------------
4865 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. Conflicts with **vmware_host**.
4866 vmware_host | **Optional.** ESX or ESXi hostname. Conflicts with **vmware_datacenter**.
4867 vmware_vmname | **Required.** Virtual machine name.
4868 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
4869 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
4870 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
4871 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
4872 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
4873 vmware_sessionfile | **Optional.** Session file name enhancement.
4874 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
4875 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
4876 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
4877 vmware_password | **Optional.** The username's password. No value defined as default.
4878 vmware_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
4882 **vmware-esx-soap-vm-cpu-ready**
4884 Check command object for the `check_vmware_esx` plugin. Percentage of time that the virtual machine was ready, but could not get scheduled to run on the physical CPU.
4886 Custom variables passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
4889 ------------------------|--------------
4890 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. Conflicts with **vmware_host**.
4891 vmware_host | **Optional.** ESX or ESXi hostname. Conflicts with **vmware_datacenter**.
4892 vmware_vmname | **Required.** Virtual machine name.
4893 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
4894 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
4895 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
4896 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
4897 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
4898 vmware_sessionfile | **Optional.** Session file name enhancement.
4899 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
4900 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
4901 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
4902 vmware_password | **Optional.** The username's password. No value defined as default.
4903 vmware_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
4904 vmware_warn | **Optional.** The warning threshold. No value defined as default.
4905 vmware_crit | **Optional.** The critical threshold. No value defined as default.
4908 **vmware-esx-soap-vm-cpu-wait**
4910 Check command object for the `check_vmware_esx` plugin. CPU time spent in wait state. The wait total includes time spent the CPU idle, CPU swap wait, and CPU I/O wait states. High or growing wait time can be a hint I/O bottlenecks.
4912 Custom variables passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
4915 ------------------------|--------------
4916 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. Conflicts with **vmware_host**.
4917 vmware_host | **Optional.** ESX or ESXi hostname. Conflicts with **vmware_datacenter**.
4918 vmware_vmname | **Required.** Virtual machine name.
4919 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
4920 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
4921 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
4922 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
4923 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
4924 vmware_sessionfile | **Optional.** Session file name enhancement.
4925 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
4926 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
4927 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
4928 vmware_password | **Optional.** The username's password. No value defined as default.
4929 vmware_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
4930 vmware_warn | **Optional.** The warning threshold. No value defined as default.
4931 vmware_crit | **Optional.** The critical threshold. No value defined as default.
4934 **vmware-esx-soap-vm-cpu-usage**
4936 Check command object for the `check_vmware_esx` plugin. Amount of actively used virtual CPU, as a percentage of total available CPU. This is the host's view of the CPU usage, not the guest operating system view. It is the average CPU utilization over all available virtual CPUs in the virtual machine.
4938 Custom variables passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
4941 ------------------------|--------------
4942 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. Conflicts with **vmware_host**.
4943 vmware_host | **Optional.** ESX or ESXi hostname. Conflicts with **vmware_datacenter**.
4944 vmware_vmname | **Required.** Virtual machine name.
4945 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
4946 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
4947 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
4948 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
4949 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
4950 vmware_sessionfile | **Optional.** Session file name enhancement.
4951 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
4952 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
4953 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
4954 vmware_password | **Optional.** The username's password. No value defined as default.
4955 vmware_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
4956 vmware_warn | **Optional.** Warning threshold in percent. Defaults to "80%".
4957 vmware_crit | **Optional.** Critical threshold in percent. Defaults to "90%".
4960 **vmware-esx-soap-vm-mem**
4962 Check command object for the `check_vmware_esx` plugin. Shows all memory info, except overall.
4964 Custom variables passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
4967 ------------------------|--------------
4968 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. Conflicts with **vmware_host**.
4969 vmware_host | **Optional.** ESX or ESXi hostname. Conflicts with **vmware_datacenter**.
4970 vmware_vmname | **Required.** Virtual machine name.
4971 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
4972 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
4973 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
4974 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
4975 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
4976 vmware_sessionfile | **Optional.** Session file name enhancement.
4977 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
4978 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
4979 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
4980 vmware_password | **Optional.** The username's password. No value defined as default.
4981 vmware_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
4984 **vmware-esx-soap-vm-mem-usage**
4986 Check command object for the `check_vmware_esx` plugin. Average mem usage in percentage of configured virtual machine "physical" memory.
4988 Custom variables passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
4991 ------------------------|--------------
4992 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. Conflicts with **vmware_host**.
4993 vmware_host | **Optional.** ESX or ESXi hostname. Conflicts with **vmware_datacenter**.
4994 vmware_vmname | **Required.** Virtual machine name.
4995 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
4996 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
4997 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
4998 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
4999 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
5000 vmware_sessionfile | **Optional.** Session file name enhancement.
5001 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
5002 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
5003 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
5004 vmware_password | **Optional.** The username's password. No value defined as default.
5005 vmware_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
5006 vmware_warn | **Optional.** Warning threshold in percent. Defaults to "80%".
5007 vmware_crit | **Optional.** Critical threshold in percent. Defaults to "90%".
5010 **vmware-esx-soap-vm-mem-consumed**
5012 Check command object for the `check_vmware_esx` plugin. Amount of guest physical memory in MB consumed by the virtual machine for guest memory. Consumed memory does not include overhead memory. It includes shared memory and memory that might be reserved, but not actually used. Use this metric for charge-back purposes.<br>
5013 **vm consumed memory = memory granted -- memory saved**
5015 Custom variables passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
5018 ------------------------|--------------
5019 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. Conflicts with **vmware_host**.
5020 vmware_host | **Optional.** ESX or ESXi hostname. Conflicts with **vmware_datacenter**.
5021 vmware_vmname | **Required.** Virtual machine name.
5022 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
5023 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
5024 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
5025 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
5026 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
5027 vmware_sessionfile | **Optional.** Session file name enhancement.
5028 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
5029 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
5030 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
5031 vmware_password | **Optional.** The username's password. No value defined as default.
5032 vmware_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
5033 vmware_warn | **Optional.** The warning threshold. No value defined as default.
5034 vmware_crit | **Optional.** The critical threshold. No value defined as default.
5037 **vmware-esx-soap-vm-mem-memctl**
5039 Check command object for the `check_vmware_esx` plugin. Amount of guest physical memory that is currently reclaimed from the virtual machine through ballooning. This is the amount of guest physical memory that has been allocated and pinned by the balloon driver.
5041 Custom variables passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
5044 ------------------------|--------------
5045 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. Conflicts with **vmware_host**.
5046 vmware_host | **Optional.** ESX or ESXi hostname. Conflicts with **vmware_datacenter**.
5047 vmware_vmname | **Required.** Virtual machine name.
5048 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
5049 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
5050 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
5051 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
5052 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
5053 vmware_sessionfile | **Optional.** Session file name enhancement.
5054 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
5055 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
5056 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
5057 vmware_password | **Optional.** The username's password. No value defined as default.
5058 vmware_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
5059 vmware_warn | **Optional.** The warning threshold. No value defined as default.
5060 vmware_crit | **Optional.** The critical threshold. No value defined as default.
5064 **vmware-esx-soap-vm-net**
5066 Check command object for the `check_vmware_esx` plugin. Shows net info.
5068 Custom variables passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
5071 ------------------------|--------------
5072 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. Conflicts with **vmware_host**.
5073 vmware_host | **Optional.** ESX or ESXi hostname. Conflicts with **vmware_datacenter**.
5074 vmware_vmname | **Required.** Virtual machine name.
5075 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
5076 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
5077 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
5078 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
5079 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
5080 vmware_sessionfile | **Optional.** Session file name enhancement.
5081 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
5082 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
5083 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
5084 vmware_password | **Optional.** The username's password. No value defined as default.
5085 vmware_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
5088 **vmware-esx-soap-vm-net-usage**
5090 Check command object for the `check_vmware_esx` plugin. Overall network usage in KBps(Kilobytes per Second).
5092 Custom variables passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
5095 ------------------------|--------------
5096 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. Conflicts with **vmware_host**.
5097 vmware_host | **Optional.** ESX or ESXi hostname. Conflicts with **vmware_datacenter**.
5098 vmware_vmname | **Required.** Virtual machine name.
5099 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
5100 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
5101 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
5102 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
5103 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
5104 vmware_sessionfile | **Optional.** Session file name enhancement.
5105 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
5106 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
5107 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
5108 vmware_password | **Optional.** The username's password. No value defined as default.
5109 vmware_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
5110 vmware_warn | **Optional.** The warning threshold. No value defined as default.
5111 vmware_crit | **Optional.** The critical threshold. No value defined as default.
5114 **vmware-esx-soap-vm-net-receive**
5116 Check command object for the `check_vmware_esx` plugin. Receive in KBps(Kilobytes per Second).
5118 Custom variables passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
5121 ------------------------|--------------
5122 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. Conflicts with **vmware_host**.
5123 vmware_host | **Optional.** ESX or ESXi hostname. Conflicts with **vmware_datacenter**.
5124 vmware_vmname | **Required.** Virtual machine name.
5125 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
5126 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
5127 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
5128 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
5129 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
5130 vmware_sessionfile | **Optional.** Session file name enhancement.
5131 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
5132 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
5133 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
5134 vmware_password | **Optional.** The username's password. No value defined as default.
5135 vmware_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
5136 vmware_warn | **Optional.** The warning threshold. No value defined as default.
5137 vmware_crit | **Optional.** The critical threshold. No value defined as default.
5140 **vmware-esx-soap-vm-net-send**
5142 Check command object for the `check_vmware_esx` plugin. Send in KBps(Kilobytes per Second).
5144 Custom variables passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
5147 ------------------------|--------------
5148 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. Conflicts with **vmware_host**.
5149 vmware_host | **Optional.** ESX or ESXi hostname. Conflicts with **vmware_datacenter**.
5150 vmware_vmname | **Required.** Virtual machine name.
5151 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
5152 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
5153 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
5154 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
5155 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
5156 vmware_sessionfile | **Optional.** Session file name enhancement.
5157 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
5158 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
5159 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
5160 vmware_password | **Optional.** The username's password. No value defined as default.
5161 vmware_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
5162 vmware_warn | **Optional.** The warning threshold. No value defined as default.
5163 vmware_crit | **Optional.** The critical threshold. No value defined as default.
5166 **vmware-esx-soap-vm-io**
5168 Check command object for the `check_vmware_esx` plugin. Shows all disk io info. Without subselect no thresholds can be given. All I/O values are aggregated from historical intervals over the past 24 hours with a 5 minute sample rate.
5170 Custom variables passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
5173 ------------------------|--------------
5174 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. Conflicts with **vmware_host**.
5175 vmware_host | **Optional.** ESX or ESXi hostname. Conflicts with **vmware_datacenter**.
5176 vmware_vmname | **Required.** Virtual machine name.
5177 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
5178 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
5179 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
5180 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
5181 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
5182 vmware_sessionfile | **Optional.** Session file name enhancement.
5183 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
5184 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
5185 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
5186 vmware_password | **Optional.** The username's password. No value defined as default.
5187 vmware_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
5190 **vmware-esx-soap-vm-io-read**
5192 Check command object for the `check_vmware_esx` plugin. Average number of kilobytes read from the disk each second.
5194 Custom variables passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
5197 ------------------------|--------------
5198 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. Conflicts with **vmware_host**.
5199 vmware_host | **Optional.** ESX or ESXi hostname. Conflicts with **vmware_datacenter**.
5200 vmware_vmname | **Required.** Virtual machine name.
5201 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
5202 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
5203 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
5204 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
5205 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
5206 vmware_sessionfile | **Optional.** Session file name enhancement.
5207 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
5208 vmware_nosession | **Optional.** No auth session - IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
5209 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
5210 vmware_password | **Optional.** The username's password. No value defined as default.
5211 vmware_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
5212 vmware_warn | **Optional.** The warning threshold. No value defined as default.
5213 vmware_crit | **Optional.** The critical threshold. No value defined as default.
5216 **vmware-esx-soap-vm-io-write**
5218 Check command object for the `check_vmware_esx` plugin. Average number of kilobytes written to disk each second.
5220 Custom variables passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
5223 ------------------------|--------------
5224 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. Conflicts with **vmware_host**.
5225 vmware_host | **Optional.** ESX or ESXi hostname. Conflicts with **vmware_datacenter**.
5226 vmware_vmname | **Required.** Virtual machine name.
5227 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
5228 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
5229 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
5230 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
5231 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
5232 vmware_sessionfile | **Optional.** Session file name enhancement.
5233 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
5234 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
5235 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
5236 vmware_password | **Optional.** The username's password. No value defined as default.
5237 vmware_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
5238 vmware_warn | **Optional.** The warning threshold. No value defined as default.
5239 vmware_crit | **Optional.** The critical threshold. No value defined as default.
5242 **vmware-esx-soap-vm-io-usage**
5244 Check command object for the `check_vmware_esx` plugin. Aggregated disk I/O rate.
5246 Custom variables passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
5249 ------------------------|--------------
5250 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. Conflicts with **vmware_host**.
5251 vmware_host | **Optional.** ESX or ESXi hostname. Conflicts with **vmware_datacenter**.
5252 vmware_vmname | **Required.** Virtual machine name.
5253 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
5254 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
5255 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
5256 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
5257 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
5258 vmware_sessionfile | **Optional.** Session file name enhancement.
5259 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
5260 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
5261 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
5262 vmware_password | **Optional.** The username's password. No value defined as default.
5263 vmware_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
5264 vmware_warn | **Optional.** The warning threshold. No value defined as default.
5265 vmware_crit | **Optional.** The critical threshold. No value defined as default.
5268 **vmware-esx-soap-vm-runtime**
5270 Check command object for the `check_vmware_esx` plugin. Shows virtual machine runtime info.
5272 Custom variables passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
5275 ------------------------|--------------
5276 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. Conflicts with **vmware_host**.
5277 vmware_host | **Optional.** ESX or ESXi hostname. Conflicts with **vmware_datacenter**.
5278 vmware_vmname | **Required.** Virtual machine name.
5279 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
5280 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
5281 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
5282 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
5283 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
5284 vmware_sessionfile | **Optional.** Session file name enhancement.
5285 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
5286 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
5287 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
5288 vmware_password | **Optional.** The username's password. No value defined as default.
5289 vmware_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
5292 **vmware-esx-soap-vm-runtime-con**
5294 Check command object for the `check_vmware_esx` plugin. Shows the connection state.
5296 Custom variables passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
5299 ------------------------|--------------
5300 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. Conflicts with **vmware_host**.
5301 vmware_host | **Optional.** ESX or ESXi hostname. Conflicts with **vmware_datacenter**.
5302 vmware_vmname | **Required.** Virtual machine name.
5303 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
5304 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
5305 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
5306 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
5307 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
5308 vmware_sessionfile | **Optional.** Session file name enhancement.
5309 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
5310 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
5311 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
5312 vmware_password | **Optional.** The username's password. No value defined as default.
5313 vmware_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
5316 **vmware-esx-soap-vm-runtime-powerstate**
5318 Check command object for the `check_vmware_esx` plugin. Shows virtual machine power state: poweredOn, poweredOff or suspended.
5320 Custom variables passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
5323 ------------------------|--------------
5324 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. Conflicts with **vmware_host**.
5325 vmware_host | **Optional.** ESX or ESXi hostname. Conflicts with **vmware_datacenter**.
5326 vmware_vmname | **Required.** Virtual machine name.
5327 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
5328 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
5329 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
5330 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
5331 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
5332 vmware_sessionfile | **Optional.** Session file name enhancement.
5333 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
5334 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
5335 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
5336 vmware_password | **Optional.** The username's password. No value defined as default.
5337 vmware_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
5340 **vmware-esx-soap-vm-runtime-status**
5342 Check command object for the `check_vmware_esx` plugin. Overall object status (gray/green/red/yellow).
5344 Custom variables passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
5347 ------------------------|--------------
5348 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. Conflicts with **vmware_host**.
5349 vmware_host | **Optional.** ESX or ESXi hostname. Conflicts with **vmware_datacenter**.
5350 vmware_vmname | **Required.** Virtual machine name.
5351 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
5352 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
5353 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
5354 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
5355 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
5356 vmware_sessionfile | **Optional.** Session file name enhancement.
5357 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
5358 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
5359 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
5360 vmware_password | **Optional.** The username's password. No value defined as default.
5361 vmware_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
5364 **vmware-esx-soap-vm-runtime-consoleconnections**
5366 Check command object for the `check_vmware_esx` plugin. Console connections to virtual machine.
5368 Custom variables passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
5371 ------------------------|--------------
5372 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. Conflicts with **vmware_host**.
5373 vmware_host | **Optional.** ESX or ESXi hostname. Conflicts with **vmware_datacenter**.
5374 vmware_vmname | **Required.** Virtual machine name.
5375 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
5376 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
5377 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
5378 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
5379 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
5380 vmware_sessionfile | **Optional.** Session file name enhancement.
5381 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
5382 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
5383 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
5384 vmware_password | **Optional.** The username's password. No value defined as default.
5385 vmware_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
5386 vmware_warn | **Optional.** The warning threshold. No value defined as default.
5387 vmware_crit | **Optional.** The critical threshold. No value defined as default.
5390 **vmware-esx-soap-vm-runtime-gueststate**
5392 Check command object for the `check_vmware_esx` plugin. Guest OS status. Needs VMware Tools installed and running.
5394 Custom variables passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
5397 ------------------------|--------------
5398 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. Conflicts with **vmware_host**.
5399 vmware_host | **Optional.** ESX or ESXi hostname. Conflicts with **vmware_datacenter**.
5400 vmware_vmname | **Required.** Virtual machine name.
5401 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
5402 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
5403 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
5404 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
5405 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
5406 vmware_sessionfile | **Optional.** Session file name enhancement.
5407 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
5408 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
5409 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
5410 vmware_password | **Optional.** The username's password. No value defined as default.
5411 vmware_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
5413 **vmware-esx-soap-vm-runtime-tools**
5415 Check command object for the `check_vmware_esx` plugin. Guest OS status. VMware tools status.
5417 Custom variables passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
5420 ------------------------|--------------
5421 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. Conflicts with **vmware_host**.
5422 vmware_host | **Optional.** ESX or ESXi hostname. Conflicts with **vmware_datacenter**.
5423 vmware_vmname | **Required.** Virtual machine name.
5424 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
5425 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
5426 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
5427 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
5428 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
5429 vmware_sessionfile | **Optional.** Session file name enhancement.
5430 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
5431 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
5432 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
5433 vmware_password | **Optional.** The username's password. No value defined as default.
5434 vmware_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
5435 vmware_openvmtools | **Optional** Prevent CRITICAL state for installed and running Open VM Tools.
5438 **vmware-esx-soap-vm-runtime-issues**
5440 Check command object for the `check_vmware_esx` plugin. All issues for the virtual machine.
5442 Custom variables passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
5445 ------------------------|--------------
5446 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. Conflicts with **vmware_host**.
5447 vmware_host | **Optional.** ESX or ESXi hostname. Conflicts with **vmware_datacenter**.
5448 vmware_vmname | **Required.** Virtual machine name.
5449 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
5450 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
5451 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
5452 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
5453 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
5454 vmware_sessionfile | **Optional.** Session file name enhancement.
5455 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
5456 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
5457 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
5458 vmware_password | **Optional.** The username's password. No value defined as default.
5459 vmware_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
5460 vmware_multiline | **Optional.** Multiline output in overview. This mean technically that a multiline output uses a HTML **\<br\>** for the GUI. No value defined as default.
5463 ### Web <a id="plugin-contrib-web"></a>
5465 This category includes all plugins for web-based checks.
5467 #### apache-status <a id="plugin-contrib-command-apache-status"></a>
5469 The [check_apache_status.pl](https://github.com/lbetz/check_apache_status) plugin
5470 uses the [/server-status](https://httpd.apache.org/docs/current/mod/mod_status.html)
5471 HTTP endpoint to monitor status metrics for the Apache webserver.
5473 Custom variables passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
5476 --------------------------------|----------------------------------------------------------------------------------
5477 apache_status_address | **Optional.** Host address. Defaults to "$address$" if the host's `address` attribute is set, `address6` otherwise.
5478 apache_status_port | **Optional.** HTTP port.
5479 apache_status_uri | **Optional.** URL to use, instead of the default (http://`apache_status_address`/server-status).
5480 apache_status_ssl | **Optional.** Set to use SSL connection.
5481 apache_status_no_validate | **Optional.** Skip SSL certificate validation.
5482 apache_status_username | **Optional.** Username for basic auth.
5483 apache_status_password | **Optional.** Password for basic auth.
5484 apache_status_timeout | **Optional.** Timeout in seconds.
5485 apache_status_unreachable | **Optional.** Return CRITICAL if socket timed out or http code >= 500.
5486 apache_status_warning | **Optional.** Warning threshold (number of open slots, busy workers and idle workers that will cause a WARNING) like ':20,50,:50'.
5487 apache_status_critical | **Optional.** Critical threshold (number of open slots, busy workers and idle workers that will cause a CRITICAL) like ':10,25,:20'.
5490 #### ssl_cert <a id="plugin-check-command-ssl_cert"></a>
5492 The [check_ssl_cert](https://github.com/matteocorti/check_ssl_cert) plugin
5493 uses the openssl binary (and optional curl) to check a X.509 certificate.
5495 Custom variables passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
5498 --------------------------|--------------
5499 ssl_cert_address | **Optional.** The host's address. Defaults to "$address$" if the host's `address` attribute is set, "$address6$" otherwise.
5500 ssl_cert_port | **Optional.** TCP port number (default: 443).
5501 ssl_cert_file | **Optional.** Local file path. Works only if `ssl_cert_address` is set to "localhost".
5502 ssl_cert_warn | **Optional.** Minimum number of days a certificate has to be valid.
5503 ssl_cert_critical | **Optional.** Minimum number of days a certificate has to be valid to issue a critical status.
5504 ssl_cert_cn | **Optional.** Pattern to match the CN of the certificate.
5505 ssl_cert_altnames | **Optional.** Matches the pattern specified in -n with alternate
5506 ssl_cert_issuer | **Optional.** Pattern to match the issuer of the certificate.
5507 ssl_cert_org | **Optional.** Pattern to match the organization of the certificate.
5508 ssl_cert_email | **Optional.** Pattern to match the email address contained in the certificate.
5509 ssl_cert_serial | **Optional.** Pattern to match the serial number.
5510 ssl_cert_noauth | **Optional.** Ignore authority warnings (expiration only)
5511 ssl_cert_match_host | **Optional.** Match CN with the host name.
5512 ssl_cert_selfsigned | **Optional.** Allow self-signed certificate.
5513 ssl_cert_sni | **Optional.** Sets the TLS SNI (Server Name Indication) extension.
5514 ssl_cert_timeout | **Optional.** Seconds before connection times out (default: 15)
5515 ssl_cert_protocol | **Optional.** Use the specific protocol {http,smtp,pop3,imap,ftp,xmpp,irc,ldap} (default: http).
5516 ssl_cert_clientcert | **Optional.** Use client certificate to authenticate.
5517 ssl_cert_clientpass | **Optional.** Set passphrase for client certificate.
5518 ssl_cert_ssllabs | **Optional.** SSL Labs assessment
5519 ssl_cert_ssllabs_nocache | **Optional.** Forces a new check by SSL Labs
5520 ssl_cert_rootcert | **Optional.** Root certificate or directory to be used for certificate validation.
5521 ssl_cert_ignore_signature | **Optional.** Do not check if the certificate was signed with SHA1 od MD5.
5522 ssl_cert_ssl_version | **Optional.** Force specific SSL version out of {ssl2,ssl3,tls1,tls1_1,tls1_2}.
5523 ssl_cert_disable_ssl_versions | **Optional.** Disable specific SSL versions out of {ssl2,ssl3,tls1,tls1_1,tls1_2}. Multiple versions can be given as array.
5524 ssl_cert_cipher | **Optional.** Cipher selection: force {ecdsa,rsa} authentication.
5525 ssl_cert_ignore_expiration | **Optional.** Ignore expiration date.
5526 ssl_cert_ignore_ocsp | **Optional.** Do not check revocation with OCSP.
5529 #### jmx4perl <a id="plugin-contrib-command-jmx4perl"></a>
5531 The [check_jmx4perl](http://search.cpan.org/~roland/jmx4perl/scripts/check_jmx4perl) plugin
5532 uses the HTTP API exposed by the [Jolokia](https://jolokia.org)
5533 web application and queries Java message beans on an application server. It is
5534 part of the `JMX::Jmx4Perl` Perl module which includes detailed
5535 [documentation](http://search.cpan.org/~roland/jmx4perl/scripts/check_jmx4perl).
5537 Custom variables passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
5540 -----------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------
5541 jmx4perl_url | **Required.** URL to agent web application. Defaults to "http://$address$:8080/jolokia".
5542 jmx4perl_product | **Optional.** Name of app server product (e.g. jboss), by default is uses an auto detection facility.
5543 jmx4perl_alias | **Optional.** Alias name for attribute (e.g. MEMORY_HEAP_USED). All available aliases can be viewed by executing `jmx4perl aliases` on the command line.
5544 jmx4perl_mbean | **Optional.** MBean name (e.g. java.lang:type=Memory).
5545 jmx4perl_attribute | **Optional.** Attribute name (e.g. HeapMemoryUsage).
5546 jmx4perl_operation | **Optional.** Operation to execute.
5547 jmx4perl_value | **Optional.** Shortcut for specifying mbean/attribute/path. Slashes within names must be escaped with backslash.
5548 jmx4perl_delta | **Optional.** Switches on incremental mode. Optional argument are seconds used for normalizing.
5549 jmx4perl_path | **Optional.** Inner path for extracting a single value from a complex attribute or return value (e.g. used).
5550 jmx4perl_target | **Optional.** JSR-160 Service URL specifing the target server.
5551 jmx4perl_target_user | **Optional.** Username to use for JSR-160 connection.
5552 jmx4perl_target_password | **Optional.** Password to use for JSR-160 connection.
5553 jmx4perl_proxy | **Optional.** Proxy to use.
5554 jmx4perl_user | **Optional.** User for HTTP authentication.
5555 jmx4perl_password | **Optional.** Password for HTTP authentication.
5556 jmx4perl_name | **Optional.** Name to use for output, by default a standard value based on the MBean and attribute will be used.
5557 jmx4perl_method | **Optional.** HTTP method to use, either get or post. By default a method is determined automatically based on the request type.
5558 jmx4perl_base | **Optional.** Base name, which when given, interprets critical and warning values as relative in the range 0 .. 100%. Must be given in the form mbean/attribute/path.
5559 jmx4perl_base_mbean | **Optional.** Base MBean name, interprets critical and warning values as relative in the range 0 .. 100%. Requires "jmx4perl_base_attribute".
5560 jmx4perl_base_attribute | **Optional.** Base attribute for a relative check. Requires "jmx4perl_base_mbean".
5561 jmx4perl_base_path | **Optional.** Base path for relative checks, where this path is used on the base attribute's value.
5562 jmx4perl_unit | **Optional.** Unit of measurement of the data retrieved. Recognized values are [B\|KB\|MN\|GB\|TB] for memory values and [us\|ms\|s\|m\|h\|d] for time values.
5563 jmx4perl_null | **Optional.** Value which should be used in case of a null return value of an operation or attribute. Defaults to null.
5564 jmx4perl_string | **Optional.** Force string comparison for critical and warning checks. Defaults to false.
5565 jmx4perl_numeric | **Optional.** Force numeric comparison for critical and warning checks. Defaults to false.
5566 jmx4perl_critical | **Optional.** Critical threshold for value.
5567 jmx4perl_warning | **Optional.** Warning threshold for value.
5568 jmx4perl_label | **Optional.** Label to be used for printing out the result of the check. For placeholders which can be used see the documentation.
5569 jmx4perl_perfdata | **Optional.** Whether performance data should be omitted, which are included by default. Defaults to "on" for numeric values, to "off" for strings.
5570 jmx4perl_unknown_is_critical | **Optional.** Map UNKNOWN errors to errors with a CRITICAL status. Defaults to false.
5571 jmx4perl_timeout | **Optional.** Seconds before plugin times out. Defaults to "15".
5572 jmx4perl_config | **Optional.** Path to configuration file.
5573 jmx4perl_server | **Optional.** Symbolic name of server url to use, which needs to be configured in the configuration file.
5574 jmx4perl_check | **Optional.** Name of a check configuration as defined in the configuration file, use array if you need arguments.
5577 #### kdc <a id="plugin-contrib-command-kdc"></a>
5579 The [check_kdc](https://exchange.nagios.org/directory/Plugins/Security/check_kdc/details) plugin
5580 uses the Kerberos `kinit` binary to monitor Kerberos 5 KDC by acquiring a ticket.
5582 Custom variables passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
5585 ----------------|--------------------------------------------------------------------------
5586 kdc_address | **Optional.** The host's address. Defaults to "$address$" if the host's `address` attribute is set, `address6` otherwise.
5587 kdc_port | **Optional** Port on which KDC runs (default 88).
5588 kdc_principal | **Required** Principal name to authenticate as (including realm).
5589 kdc_keytab | **Required** Keytab file containing principal's key.
5592 #### nginx_status <a id="plugin-contrib-command-nginx_status"></a>
5594 The [check_nginx_status.pl](https://github.com/regilero/check_nginx_status) plugin
5595 uses the [/nginx_status](https://nginx.org/en/docs/http/ngx_http_stub_status_module.html)
5596 HTTP endpoint which provides metrics for monitoring Nginx.
5598 Custom variables passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
5601 --------------------------------|----------------------------------------------------------------------------------
5602 nginx_status_host_address | **Optional.** The host's address. Defaults to "$address$" if the host's `address` attribute is set, `address6` otherwise.
5603 nginx_status_port | **Optional.** the http port.
5604 nginx_status_url | **Optional.** URL to use, instead of the default (http://`nginx_status_hostname`/nginx_status).
5605 nginx_status_servername | **Optional.** ServerName to use if you specified an IP to match the good Virtualhost in your target.
5606 nginx_status_ssl | **Optional.** set to use ssl connection.
5607 nginx_status_disable_sslverify | **Optional.** set to disable SSL hostname verification.
5608 nginx_status_user | **Optional.** Username for basic auth.
5609 nginx_status_pass | **Optional.** Password for basic auth.
5610 nginx_status_realm | **Optional.** Realm for basic auth.
5611 nginx_status_maxreach | **Optional.** Number of max processes reached (since last check) that should trigger an alert.
5612 nginx_status_timeout | **Optional.** timeout in seconds.
5613 nginx_status_warn | **Optional.** Warning threshold (number of active connections, ReqPerSec or ConnPerSec that will cause a WARNING) like '10000,100,200'.
5614 nginx_status_critical | **Optional.** Critical threshold (number of active connections, ReqPerSec or ConnPerSec that will cause a CRITICAL) like '20000,200,300'.
5617 #### rbl <a id="plugin-contrib-command-rbl"></a>
5619 The [check_rbl](https://github.com/matteocorti/check_rbl) plugin
5620 uses the `Net::DNS` Perl library to check whether your SMTP server
5623 Custom variables passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
5626 ----------------|--------------------------------------------------------------------------
5627 rbl_hostname | **Optional.** The address or name of the SMTP server to check. Defaults to "$address$" if the host's `address` attribute is set, `address6` otherwise.
5628 rbl_server | **Required** List of RBL servers as an array.
5629 rbl_warning | **Optional** Number of blacklisting servers for a warning.
5630 rbl_critical | **Optional** Number of blacklisting servers for a critical.
5631 rbl_timeout | **Optional** Seconds before plugin times out (default: 15).
5634 #### squid <a id="plugin-contrib-command-squid"></a>
5636 The [check_squid](https://exchange.icinga.com/exchange/check_squid) plugin
5637 uses the `squidclient` binary to monitor a [Squid proxy](http://www.squid-cache.org).
5639 Custom variables passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
5642 ------------------------|----------------------------------------------------------------------------------
5643 squid_hostname | **Optional.** The host's address. Defaults to "$address$" if the host's `address` attribute is set, "$address6$" otherwise.
5644 squid_data | **Optional.** Data to fetch (default: Connections) available data: Connections Cache Resources Memory FileDescriptors.
5645 squid_port | **Optional.** Port number (default: 3128).
5646 squid_user | **Optional.** WWW user.
5647 squid_password | **Optional.** WWW password.
5648 squid_warning | **Optional.** Warning threshold. See http://nagiosplug.sourceforge.net/developer-guidelines.html#THRESHOLDFORMAT for the threshold format.
5649 squid_critical | **Optional.** Critical threshold. See http://nagiosplug.sourceforge.net/developer-guidelines.html#THRESHOLDFORMAT for the threshold format.
5650 squid_client | **Optional.** Path of squidclient (default: /usr/bin/squidclient).
5651 squid_timeout | **Optional.** Seconds before plugin times out (default: 15).
5654 #### webinject <a id="plugin-contrib-command-webinject"></a>
5656 The [check_webinject](https://labs.consol.de/de/nagios/check_webinject/index.html) plugin
5657 uses [WebInject](http://www.webinject.org/manual.html) to test web applications
5658 and web services in an automated fashion.
5659 It can be used to test individual system components that have HTTP interfaces
5660 (JSP, ASP, CGI, PHP, AJAX, Servlets, HTML Forms, XML/SOAP Web Services, REST, etc),
5661 and can be used as a test harness to create a suite of HTTP level automated functional,
5662 acceptance, and regression tests. A test harness allows you to run many test cases
5663 and collect/report your results. WebInject offers real-time results
5664 display and may also be used for monitoring system response times.
5666 Custom variables passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
5669 ------------------------|--------------
5670 webinject_config_file | **Optional.** There is a configuration file named 'config.xml' that is used to store configuration settings for your project. You can use this to specify which test case files to run and to set some constants and settings to be used by WebInject.
5671 webinject_output | **Optional.** This option is followed by a directory name or a prefix to prepended to the output files. This is used to specify the location for writing output files (http.log, results.html, and results.xml). If a directory name is supplied (use either an absolute or relative path and make sure to add the trailing slash), all output files are written to this directory. If the trailing slash is omitted, it is assumed to a prefix and this will be prepended to the output files. You may also use a combination of a directory and prefix.
5672 webinject_no_output | **Optional.** Suppresses all output to STDOUT except the results summary.
5673 webinject_timeout | **Optional.** The value [given in seconds] will be compared to the global time elapsed to run all the tests. If the tests have all been successful, but have taken more time than the 'globaltimeout' value, a warning message is sent back to Icinga.
5674 webinject_report_type | **Optional.** This setting is used to enable output formatting that is compatible for use with specific external programs. The available values you can set this to are: nagios, mrtg, external and standard.
5675 webinject_testcase_file | **Optional.** When you launch WebInject in console mode, you can optionally supply an argument for a testcase file to run. It will look for this file in the directory that webinject.pl resides in. If no filename is passed from the command line, it will look in config.xml for testcasefile declarations. If no files are specified, it will look for a default file named 'testcases.xml' in the current [webinject] directory. If none of these are found, the engine will stop and give you an error.
5677 #### varnish <a id="plugin-contrib-command-varnish"></a>
5679 The [check_varnish](https://github.com/varnish/varnish-nagios) plugin,
5680 also available in the [monitoring-plugins-contrib](https://packages.debian.org/sid/nagios-plugins-contrib) on debian,
5681 uses the `varnishstat` binary to monitor [varnish](https://varnish-cache.org/).
5683 Custom variables passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
5686 ------------------------|----------------------------------------------------------------------------------
5687 varnish_name | **Optional.** Specify the Varnish instance name
5688 varnish_param | **Optional.** Specify the parameter to check (see below). The default is 'ratio'.
5689 varnish_critical | **Optional.** Set critical threshold: [@][lo:]hi
5690 varnish_warning | **Optional.** Set warning threshold: [@][lo:]hi
5692 For *varnish_param*, all items reported by varnishstat(1) are available - use the
5693 identifier listed in the left column by `varnishstat -l`. In
5694 addition, the following parameters are available:
5697 ------------------------|----------------------------------------------------------------------------------
5698 uptime | How long the cache has been running (in seconds)
5699 ratio | The cache hit ratio expressed as a percentage of hits to hits + misses. Default thresholds are 95 and 90.
5700 usage | Cache file usage as a percentage of the total cache space.
5702 #### haproxy <a id="plugin-contrib-command-haproxy"></a>
5704 The [check_haproxy](https://salsa.debian.org/nagios-team/pkg-nagios-plugins-contrib/blob/master/check_haproxy/check_haproxy) plugin,
5705 also available in the [monitoring-plugins-contrib](https://packages.debian.org/nagios-plugins-contrib) on debian,
5706 uses the `haproxy` csv statistics page to monitor [haproxy](http://www.haproxy.org/) response time. The plugin outputa performance data for backends sessions and statistics response time.
5708 This plugin need to access the csv statistics page. You can configure it in haproxy by adding a new frontend:
5716 The statistics page will be available at `http://127.0.0.1/stats;csv;norefresh`.
5718 Custom variables passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
5721 ------------------------|----------------------------------------------------------------------------------
5722 haproxy_username | **Optional.** Username for HTTP Auth
5723 haproxy_password | **Optional.** Password for HTTP Auth
5724 haproxy_url | **Required.** URL of the HAProxy csv statistics page.
5725 haproxy_timeout | **Optional.** Seconds before plugin times out (default: 10)
5726 haproxy_warning | **Optional.** Warning request time threshold (in seconds)
5727 haproxy_critical | **Optional.** Critical request time threshold (in seconds)
5729 #### haproxy_status <a id="plugin-contrib-command-haproxy_status"></a>
5731 The [check_haproxy_status](https://github.com/jonathanio/monitoring-nagios-haproxy) plugin,
5732 uses the `haproxy` statistics socket to monitor [haproxy](http://www.haproxy.org/) frontends/backends.
5734 This plugin need read/write access to the statistics socket with an operator level. You can configure it in the global section of haproxy to allow icinga user to use it:
5736 stats socket /run/haproxy/admin.sock user haproxy group icinga mode 660 level operator
5739 Custom variables passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
5742 ----------------------------|----------------------------------------------------------------------------------
5743 haproxy\_status\_default | **Optional.** Set/Override the defaults which will be applied to all checks (unless specifically set by --overrides).
5744 haproxy\_status\_frontends | **Optional.** Enable checks for the frontends in HAProxy (that they're marked as OPEN and the session limits haven't been reached).
5745 haproxy\_status\_nofrontends| **Optional.** Disable checks for the frontends in HAProxy (that they're marked as OPEN and the session limits haven't been reached).
5746 haproxy\_status\_backends | **Optional.** Enable checks for the backends in HAProxy (that they have the required quorum of servers, and that the session limits haven't been reached).
5747 haproxy\_status\_nobackends | **Optional.** Disable checks for the backends in HAProxy (that they have the required quorum of servers, and that the session limits haven't been reached).
5748 haproxy\_status\_servers | **Optional.** Enable checks for the servers in HAProxy (that they haven't reached the limits for the sessions or for queues).
5749 haproxy\_status\_noservers | **Optional.** Disable checks for the servers in HAProxy (that they haven't reached the limits for the sessions or for queues).
5750 haproxy\_status\_overrides | **Optional.** Override the defaults for a particular frontend or backend, in the form {name}:{override}, where {override} is the same format as --defaults above.
5751 haproxy\_status\_socket | **Required.** Path to the socket check_haproxy should connect to
5753 #### phpfpm_status <a id="plugin-contrib-command-phpfpm_status"></a>
5755 The [check_phpfpm_status](http://github.com/regilero/check_phpfpm_status) plugin,
5756 uses the `php-fpm` status page to monitor php-fpm.
5758 Custom variables passed as [command parameters](03-monitoring-basics.md#command-passing-parameters):
5761 --------------------------|----------------------------------------------------------------------------------
5762 phpfpm\_status\_hostname | **Required.** name or IP address of host to check
5763 phpfpm\_status\_port | **Optional.** Http port, or Fastcgi port when using --fastcgi
5764 phpfpm\_status\_url | **Optional.** Specific URL (only the path part of it in fact) to use, instead of the default /fpm-status
5765 phpfpm\_status\_servername| **Optional.** ServerName, (host header of HTTP request) use it if you specified an IP in -H to match the good Virtualhost in your target
5766 phpfpm\_status\_fastcgi | **Optional.** If set, connect directly to php-fpm via network or local socket, using fastcgi protocol instead of HTTP.
5767 phpfpm\_status\_user | **Optional.** Username for basic auth
5768 phpfpm\_status\_pass | **Optional.** Password for basic auth
5769 phpfpm\_status\_realm | **Optional.** Realm for basic auth
5770 phpfpm\_status\_debug | **Optional.** If set, debug mode (show http request response)
5771 phpfpm\_status\_timeout | **Optional.** timeout in seconds (Default: 15)
5772 phpfpm\_status\_ssl | **Optional.** Wether we should use HTTPS instead of HTTP. Note that you can give some extra parameters to this settings. Default value is 'TLSv1' but you could use things like 'TLSv1_1' or 'TLSV1_2' (or even 'SSLv23:!SSLv2:!SSLv3' for old stuff).
5773 phpfpm\_status\_verifyssl | **Optional.** If set, verify certificate and hostname from ssl cert, default is 0 (no security), set it to 1 to really make SSL peer name and certificater checks.
5774 phpfpm\_status\_cacert | **Optional.** Full path to the cacert.pem certificate authority used to verify ssl certificates (use with --verifyssl). if not given the cacert from Mozilla::CA cpan plugin will be used.
5775 phpfpm\_status\_warn | **Optional.** MIN_AVAILABLE_PROCESSES,PROC_MAX_REACHED,QUEUE_MAX_REACHED number of available workers, or max states reached that will cause a warning. -1 for no warning
5776 phpfpm\_status\_critical | **Optional.** MIN_AVAILABLE_PROCESSES,PROC_MAX_REACHED,QUEUE_MAX_REACHED number of available workers, or max states reached that will cause an error, -1 for no CRITICAL
projects / icinga2 / blob