1 # <a id="icinga-template-library"></a> Icinga Template Library
3 The Icinga Template Library (ITL) implements standard templates and object
4 definitions for commonly used services.
6 By default the ITL is included in the `icinga2.conf` configuration file:
10 ## <a id="itl-generic-templates"></a> Generic Templates
12 These templates are imported by the provided example configuration.
14 ### <a id="itl-plugin-check-command"></a> plugin-check-command
16 Command template for check plugins executed by Icinga 2.
18 The `plugin-check-command` command does not support any vars.
20 ### <a id="itl-plugin-notification-command"></a> plugin-notification-command
22 Command template for notification scripts executed by Icinga 2.
24 The `plugin-notification-command` command does not support any vars.
26 ### <a id="itl-plugin-event-command"></a> plugin-event-command
28 Command template for event handler scripts executed by Icinga 2.
30 The `plugin-event-command` command does not support any vars.
32 ## <a id="itl-check-commands"></a> Check Commands
34 These check commands are embedded into Icinga 2 and do not require any external
37 ### <a id="itl-icinga"></a> icinga
39 Check command for the built-in `icinga` check. This check returns performance
40 data for the current Icinga instance.
42 The `icinga` check command does not support any vars.
44 ### <a id="itl-icinga-cluster"></a> cluster
46 Check command for the built-in `cluster` check. This check returns performance
47 data for the current Icinga instance and connected endpoints.
49 The `cluster` check command does not support any vars.
51 ### <a id="itl-icinga-cluster-zone"></a> cluster-zone
53 Check command for the built-in `cluster-zone` check.
58 -------------|---------------
59 cluster_zone | **Optional.** The zone name. Defaults to "$host.name$".
61 ### <a id="itl-icinga-ido"></a> ido
63 Check command for the built-in `ido` check.
68 -------------|---------------
69 ido_type | **Required.** The type of the IDO connection object. Can be either "IdoMysqlConnection" or "IdoPgsqlConnection".
70 ido_name | **Required.** The name of the IDO connection object.
72 ### <a id="itl-random"></a> random
74 Check command for the built-in `random` check. This check returns random states
75 and adds the check source to the check output.
77 For test and demo purposes only. The `random` check command does not support
80 # <a id="plugin-check-commands"></a> Plugin Check Commands
82 The Plugin Check Commands provides example configuration for plugin check commands
83 provided by the Monitoring Plugins project.
85 By default the Plugin Check Commands are included in the `icinga2.conf` configuration
90 The plugin check commands assume that there's a global constant named `PluginDir`
91 which contains the path of the plugins from the Monitoring Plugins project.
93 ## <a id="plugin-check-command-apt"></a> apt
95 Check command for the `check_apt` plugin.
97 The `apt` check command does not support any vars.
100 ## <a id="plugin-check-command-by-ssh"></a> by_ssh
102 Check command object for the `check_by_ssh` plugin.
107 ----------------|--------------
108 by_ssh_address | **Optional.** The host's address. Defaults to "$address$" if the host's `address` attribute is set, "$address6$" otherwise.
109 by_ssh_port | **Optional.** The SSH port. Defaults to 22.
110 by_ssh_command | **Optional.** The command that should be executed.
111 by_ssh_logname | **Optional.** The SSH username.
112 by_ssh_identity | **Optional.** The SSH identity.
113 by_ssh_quiet | **Optional.** Whether to suppress SSH warnings. Defaults to false.
114 by_ssh_warn | **Optional.** The warning threshold.
115 by_ssh_crit | **Optional.** The critical threshold.
116 by_ssh_timeout | **Optional.** The timeout in seconds.
119 ## <a id="plugin-check-command-dhcp"></a> dhcp
121 Check command object for the `check_dhcp` plugin.
126 ----------------|--------------
127 dhcp_serverip | **Optional.** The IP address of the DHCP server which we should get a response from.
128 dhcp_requestedip| **Optional.** The IP address which we should be offered by a DHCP server.
129 dhcp_timeout | **Optional.** The timeout in seconds.
130 dhcp_interface | **Optional.** The interface to use.
131 dhcp_mac | **Optional.** The MAC address to use in the DHCP request.
132 dhcp_unicast | **Optional.** Whether to use unicast requests. Defaults to false.
135 ## <a id="plugin-check-command-dig"></a> dig
137 Check command object for the `check_dig` plugin.
142 ---------------------|--------------
143 dig_server | **Optional.** The DNS server to query. Defaults to "127.0.0.1".
144 dig_lookup | **Optional.** The address that should be looked up.
147 ## <a id="plugin-check-command-disk"></a> disk
149 Check command object for the `check_disk` plugin.
153 > `disk_wfree` and `disk_cfree` require the percent sign compared to older versions.
154 > If omitted, disk units can be used. This has been changed in **2.3.0**.
159 ------------------------|------------------------
160 disk_wfree | **Optional.** The free space warning threshold. Defaults to "20%". If the percent sign is omitted, units from `disk_units` are used.
161 disk_cfree | **Optional.** The free space critical threshold. Defaults to "10%". If the percent sign is omitted, units from `disk_units` are used.
162 disk_inode_wfree | **Optional.** The free inode warning threshold.
163 disk_inode_cfree | **Optional.** The free inode critical threshold.
164 disk_partition | **Optional.** The partition. **Deprecated in 2.3.**
165 disk_partition_excluded | **Optional.** The excluded partition. **Deprecated in 2.3.**
166 disk_partitions | **Optional.** The partition(s). Multiple partitions must be defined as array.
167 disk_partitions_excluded | **Optional.** The excluded partition(s). Multiple partitions must be defined as array.
168 disk_clear | **Optional.** Clear thresholds.
169 disk_exact_match | **Optional.** For paths or partitions specified with -p, only check for exact paths.
170 disk_errors_only | **Optional.** Display only devices/mountpoints with errors. May be true or false.
171 disk_group | **Optional.** Group paths. Thresholds apply to (free-)space of all partitions together
172 disk_kilobytes | **Optional.** Same as --units kB. May be true or false.
173 disk_local | **Optional.** Only check local filesystems. May be true or false.
174 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). Myy be true or false
175 disk_mountpoint | **Optional.** Display the mountpoint instead of the partition. May be true or false.
176 disk_megabytes | **Optional.** Same as --units MB. May be true or false.
177 disk_all | **Optional.** Explicitly select all paths. This is equivalent to -R '.*'. May be true or false.
178 disk_eregi_path | **Optional.** Case insensitive regular expression for path/partition (may be repeated).
179 disk_ereg_path | **Optional.** Regular expression for path or partition (may be repeated).
180 disk_ignore_eregi_path | **Optional.** Regular expression to ignore selected path/partition (case insensitive) (may be repeated).
181 disk_ignore_ereg_path | **Optional.** Regular expression to ignore selected path or partition (may be repeated).
182 disk_timeout | **Optional.** Seconds before connection times out (default: 10).
183 disk_units | **Optional.** Choose bytes, kB, MB, GB, TB (default: MB).
184 disk_exclude_type | **Optional.** Ignore all filesystems of indicated type (may be repeated).
187 ## <a id="plugin-check-command-dns"></a> dns
189 Check command object for the `check_dns` plugin.
194 ---------------------|--------------
195 dns_lookup | **Optional.** The hostname or IP to query the DNS for. Defaults to "$host_name$".
196 dns_server | **Optional.** The DNS server to query. Defaults to the server configured in the OS.
197 dns_expected_answer | **Optional.** The answer to look for. A hostname must end with a dot. **Deprecated in 2.3.**
198 dns_expected_answers | **Optional.** The answer(s) to look for. A hostname must end with a dot. Multiple answers must be defined as array.
199 dns_authoritative | **Optional.** Expect the server to send an authoritative answer.
200 dns_wtime | **Optional.** Return warning if elapsed time exceeds value.
201 dns_ctime | **Optional.** Return critical if elapsed time exceeds value.
202 dns_timeout | **Optional.** Seconds before connection times out. Defaults to 10.
205 ## <a id="plugin-check-command-dummy"></a> dummy
207 Check command object for the `check_dummy` plugin.
212 ----------------|--------------
213 dummy_state | **Optional.** The state. Can be one of 0 (ok), 1 (warning), 2 (critical) and 3 (unknown). Defaults to 0.
214 dummy_text | **Optional.** Plugin output. Defaults to "Check was successful.".
217 ## <a id="plugin-check-command-fping4"></a> fping4
219 Check command object for the `check_fping` plugin.
224 ----------------|--------------
225 fping_address | **Optional.** The host's IPv4 address. Defaults to "$address$".
226 fping_wrta | **Optional.** The RTA warning threshold in milliseconds. Defaults to 100.
227 fping_wpl | **Optional.** The packet loss warning threshold in %. Defaults to 5.
228 fping_crta | **Optional.** The RTA critical threshold in milliseconds. Defaults to 200.
229 fping_cpl | **Optional.** The packet loss critical threshold in %. Defaults to 15.
230 fping_number | **Optional.** The number of packets to send. Defaults to 5.
231 fping_interval | **Optional.** The interval between packets in milli-seconds. Defaults to 500.
232 fping_bytes | **Optional.** The size of ICMP packet.
233 fping_target_timeout | **Optional.** The target timeout in milli-seconds.
234 fping_source_ip | **Optional.** The name or ip address of the source ip.
235 fping_source_interface | **Optional.** The source interface name.
238 ## <a id="plugin-check-command-fping6"></a> fping6
240 Check command object for the `check_fping` plugin.
245 ----------------|--------------
246 fping_address | **Optional.** The host's IPv6 address. Defaults to "$address6$".
247 fping_wrta | **Optional.** The RTA warning threshold in milliseconds. Defaults to 100.
248 fping_wpl | **Optional.** The packet loss warning threshold in %. Defaults to 5.
249 fping_crta | **Optional.** The RTA critical threshold in milliseconds. Defaults to 200.
250 fping_cpl | **Optional.** The packet loss critical threshold in %. Defaults to 15.
251 fping_number | **Optional.** The number of packets to send. Defaults to 5.
252 fping_interval | **Optional.** The interval between packets in milli-seconds. Defaults to 500.
253 fping_bytes | **Optional.** The size of ICMP packet.
254 fping_target_timeout | **Optional.** The target timeout in milli-seconds.
255 fping_source_ip | **Optional.** The name or ip address of the source ip.
256 fping_source_interface | **Optional.** The source interface name.
259 ## <a id="plugin-check-command-ftp"></a> ftp
261 Check command object for the `check_ftp` plugin.
266 -------------------|--------------
267 ftp_address | **Optional.** The host's address. Defaults to "$address$" if the host's `address` attribute is set, "$address6$" otherwise.
270 ## <a id="plugin-check-command-hostalive"></a> hostalive
272 Check command object for the `check_ping` plugin with host check default values. This variant
273 uses the host's `address` attribute if available and falls back to using the `address6` attribute
274 if the `address` attribute is not set.
279 ----------------|--------------
280 ping_address | **Optional.** The host's address. Defaults to "$address$" if the host's `address` attribute is set, "$address6$" otherwise.
281 ping_wrta | **Optional.** The RTA warning threshold in milliseconds. Defaults to 3000.
282 ping_wpl | **Optional.** The packet loss warning threshold in %. Defaults to 80.
283 ping_crta | **Optional.** The RTA critical threshold in milliseconds. Defaults to 5000.
284 ping_cpl | **Optional.** The packet loss critical threshold in %. Defaults to 100.
285 ping_packets | **Optional.** The number of packets to send. Defaults to 5.
286 ping_timeout | **Optional.** The plugin timeout in seconds. Defaults to 0 (no timeout).
289 ## <a id="plugin-check-command-hostalive4"></a> hostalive4
291 Check command object for the `check_ping` plugin with host check default values. This variant
292 uses the host's `address` attribute.
297 ----------------|--------------
298 ping_address | **Optional.** The host's IPv4 address. Defaults to "$address$".
299 ping_wrta | **Optional.** The RTA warning threshold in milliseconds. Defaults to 3000.
300 ping_wpl | **Optional.** The packet loss warning threshold in %. Defaults to 80.
301 ping_crta | **Optional.** The RTA critical threshold in milliseconds. Defaults to 5000.
302 ping_cpl | **Optional.** The packet loss critical threshold in %. Defaults to 100.
303 ping_packets | **Optional.** The number of packets to send. Defaults to 5.
304 ping_timeout | **Optional.** The plugin timeout in seconds. Defaults to 0 (no timeout).
307 ## <a id="plugin-check-command-hostalive6"></a> hostalive6
309 Check command object for the `check_ping` plugin with host check default values. This variant
310 uses the host's `address6` attribute.
315 ----------------|--------------
316 ping_address | **Optional.** The host's IPv6 address. Defaults to "$address6$".
317 ping_wrta | **Optional.** The RTA warning threshold in milliseconds. Defaults to 3000.
318 ping_wpl | **Optional.** The packet loss warning threshold in %. Defaults to 80.
319 ping_crta | **Optional.** The RTA critical threshold in milliseconds. Defaults to 5000.
320 ping_cpl | **Optional.** The packet loss critical threshold in %. Defaults to 100.
321 ping_packets | **Optional.** The number of packets to send. Defaults to 5.
322 ping_timeout | **Optional.** The plugin timeout in seconds. Defaults to 0 (no timeout).
325 ## <a id="plugin-check-command-hpjd"></a> hpjd
327 Check command object for the `check_hpjd` plugin.
332 ----------------|--------------
333 hpjd_address | **Optional.** The host's address. Defaults to "$address$" if the host's `address` attribute is set, "$address6$" otherwise.
334 hpjd_port | **Optional.** The host's SNMP port. Defaults to 161.
335 hpjd_community | **Optional.** The SNMP community. Defaults to "public".
338 ## <a id="plugin-check-command-http"></a> http
340 Check command object for the `check_http` plugin.
345 -------------------------|--------------
346 http_address | **Optional.** The host's address. Defaults to "$address$" if the host's `address` attribute is set, "$address6$" otherwise.
347 http_vhost | **Optional.** The virtual host that should be sent in the "Host" header.
348 http_uri | **Optional.** The request URI.
349 http_port | **Optional.** The TCP port. Defaults to 80 when not using SSL, 443 otherwise.
350 http_ssl | **Optional.** Whether to use SSL. Defaults to false.
351 http_sni | **Optional.** Whether to use SNI. Defaults to false.
352 http_auth_pair | **Optional.** Add 'username:password' authorization pair.
353 http_proxy_auth_pair | **Optional.** Add 'username:password' authorization pair for proxy.
354 http_ignore_body | **Optional.** Don't download the body, just the headers.
355 http_linespan | **Optional.** Allow regex to span newline.
356 http_expect_body_regex | **Optional.** A regular expression which the body must match against. Incompatible with http_ignore_body.
357 http_expect_body_eregi | **Optional.** A case-insensitive expression which the body must match against. Incompatible with http_ignore_body.
358 http_invertregex | **Optional.** Changes behaviour of http_expect_body_regex and http_expect_body_eregi to return CRITICAL if found, OK if not.
359 http_warn_time | **Optional.** The warning threshold.
360 http_critical_time | **Optional.** The critical threshold.
361 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.
362 http_certificate | **Optional.** Minimum number of days a certificate has to be valid. Port defaults to 443.
363 http_clientcert | **Optional.** Name of file contains the client certificate (PEM format).
364 http_privatekey | **Optional.** Name of file contains the private key (PEM format).
365 http_headerstring | **Optional.** String to expect in the response headers.
366 http_string | **Optional.** String to expect in the content.
367 http_post | **Optional.** URL encoded http POST data.
368 http_method | **Optional.** Set http method (for example: HEAD, OPTIONS, TRACE, PUT, DELETE).
369 http_maxage | **Optional.** Warn if document is more than seconds old.
370 http_contenttype | **Optional.** Specify Content-Type header when POSTing.
371 http_useragent | **Optional.** String to be sent in http header as User Agent.
372 http_header | **Optional.** Any other tags to be sent in http header.
373 http_extendedperfdata | **Optional.** Print additional perfdata. Defaults to false.
374 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)
375 http_pagesize | **Optional.** Minimum page size required:Maximum page size required.
376 http_timeout | **Optional.** Seconds before connection times out.
379 ## <a id="plugin-check-command-icmp"></a> icmp
381 Check command object for the `check_icmp` plugin.
386 ----------------|--------------
387 icmp_address | **Optional.** The host's address. This can either be a single address or an array of addresses. Defaults to "$address$".
388 icmp_wrta | **Optional.** The RTA warning threshold in milliseconds. Defaults to 100.
389 icmp_wpl | **Optional.** The packet loss warning threshold in %. Defaults to 5.
390 icmp_crta | **Optional.** The RTA critical threshold in milliseconds. Defaults to 200.
391 icmp_cpl | **Optional.** The packet loss critical threshold in %. Defaults to 15.
392 icmp_source | **Optional.** The source IP address to send packets from.
393 icmp_packets | **Optional.** The number of packets to send. Defaults to 5.
394 icmp_packet_interval | **Optional** The maximum packet interval. Defaults to 80 (milliseconds).
395 icmp_target_interval | **Optional.** The maximum target interval.
396 icmp_hosts_alive | **Optional.** The number of hosts which have to be alive for the check to succeed.
397 icmp_data_bytes | **Optional.** Payload size for each ICMP request. Defaults to 8.
398 icmp_timeout | **Optional.** The plugin timeout in seconds. Defaults to 10 (seconds).
401 ## <a id="plugin-check-command-imap"></a> imap
403 Check command object for the `check_imap` plugin.
408 ----------------|--------------
409 imap_address | **Optional.** The host's address. Defaults to "$address$" if the host's `address` attribute is set, "$address6$" otherwise.
410 imap_port | **Optional.** The port that should be checked. Defaults to 143.
413 ## <a id="plugin-check-command-load"></a> load
415 Check command object for the `check_load` plugin.
420 ----------------|--------------
421 load_wload1 | **Optional.** The 1-minute warning threshold. Defaults to 5.
422 load_wload5 | **Optional.** The 5-minute warning threshold. Defaults to 4.
423 load_wload15 | **Optional.** The 15-minute warning threshold. Defaults to 3.
424 load_cload1 | **Optional.** The 1-minute critical threshold. Defaults to 10.
425 load_cload5 | **Optional.** The 5-minute critical threshold. Defaults to 6.
426 load_cload15 | **Optional.** The 15-minute critical threshold. Defaults to 4.
429 ## <a id="plugin-check-command-nrpe"></a> nrpe
431 Check command object for the `check_nrpe` plugin.
436 ----------------|--------------
437 nrpe_address | **Optional.** The host's address. Defaults to "$address$" if the host's `address` attribute is set, "$address6$" otherwise.
438 nrpe_port | **Optional.** The NRPE port. Defaults to 5668.
439 nrpe_command | **Optional.** The command that should be executed.
440 nrpe_no_ssl | **Optional.** Whether to disable SSL or not. Defaults to `false`.
441 nrpe_timeout_unknown | **Optional.** Whether to set timeouts to unknown instead of critical state. Defaults to `false`.
442 nrpe_timeout | **Optional.** The timeout in seconds.
443 nrpe_arguments | **Optional.** Arguments that should be passed to the command. Multiple arguments must be defined as array.
446 ## <a id="plugin-check-command-nscp"></a> nscp
448 Check command object for the `check_nt` plugin.
453 ----------------|--------------
454 nscp_address | **Optional.** The host's address. Defaults to "$address$" if the host's `address` attribute is set, "$address6$" otherwise.
455 nscp_port | **Optional.** The NSClient++ port. Defaults to 12489.
456 nscp_password | **Optional.** The NSClient++ password.
457 nscp_variable | **Required.** The variable that should be checked.
458 nscp_params | **Optional.** Parameters for the query. Multiple parameters must be defined as array.
459 nscp_warn | **Optional.** The warning threshold.
460 nscp_crit | **Optional.** The critical threshold.
461 nscp_timeout | **Optional.** The query timeout in seconds.
462 nscp_showall | **Optional.** Use with SERVICESTATE to see working services or PROCSTATE for running processes. Defaults to false.
465 ## <a id="plugin-check-command-ntp-time"></a> ntp_time
467 Check command object for the `check_ntp_time` plugin.
472 ----------------|--------------
473 ntp_address | **Optional.** The host's address. Defaults to "$address$" if the host's `address` attribute is set, "$address6$" otherwise.
476 ## <a id="plugin-check-command-passive"></a> passive
478 Specialised check command object for passive checks executing the `check_dummy` plugin with appropriate default values.
483 ----------------|--------------
484 dummy_state | **Optional.** The state. Can be one of 0 (ok), 1 (warning), 2 (critical) and 3 (unknown). Defaults to 3.
485 dummy_text | **Optional.** Plugin output. Defaults to "No Passive Check Result Received.".
488 ## <a id="plugin-check-command-ping"></a> ping
490 Check command object for the `check_ping` plugin. This command uses the host's `address` attribute
491 if available and falls back to using the `address6` attribute if the `address` attribute is not set.
497 ----------------|--------------
498 ping_address | **Optional.** The host's address. Defaults to "$address$" if the host's `address` attribute is set, "$address6$" otherwise.
499 ping_wrta | **Optional.** The RTA warning threshold in milliseconds. Defaults to 100.
500 ping_wpl | **Optional.** The packet loss warning threshold in %. Defaults to 5.
501 ping_crta | **Optional.** The RTA critical threshold in milliseconds. Defaults to 200.
502 ping_cpl | **Optional.** The packet loss critical threshold in %. Defaults to 15.
503 ping_packets | **Optional.** The number of packets to send. Defaults to 5.
504 ping_timeout | **Optional.** The plugin timeout in seconds. Defaults to 0 (no timeout).
507 ## <a id="plugin-check-command-ping4"></a> ping4
509 Check command object for the `check_ping` plugin.
514 ----------------|--------------
515 ping_address | **Optional.** The host's IPv4 address. Defaults to "$address$".
516 ping_wrta | **Optional.** The RTA warning threshold in milliseconds. Defaults to 100.
517 ping_wpl | **Optional.** The packet loss warning threshold in %. Defaults to 5.
518 ping_crta | **Optional.** The RTA critical threshold in milliseconds. Defaults to 200.
519 ping_cpl | **Optional.** The packet loss critical threshold in %. Defaults to 15.
520 ping_packets | **Optional.** The number of packets to send. Defaults to 5.
521 ping_timeout | **Optional.** The plugin timeout in seconds. Defaults to 0 (no timeout).
523 ## <a id="plugin-check-command-ping6"></a> ping6
525 Check command object for the `check_ping` plugin.
530 ----------------|--------------
531 ping_address | **Optional.** The host's IPv6 address. Defaults to "$address6$".
532 ping_wrta | **Optional.** The RTA warning threshold in milliseconds. Defaults to 100.
533 ping_wpl | **Optional.** The packet loss warning threshold in %. Defaults to 5.
534 ping_crta | **Optional.** The RTA critical threshold in milliseconds. Defaults to 200.
535 ping_cpl | **Optional.** The packet loss critical threshold in %. Defaults to 15.
536 ping_packets | **Optional.** The number of packets to send. Defaults to 5.
537 ping_timeout | **Optional.** The plugin timeout in seconds. Defaults to 0 (no timeout).
540 ## <a id="plugin-check-command-pop"></a> pop
542 Check command object for the `check_pop` plugin.
547 ----------------|--------------
548 pop_address | **Optional.** The host's address. Defaults to "$address$" if the host's `address` attribute is set, "$address6$" otherwise.
549 pop_port | **Optional.** The port that should be checked. Defaults to 110.
552 ## <a id="plugin-check-command-processes"></a> procs
554 Check command object for the `check_procs` plugin.
559 ---------------------|--------------
560 procs_warning | **Optional.** The process count warning threshold. Defaults to 250.
561 procs_critical | **Optional.** The process count critical threshold. Defaults to 400.
562 procs_metric | **Optional.** Check thresholds against metric.
563 procs_timeout | **Optional.** Seconds before plugin times out.
564 procs_traditional | **Optional.** Filter own process the traditional way by PID instead of /proc/pid/exe. Defaults to false.
565 procs_state | **Optional.** Only scan for processes that have one or more of the status flags you specify.
566 procs_ppid | **Optional.** Only scan for children of the parent process ID indicated.
567 procs_vsz | **Optional.** Only scan for processes with VSZ higher than indicated.
568 procs_rss | **Optional.** Only scan for processes with RSS higher than indicated.
569 procs_pcpu | **Optional.** Only scan for processes with PCPU higher than indicated.
570 procs_user | **Optional.** Only scan for processes with user name or ID indicated.
571 procs_argument | **Optional.** Only scan for processes with args that contain STRING.
572 procs_argument_regex | **Optional.** Only scan for processes with args that contain the regex STRING.
573 procs_command | **Optional.** Only scan for exact matches of COMMAND (without path).
574 procs_nokthreads | **Optional.** Only scan for non kernel threads. Defaults to false.
577 ## <a id="plugin-check-command-running-kernel"></a> running_kernel
579 Check command object for the `check_running_kernel` plugin
580 provided by the `nagios-plugins-contrib` package on Debian.
582 The `running_kernel` check command does not support any vars.
585 ## <a id="plugin-check-command-simap"></a> simap
587 Check command object for the `check_simap` plugin.
592 ----------------|--------------
593 simap_address | **Optional.** The host's address. Defaults to "$address$" if the host's `address` attribute is set, "$address6$" otherwise.
594 simap_port | **Optional.** The host's port.
597 ## <a id="plugin-check-command-smtp"></a> smtp
599 Check command object for the `check_smtp` plugin.
604 ---------------------|--------------
605 smtp_address | **Optional.** The host's address. Defaults to "$address$" if the host's `address` attribute is set, "$address6$" otherwise.
606 smtp_port | **Optional.** The port that should be checked. Defaults to 25.
607 smtp_mail_from | **Optional.** Test a MAIL FROM command with the given email address.
610 ## <a id="plugin-check-command-snmp"></a> snmp
612 Check command object for the `check_snmp` plugin.
617 --------------------|--------------
618 snmp_address | **Optional.** The host's address. Defaults to "$address$" if the host's `address` attribute is set, "$address6$" otherwise.
619 snmp_oid | **Required.** The SNMP OID.
620 snmp_community | **Optional.** The SNMP community. Defaults to "public".
621 snmp_warn | **Optional.** The warning threshold.
622 snmp_crit | **Optional.** The critical threshold.
623 snmp_string | **Optional.** Return OK state if the string matches exactly with the output value
624 snmp_ereg | **Optional.** Return OK state if extended regular expression REGEX matches with the output value
625 snmp_eregi | **Optional.** Return OK state if case-insensitive extended REGEX matches with the output value
626 snmp_label | **Optional.** Prefix label for output value
627 snmp_invert_search | **Optional.** Invert search result and return CRITICAL state if found
628 snmp_units | **Optional.** Units label(s) for output value (e.g., 'sec.').
629 snmp_version | **Optional.** Version to use. E.g. 1, 2, 2c or 3.
630 snmp_miblist | **Optional.** MIB's to use, comma separated. Defaults to "ALL".
631 snmp_rate_multiplier | **Optional.** Converts rate per second. For example, set to 60 to convert to per minute.
632 snmp_rate | **Optional.** Boolean. Enable rate calculation.
633 snmp_getnext | **Optional.** Boolean. Use SNMP GETNEXT. Defaults to false.
634 snmp_timeout | **Optional.** The command timeout in seconds. Defaults to 10 seconds.
636 ## <a id="plugin-check-command-snmpv3"></a> snmpv3
638 Check command object for the `check_snmp` plugin, using SNMPv3 authentication and encryption options.
643 ------------------|--------------
644 snmpv3_address | **Optional.** The host's address. Defaults to "$address$" if the host's `address` attribute is set, "$address6$" otherwise.
645 snmpv3_user | **Required.** The username to log in with.
646 snmpv3_auth_alg | **Optional.** The authentication algorithm. Defaults to SHA.
647 snmpv3_auth_key | **Required.** The authentication key.
648 snmpv3_priv_alg | **Optional.** The encryption algorithm. Defaults to AES.
649 snmpv3_priv_key | **Required.** The encryption key.
650 snmpv3_oid | **Required.** The SNMP OID.
651 snmpv3_warn | **Optional.** The warning threshold.
652 snmpv3_crit | **Optional.** The critical threshold.
653 snmpv3_label | **Optional.** Prefix label for output value.
655 ## <a id="plugin-check-command-snmp-uptime"></a> snmp-uptime
657 Check command object for the `check_snmp` plugin.
662 ----------------|--------------
663 snmp_address | **Optional.** The host's address. Defaults to "$address$" if the host's `address` attribute is set, "$address6$" otherwise.
664 snmp_oid | **Optional.** The SNMP OID. Defaults to "1.3.6.1.2.1.1.3.0".
665 snmp_community | **Optional.** The SNMP community. Defaults to "public".
668 ## <a id="plugin-check-command-spop"></a> spop
670 Check command object for the `check_spop` plugin.
675 ----------------|--------------
676 spop_address | **Optional.** The host's address. Defaults to "$address$" if the host's `address` attribute is set, "$address6$" otherwise.
677 spop_port | **Optional.** The host's port.
680 ## <a id="plugin-check-command-ssh"></a> ssh
682 Check command object for the `check_ssh` plugin.
687 ----------------|--------------
688 ssh_address | **Optional.** The host's address. Defaults to "$address$" if the host's `address` attribute is set, "$address6$" otherwise.
689 ssh_port | **Optional.** The port that should be checked. Defaults to 22.
690 ssh_timeout | **Optional.** Seconds before connection times out. Defaults to 10.
693 ## <a id="plugin-check-command-ssl"></a> ssl
695 Check command object for the `check_tcp` plugin, using ssl-related options.
700 ------------------------------|--------------
701 ssl_address | **Optional.** The host's address. Defaults to "$address$" if the host's `address` attribute is set, "$address6$" otherwise.
702 ssl_port | **Required.** The port that should be checked.
703 ssl_timeout | **Optional.** Timeout in seconds for the connect and handshake. The plugin default is 10 seconds.
704 ssl_cert_valid_days_warn | **Optional.** Warning threshold for days before the certificate will expire. When used, ssl_cert_valid_days_critical must also be set.
705 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.
708 ## <a id="plugin-check-command-ssmtp"></a> ssmtp
710 Check command object for the `check_ssmtp` plugin.
715 ----------------|--------------
716 ssmtp_address | **Required.** The host's address. Defaults to "$address$" if the host's `address` attribute is set, "$address6$" otherwise.
717 ssmtp_port | **Optional.** The port that should be checked. Defaults to 465.
720 ## <a id="plugin-check-command-swap"></a> swap
722 Check command object for the `check_swap` plugin.
727 ----------------|--------------
728 swap_wfree | **Optional.** The free swap space warning threshold in %. Defaults to 50.
729 swap_cfree | **Optional.** The free swap space critical threshold in %. Defaults to 25.
732 ## <a id="plugin-check-command-tcp"></a> tcp
734 Check command object for the `check_tcp` plugin.
739 ----------------|--------------
740 tcp_address | **Optional.** The host's address. Defaults to "$address$" if the host's `address` attribute is set, "$address6$" otherwise.
741 tcp_port | **Required.** The port that should be checked.
744 ## <a id="plugin-check-command-udp"></a> udp
746 Check command object for the `check_udp` plugin.
751 ----------------|--------------
752 udp_address | **Optional.** The host's address. Defaults to "$address$" if the host's `address` attribute is set, "$address6$" otherwise.
753 udp_port | **Required.** The port that should be checked.
754 udp_send | **Required.** The payload to send in the UDP datagram.
755 udp_expect | **Required.** The payload to expect in the response datagram.
756 udp_quit | **Optional.** The payload to send to 'close' the session.
759 ## <a id="plugin-check-command-ups"></a> ups
761 Check command object for the `check_ups` plugin.
766 ----------------|--------------
767 ups_address | **Required.** The address of the host running upsd. Defaults to "$address$" if the host's `address` attribute is set, "$address6$" otherwise.
768 ups_name | **Required.** The UPS name. Defaults to `ups`.
769 ups_port | **Optional.** The port to which to connect. Defaults to 3493.
770 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`.
771 ups_warning | **Optional.** The warning threshold for the selected variable.
772 ups_critical | **Optional.** The critical threshold for the selected variable.
773 ups_celsius | **Optional.** Display the temperature in degrees Celsius instead of Fahrenheit. Defaults to `false`.
774 ups_timeout | **Optional.** The number of seconds before the connection times out. Defaults to 10.
777 ## <a id="plugin-check-command-users"></a> users
779 Check command object for the `check_users` plugin.
784 ----------------|--------------
785 users_wgreater | **Optional.** The user count warning threshold. Defaults to 20.
786 users_cgreater | **Optional.** The user count critical threshold. Defaults to 50.
789 # <a id="windows-plugins"></a>Icinga 2 Windows plugins
791 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.
793 A check-commands-windows.conf comes with Icinga 2, it asumes that the Windows Plugins are installed in the PluginDir set in your constants.conf. To enable them the following include directive is needed in you icinga2.conf:
795 include <windows-plugins>
797 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.
800 ## <a id"windows-plugins-thresholds"></a>Threshold syntax
802 So not specified differently the thresholds for the plugins all follow the same pattern
805 :------------|:----------
806 "29" | The threshold is 29.
807 "!29" | The threshold is 29, but the negative of the result is returned.
808 "[10-40]" | The threshold is a range from (including) 20 to 40, a value inside means the threshold has been exceeded.
809 "![10-40]" | Same as above, but the result is inverted.
812 ## <a id="windows-plugins-disk-windows"></a>disk-windows
814 Check command object for the `check_disk.exe` plugin.
815 Aggregates the free disk space of all volumes and mount points it can find, or the ones defined in `disk_win_path`. Ignores removable storage like fash drives and discs (CD, DVD etc.).
820 :---------------|:------------
821 disk\_win\_warn | **Optional**. The warning threshold.
822 disk\_win\_crit | **Optional**. The critical threshold.
823 disk\_win\_path | **Optional**. Check only these paths, default checks all.
824 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.
827 ## <a id="windows-plugins-load-windows"></a>load-windows
829 Check command object for the `check_load.exe` plugin.
830 This plugin collects the inverse of the performance counter `\Processor(_Total)\% Idle Time` two times, with a wait time of one second between the collection. To change this wait time use [`perfmon-windows`](7-icinga-template-library.md#windows-plugins-load-windows).
835 :---------------|:------------
836 load\_win\_warn | **Optional**. The warning threshold.
837 load\_win\_crit | **Optional**. The critical threshold.
840 ## <a id="windows-plugins-memory-windows"></a>memory-windows
842 Check command object for the `check_memory.exe` plugin.
843 The memory collection is instant.
848 :-----------------|:------------
849 memory\_win\_warn | **Optional**. The warning threshold.
850 memory\_win\_crit | **Optional**. The critical threshold.
851 memory\_win\_unit | **Optional**. The unit to display the received value in, thresholds are interpreted in this unit. Defaults to "mb" (megabye), possible values are: b, kb, mb, gb and tb.
854 ## <a id="windows-plugins-network-windows"></a>network-windows
856 Check command object for the `check_network.exe` plugin.
857 Collects the total Bytes inbount and outbound for all interfaces in one second, to itemise interfaces or use a different collection interval use [`perfmon-windows`](7-icinga-template-library.md#windows-plugins-load-windows).
862 :------------------|:------------
863 network\_win\_warn | **Optional**. The warning threshold.
864 network\_win\_crit | **Optional**. The critical threshold.
867 ## <a id="windows-plugins-permon-windows"></a>perfmon-windows
869 Check command object for the `check_perfmon.exe` plugin.
870 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`.
872 To recieve a list of possible Performance Counter Objects run `check_perfmon.exe --print-objects` and to view an objects instances and counters run `check_perfmon.exe --print-object-info -P "name of object"`
877 :---------------------|:------------
878 perfmon\_win\_warn | **Optional**. The warning threshold.
879 perfmon\_win\_crit | **Optional**. The critical threshold.
880 perfmon\_win\_counter | **Required**. The Performance Counter to use. Ex. `\Processor(_Total)\% Idle Time`.
881 perfmon\_win\_wait | **Optional**. Time in milliseconds to wait between data collection (default: 1000).
882 perfmon\_win\_type | **Optional**. Format in which to expect perfomance values. Possible are: long, int64 and double (default).
885 ## <a id="windows-plugins-ping-windows"></a>ping-windows
887 Check command object for the `check_ping.exe` plugin.
888 ping-windows should automaticly detect whether `ping_win_address` is an IPv4 or IPv6 address, if not use ping4-windows and ping6-windows. Also note that check\_ping.exe waits at least `ping_win_timeout` milliseconds between the pings.
893 :------------------|:------------
894 ping\_win\_warn | **Optional**. The warning threshold. RTA and package loss seperated by comma.
895 ping\_win\_crit | **Optional**. The critical threshold. RTA and package loss seperated by comma.
896 ping\_win\_address | **Required**. An IPv4 or IPv6 address
897 ping\_win\_packets | **Optional**. Number of packages to send. Default: 5.
898 ping\_win\_timeout | **Optional**. The timeout in milliseconds. Default: 1000
901 ## <a id="windows-plugins-procs-windows"></a>procs-windows
903 Check command object for `check_procs.exe` plugin.
904 When useing `procs_win_user` this plugins needs adminstratice privileges to access the processes of other users, to just enumerate them no additional privileges are required.
909 :----------------|:------------
910 procs\_win\_warn | **Optional**. The warning threshold.
911 procs\_win\_crit | **Optional**. The critical threshold.
912 procs\_win\_user | **Optional**. Count this useres processes.
915 ## <a id="windows-plugins-service-windows"></a>service-windows
917 Check command object for `check_service.exe` plugin.
918 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.
923 :---------------------|:------------
924 service\_win\_warn | **Optional**. Warn when service is not running.
925 service\_win\_service | **Required**. The critical threshold.
928 ## <a id="windows-plugins-swap-windows"></a>swap-windows
930 Check command object for `check_swap.exe` plugin.
931 The data collection is instant.
936 :---------------|:------------
937 swap\_win\_warn | **Optional**. The warning threshold.
938 swap\_win\_crit | **Optional**. The critical threshold.
939 swap\_win\_unit | **Optional**. The unit to display the received value in, thresholds are interpreted in this unit. Defaults to "mb" (megabyte).
942 ## <a id="windows-plugins-update-windows"></a>update-windows
944 Check command object for `check_update.exe` plugin.
945 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.
950 :-------------------|:------------
951 update\_win\_warn | If set returns warning when important updates are available
952 update\_win\_crit | If set return critical when important updates that require a reboot are available.
953 update\_win\_reboot | Set to treat 'may need update' as 'definitely needs update'
956 ## <a id="windows-plugins-uptime-windows"></a>uptime-windows
958 Check command opject for `check_uptime.exe` plugin.
959 Uses GetTickCount64 to get the uptime, so boot time is not included.
964 :-----------------|:------------
965 uptime\_win\_warn | **Optional**. The warning threshold.
966 uptime\_win\_crit | **Optional**. The critical threshold.
967 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).
970 ## <a id="windows-plugins-users-windows"></a>users-windows
972 Check command object for `check_users.exe` plugin.
977 :----------------|:------------
978 users\_win\_warn | **Optional**. The warning threshold.
979 users\_win\_crit | **Optional**. The critical threshold.
982 # <a id="nscp-plugin-check-commands"></a> NSClient++ Check Commands
984 Icinga 2 can use the `nscp client` command to run arbitrary NSClient++ checks.
986 You can enable these check commands by adding the following the include directive in your
987 [icinga2.conf](5-configuring-icinga-2.md#icinga2-conf) configuration file:
991 You can also optionally specify an alternative installation directory for NSClient++ by adding
992 the NscpPath constant in your [constants.conf](5-configuring-icinga-2.md#constants-conf) configuration
995 const NscpPath = "C:\\Program Files (x86)\\NSClient++"
997 By default the check commands assume that NSClient++ is installed in "C:\Program Files\NSClient++".
999 Note that it is not necessary to run NSClient++ as a Windows service for these commands to work.
1001 ## <a id="nscp-check-local"></a> nscp-local
1003 Check command object for NSClient++
1008 ----------------|--------------
1009 nscp_path | **Optional.** Can be used to override the NSClient++ on a per-command basis. Defaults to NscpPath.
1010 nscp_boot | **Optional.** Whether to use the --boot option. Defaults to true.
1011 nscp_query | **Required.** The NSClient++ query. Try `nscp client -q x` for a list.
1012 nscp_arguments | **Optional.** An array of query arguments.
1014 ## <a id="nscp-check-local-cpu"></a> nscp-local-cpu
1016 Check command object for the `check_cpu` NSClient++ plugin.
1018 This command has the same custom attributes like the `nscp-local` check command.
1020 ## <a id="nscp-check-local-memory"></a> nscp-local-memory
1022 Check command object for the `check_memory` NSClient++ plugin.
1024 This command has the same custom attributes like the `nscp-local` check command.
1026 ## <a id="nscp-check-local-os-version"></a> nscp-local-os-version
1028 Check command object for the `check_os_version` NSClient++ plugin.
1030 This command has the same custom attributes like the `nscp-local` check command.
1032 ## <a id="nscp-check-local-pagefile"></a> nscp-local-pagefile
1034 Check command object for the `check_pagefile` NSClient++ plugin.
1036 This command has the same custom attributes like the `nscp-local` check command.
1038 ## <a id="nscp-check-local-process"></a> nscp-local-process
1040 Check command object for the `check_process` NSClient++ plugin.
1042 This command has the same custom attributes like the `nscp-local` check command.
1044 ## <a id="nscp-check-local-service"></a> nscp-local-service
1046 Check command object for the `check_service` NSClient++ plugin.
1048 This command has the same custom attributes like the `nscp-local` check command.
1050 ## <a id="nscp-check-local-uptime"></a> nscp-local-uptime
1052 Check command object for the `check_uptime` NSClient++ plugin.
1054 This command has the same custom attributes like the `nscp-local` check command.
1056 ## <a id="nscp-check-local-version"></a> nscp-local-version
1058 Check command object for the `check_version` NSClient++ plugin.
1060 This command has the same custom attributes like the `nscp-local` check command.
1062 ## <a id="nscp-check-local-disk"></a> nscp-local-disk
1064 Check command object for the `check_drivesize` NSClient++ plugin.
1066 This command has the same custom attributes like the `nscp-local` check command.
1068 # <a id="snmp-manubulon-plugin-check-commands"></a> SNMP Manubulon Plugin Check Commands
1070 The `SNMP Manubulon Plugin Check Commands` provide example configuration for plugin check
1071 commands provided by the [SNMP Manubulon project](http://nagios.manubulon.com/index_snmp.html).
1073 The SNMP manubulon plugin check commands assume that the global constant named `ManubulonPluginDir`
1074 is set to the path where the Manubublon SNMP plugins are installed.
1076 You can enable these plugin check commands by adding the following the include directive in your
1077 [icinga2.conf](5-configuring-icinga-2.md#icinga2-conf) configuration file:
1081 ## Checks by Host Type
1083 **N/A** : Not available for this type.
1085 **SNMP** : Available for simple SNMP query.
1089 **Specific** : Script name for platform specific checks.
1092 Host type | Interface | storage | load/cpu | mem | process | env | specific
1093 ------------------------|------------|----------|-----------|-----|----------|-----|-------------------------
1094 Linux | Yes | Yes | Yes | Yes | Yes | No |
1095 Windows | Yes | Yes | Yes | Yes | Yes | No | check_snmp_win.pl
1096 Cisco router/switch | Yes | N/A | Yes | Yes | N/A | Yes |
1097 HP router/switch | Yes | N/A | Yes | Yes | N/A | No |
1098 Bluecoat proxy | Yes | SNMP | Yes | SNMP| No | Yes |
1099 CheckPoint on SPLAT | Yes | Yes | Yes | Yes | Yes | No | check_snmp_cpfw.pl
1100 CheckPoint on Nokia IP | Yes | Yes | Yes | No | ?? | No | check_snmp_vrrp.pl
1101 Boostedge | Yes | Yes | Yes | Yes | ?? | No | check_snmp_boostedge.pl
1102 AS400 | Yes | Yes | Yes | Yes | No | No |
1103 NetsecureOne Netbox | Yes | Yes | Yes | ?? | Yes | No |
1104 Radware Linkproof | Yes | N/A | SNMP | SNMP| No | No | check_snmp_linkproof_nhr <br> check_snmp_vrrp.pl
1105 IronPort | Yes | SNMP | SNMP | SNMP| No | Yes |
1106 Cisco CSS | Yes | ?? | Yes | Yes | No | ?? | check_snmp_css.pl
1109 ## <a id="plugin-check-command-snmp-load"></a> snmp-load
1111 Check command object for the [check_snmp_load.pl](http://nagios.manubulon.com/snmp_load.html) plugin.
1117 ------------------------|--------------
1118 snmp_address | **Optional.** The host's address. Defaults to "$address$" if the host's `address` attribute is set, "$address6$" otherwise.
1119 snmp_nocrypt | **Optional.** Define SNMP encryption. If set **snmp_v3** needs to be set. Defaults to false.
1120 snmp_community | **Optional.** The SNMP community. Defaults to "public".
1121 snmp_port | **Optional.** The SNMP port connection.
1122 snmp_v2 | **Optional.** SNMP version to 2c. Defaults to false.
1123 snmp_v3 | **Optional.** SNMP version to 3. Defaults to false.
1124 snmp_login | **Optional.** SNMP version 3 username. Defaults to "snmpuser".
1125 snmp_password | **Required.** SNMP version 3 password. No value defined as default.
1126 snmp_v3_use_privpass | **Optional.** Define to use SNMP version 3 priv password. Defaults to false.
1127 snmp_authprotocol | **Optional.** SNMP version 3 authentication protocol. Defaults to "md5,des".
1128 snmp_privpass | **Required.** SNMP version 3 priv password. No value defined as default.
1129 snmp_warn | **Optional.** The warning threshold. Change the `snmp_load_type` var to "netsl" for using 3 values.
1130 snmp_crit | **Optional.** The critical threshold. Change the `snmp_load_type` var to "netsl" for using 3 values.
1131 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.
1132 snmp_perf | **Optional.** Enable perfdata values. Defaults to true.
1133 snmp_timeout | **Optional.** The command timeout in seconds. Defaults to 5 seconds.
1135 ## <a id="plugin-check-command-snmp-memory"></a> snmp-memory
1137 Check command object for the [check_snmp_mem.pl](http://nagios.manubulon.com/snmp_mem.html) plugin.
1142 ------------------------|--------------
1143 snmp_address | **Optional.** The host's address. Defaults to "$address$" if the host's `address` attribute is set, "$address6$" otherwise.
1144 snmp_nocrypt | **Optional.** Define SNMP encryption. If set **snmp_v3** needs to be set. Defaults to false.
1145 snmp_community | **Optional.** The SNMP community. Defaults to "public".
1146 snmp_port | **Optional.** The SNMP port connection.
1147 snmp_v2 | **Optional.** SNMP version to 2c. Defaults to false.
1148 snmp_v3 | **Optional.** SNMP version to 3. Defaults to false.
1149 snmp_login | **Optional.** SNMP version 3 username. Defaults to "snmpuser".
1150 snmp_password | **Required.** SNMP version 3 password. No value defined as default.
1151 snmp_v3_use_privpass | **Optional.** Define to use SNMP version 3 priv password. Defaults to false.
1152 snmp_authprotocol | **Optional.** SNMP version 3 authentication protocol. Defaults to "md5,des".
1153 snmp_privpass | **Required.** SNMP version 3 priv password. No value defined as default.
1154 snmp_warn | **Optional.** The warning threshold.
1155 snmp_crit | **Optional.** The critical threshold.
1156 snmp_perf | **Optional.** Enable perfdata values. Defaults to true.
1157 snmp_timeout | **Optional.** The command timeout in seconds. Defaults to 5 seconds.
1159 ## <a id="plugin-check-command-snmp-storage"></a> snmp-storage
1161 Check command object for the [check_snmp_storage.pl](http://nagios.manubulon.com/snmp_storage.html) plugin.
1166 ------------------------|--------------
1167 snmp_address | **Optional.** The host's address. Defaults to "$address$" if the host's `address` attribute is set, "$address6$" otherwise.
1168 snmp_nocrypt | **Optional.** Define SNMP encryption. If set **snmp_v3** needs to be set. Defaults to false.
1169 snmp_community | **Optional.** The SNMP community. Defaults to "public".
1170 snmp_port | **Optional.** The SNMP port connection.
1171 snmp_v2 | **Optional.** SNMP version to 2c. Defaults to false.
1172 snmp_v3 | **Optional.** SNMP version to 3. Defaults to false.
1173 snmp_login | **Optional.** SNMP version 3 username. Defaults to "snmpuser".
1174 snmp_password | **Required.** SNMP version 3 password. No value defined as default.
1175 snmp_v3_use_privpass | **Optional.** Define to use SNMP version 3 priv password. Defaults to false.
1176 snmp_authprotocol | **Optional.** SNMP version 3 authentication protocol. Defaults to "md5,des".
1177 snmp_privpass | **Required.** SNMP version 3 priv password. No value defined as default.
1178 snmp_warn | **Optional.** The warning threshold.
1179 snmp_crit | **Optional.** The critical threshold.
1180 snmp_storage_name | **Optional.** Storage name. Default to regex "^/$$". More options available in the [snmp storage](http://nagios.manubulon.com/snmp_storage.html) documentation.
1181 snmp_perf | **Optional.** Enable perfdata values. Defaults to true.
1182 snmp_timeout | **Optional.** The command timeout in seconds. Defaults to 5 seconds.
1184 ## <a id="plugin-check-command-snmp-interface"></a> snmp-interface
1186 Check command object for the [check_snmp_int.pl](http://nagios.manubulon.com/snmp_int.html) plugin.
1191 ----------------------------|--------------
1192 snmp_address | **Optional.** The host's address. Defaults to "$address$" if the host's `address` attribute is set, "$address6$" otherwise.
1193 snmp_nocrypt | **Optional.** Define SNMP encryption. If set **snmp_v3** needs to be set. Defaults to false.
1194 snmp_community | **Optional.** The SNMP community. Defaults to "public".
1195 snmp_port | **Optional.** The SNMP port connection.
1196 snmp_v2 | **Optional.** SNMP version to 2c. Defaults to false.
1197 snmp_v3 | **Optional.** SNMP version to 3. Defaults to false.
1198 snmp_login | **Optional.** SNMP version 3 username. Defaults to "snmpuser".
1199 snmp_password | **Required.** SNMP version 3 password. No value defined as default.
1200 snmp_v3_use_privpass | **Optional.** Define to use SNMP version 3 priv password. Defaults to false.
1201 snmp_authprotocol | **Optional.** SNMP version 3 authentication protocol. Defaults to "md5,des".
1202 snmp_privpass | **Required.** SNMP version 3 priv password. No value defined as default.
1203 snmp_warn | **Optional.** The warning threshold.
1204 snmp_crit | **Optional.** The critical threshold.
1205 snmp_interface | **Optional.** Network interface name. Default to regex "eth0".
1206 snmp_interface_perf | **Optional.** Check the input/ouput bandwidth of the interface. Defaults to true.
1207 snmp_interface_label | **Optional.** Add label before speed in output: in=, out=, errors-out=, etc...
1208 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.
1209 snmp_interface_percent | **Optional.** Output performance data in % of max speed. Defaults to false.
1210 snmp_interface_kbits | **Optional.** Make the warning and critical levels in KBits/s. Defaults to true.
1211 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.
1212 snmp_interface_64bit | **Optional.** Use 64 bits counters instead of the standard counters when checking bandwidth & performance data for interface >= 1Gbps. Defaults to false.
1213 snmp_interface_errors | **Optional.** Add error & discard to Perfparse output. Defaults to true.
1214 snmp_interface_noregexp | **Optional.** Do not use regexp to match interface name in description OID. Defaults to false.
1215 snmp_interface_delta | **Optional.** Delta time of perfcheck. Defaults to "300" (5 min).
1216 snmp_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.
1217 snmp_perf | **Optional.** Enable perfdata values. Defaults to true.
1218 snmp_timeout | **Optional.** The command timeout in seconds. Defaults to 5 seconds.
1220 ## <a id="plugin-check-command-snmp-process"></a> snmp-process
1222 Check command object for the [check_snmp_process.pl](http://nagios.manubulon.com/snmp_process.html) plugin.
1227 ------------------------|--------------
1228 snmp_address | **Optional.** The host's address. Defaults to "$address$" if the host's `address` attribute is set, "$address6$" otherwise.
1229 snmp_nocrypt | **Optional.** Define SNMP encryption. If set **snmp_v3** needs to be set. Defaults to false.
1230 snmp_community | **Optional.** The SNMP community. Defaults to "public".
1231 snmp_port | **Optional.** The SNMP port connection.
1232 snmp_v2 | **Optional.** SNMP version to 2c. Defaults to false.
1233 snmp_v3 | **Optional.** SNMP version to 3. Defaults to false.
1234 snmp_login | **Optional.** SNMP version 3 username. Defaults to "snmpuser".
1235 snmp_password | **Required.** SNMP version 3 password. No value defined as default.
1236 snmp_v3_use_privpass | **Optional.** Define to use SNMP version 3 priv password. Defaults to false.
1237 snmp_authprotocol | **Optional.** SNMP version 3 authentication protocol. Defaults to "md5,des".
1238 snmp_privpass | **Required.** SNMP version 3 priv password. No value defined as default..
1239 snmp_warn | **Optional.** The warning threshold.
1240 snmp_crit | **Optional.** The critical threshold.
1241 snmp_process_name | **Optional.** Name of the process (regexp). No trailing slash!. Defaults to ".*".
1242 snmp_perf | **Optional.** Enable perfdata values. Defaults to true.
1243 snmp_timeout | **Optional.** The command timeout in seconds. Defaults to 5 seconds.
1245 # <a id="plugins-contrib"></a> Plugins Contrib
1247 The Plugins contrib collects various contributed command definitions.
1249 These check commands assume that the global constant named `PluginContribDir`
1250 is set to the path where the user installs custom plugins and can be enabled by uncommenting the corresponding line in icinga2.conf.
1252 ## <a id="plugins-contrib-databases"></a> Databases
1254 All database plugins go in this category.
1256 ### <a id="plugins-contrib-command-mssql_health"></a> mssql_health
1258 The plugin `mssql_health` utilises Perl DBD::Sybase based on FreeTDS to connect to MSSQL databases for monitoring.
1259 For release tarballs, detailed documentation especially on the different modes and scripts for creating a monitoring user see [https://labs.consol.de](https://labs.consol.de/nagios/check_mssql_health/). For development check [https://github.com](https://github.com/lausser/check_mssql_health).
1264 ---------------------------------|------------------------------------------------------------------------------------------------------------------------------
1265 mssql_health_hostname | **Optional.** Specifies the database hostname or address. No default because you typically use "mssql_health_server".
1266 mssql_health_port | **Optional.** Specifies the database port. No default because you typically use "mssql_health_server".
1267 mssql_health_server | **Optional.** The name of a predefined connection (in freetds.conf).
1268 mssql_health_currentdb | **Optional.** The name of a database which is used as the current database for the connection.
1269 mssql_health_username | **Optional.** The username for the database connection.
1270 mssql_health_password | **Optional.** The password for the database connection.
1271 mssql_health_warning | **Optional.** The warning threshold depending on the mode.
1272 mssql_health_critical | **Optional.** The critical threshold depending on the mode.
1273 mssql_health_mode | **Required.** The mode uses predefined keywords for the different checks. For example "connection-time", "database-free" or "sql".
1274 mssql_health_name | **Optional.** Depending on the mode this could be the database name or a SQL statement.
1275 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.
1276 mssql_health_regexep | **Optional.** If set to true, "mssql_health_name" will be interpreted as a regular expression. Defaults to false.
1277 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".
1278 mssql_health_offlineok | **Optional.** Set this to true, if offline databases are perfectly ok for you. Defaults to false.
1279 mssql_health_commit | **Optional.** Set this to true to turn on autocommit for the dbd::sybase module. Defaults to false.
1281 ### <a id="plugins-contrib-command-mysql_health"></a> mysql_health
1283 The plugin `mysql_health` utilises Perl DBD::MySQL to connect to MySQL databases for monitoring.
1284 For release tarballs and detailed documentation especially on the different modes and required permissions see [https://labs.consol.de](https://labs.consol.de/nagios/check_mysql_health/). For development check [https://github.com](https://github.com/lausser/check_mysql_health).
1289 ---------------------------------|------------------------------------------------------------------------------------------------------------------------------
1290 mysql_health_hostname | **Required.** Specifies the database hostname or address. Defaults to "$address$" or "$address6$" if the `address` attribute is not set.
1291 mysql_health_port | **Optional.** Specifies the database port. Defaults to 3306 (or 1186 for "mysql_health_mode" cluster).
1292 mysql_health_socket | **Optional.** Specifies the database unix socket. No default.
1293 mysql_health_username | **Optional.** The username for the database connection.
1294 mysql_health_password | **Optional.** The password for the database connection.
1295 mysql_health_database | **Optional.** The database to connect to. Defaults to information_schema.
1296 mysql_health_warning | **Optional.** The warning threshold depending on the mode.
1297 mysql_health_critical | **Optional.** The critical threshold depending on the mode.
1298 mysql_health_mode | **Required.** The mode uses predefined keywords for the different checks. For example "connection-time", "slave-lag" or "sql".
1299 mysql_health_name | **Optional.** The SQL statement to be executed with "mysql_health_mode" sql.
1300 mysql_health_name2 | **Optional.** If "mysql_health_name" is a sql statement, "mysql_health_name2" can be used to appear in the output and the performance data.
1301 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".
1302 mysql_health_labelformat | **Optional.** One of those formats pnp4nagios or groundwork. Defaults to pnp4nagios.
1304 ### <a id="plugins-contrib-command-oracle_health"></a> oracle_health
1306 The plugin `oracle_health` utilises Perl DBD::Oracle based on oracle-instantclient-sdk or sqlplus to connect to Oracle databases for monitoring.
1307 For release tarballs and detailed documentation especially on the different modes and required permissions see [https://labs.consol.de](https://labs.consol.de/nagios/check_oracle_health/). For development check [https://github.com](https://github.com/lausser/check_oracle_health).
1312 ---------------------------------|------------------------------------------------------------------------------------------------------------------------------
1313 oracle_health_connect | **Required.** Specifies the database connection string (from tnsnames.ora).
1314 oracle_health_username | **Optional.** The username for the database connection.
1315 oracle_health_password | **Optional.** The password for the database connection.
1316 oracle_health_warning | **Optional.** The warning threshold depending on the mode.
1317 oracle_health_critical | **Optional.** The critical threshold depending on the mode.
1318 oracle_health_mode | **Required.** The mode uses predefined keywords for the different checks. For example "connection-time", "flash-recovery-area-usage" or "sql".
1319 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.
1320 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.
1321 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".
1322 oracle_health_ident | **Optional.** If set to true outputs instance and database names. Defaults to false.
1323 oracle_health_commit | **Optional.** Set this to true to turn on autocommit for the dbd::oracle module. Defaults to false.
1324 oracle_health_noperfdata | **Optional.** Set this to true if you want to disable perfdata. Defaults to false.
1329 --------------------|------------------------------------------------------------------------------------------------------------------------------------------
1330 ORACLE_HOME | **Required.** Specifies the location of the oracle instant client libraries. Defaults to "/usr/lib/oracle/11.2/client64/lib". Can be overridden by setting "oracle_home".
1331 TNS_ADMIN | **Required.** Specifies the location of the tnsnames.ora including the database connection strings. Defaults to "/etc/icinga2/plugin-configs". Can be overridden by setting "oracle_tns_admin".
1333 ### <a id="plugins-contrib-command-postgres"></a> postgres
1335 The plugin `postgres` utilises the psql binary to connect to PostgreSQL databases for monitoring.
1336 For release tarballs and detailed documentation especially the different actions and required persmissions see [https://bucardo.org/wiki/Check_postgres](https://bucardo.org/wiki/Check_postgres). For development check [https://github.com](https://github.com/bucardo/check_postgres).
1341 ---------------------------------|------------------------------------------------------------------------------------------------------------------------------
1342 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.
1343 postgres_port | **Optional.** Specifies the database port. Defaults to 5432.
1344 postgres_dbname | **Optional.** Specifies the database name to connect to. Defaults to "postgres" or "template1".
1345 postgres_dbuser | **Optional.** The username for the database connection. Defaults to "postgres".
1346 postgres_dbpass | **Optional.** The password for the database connection. You can use a .pgpass file instead.
1347 postgres_dbservice | **Optional.** Specifies the service name to use inside of pg_service.conf.
1348 postgres_warning | **Optional.** Specifies the warning threshold, range depends on the action.
1349 postgres_critical | **Optional.** Specifies the critical threshold, range depends on the action.
1350 postgres_include | **Optional.** Specifies name(s) items to specifically include (e.g. tables), depends on the action.
1351 postgres_exclude | **Optional.** Specifies name(s) items to specifically exclude (e.g. tables), depends on the action.
1352 postgres_includeuser | **Optional.** Include objects owned by certain users.
1353 postgres_excludeuser | **Optional.** Exclude objects owned by certain users.
1354 postgres_standby | **Optional.** Assume that the server is in continious WAL recovery mode if set to true. Defaults to false.
1355 postgres_production | **Optional.** Assume that the server is in production mode if set to true. Defaults to false.
1356 postgres_action | **Required.** Determines the test executed.
1357 postgres_unixsocket | **Optional.** If "postgres_unixsocket" is set to true the unix socket is used instead of an address. Defaults to false.
1359 ## <a id="plugins-contrib-ipmi"></a> IPMI Devices
1361 This category includes all plugins for IPMI devices.
1363 ### <a id="plugins-contrib-command-ipmi-sensor"></a> ipmi-sensor
1365 With the plugin `ipmi-sensor` provided by <a href="https://www.thomas-krenn.com/">Thomas-Krenn.AG</a> you can monitor sensor data for IPMI devices. See https://www.thomas-krenn.com/en/wiki/IPMI_Sensor_Monitoring_Plugin for installation and configuration instructions.
1370 ---------------------------------|-----------------------------------------------------------------------------------------------------
1371 ipmi_address | **Required.** Specifies the remote host (IPMI device) to check. Defaults to "$address$".
1372 ipmi_config_file | **Optional.** Path to the FreeIPMI configuration file. It should contain IPMI username, IPMI password, and IPMI privilege-level.
1373 ipmi_username | **Optional.** The IPMI username.
1374 ipmi_password | **Optional.** The IPMI password.
1375 ipmi_privilege_level | **Optional.** The IPMI privilege level of the IPMI user.
1376 ipmi_backward_compatibility_mode | **Optional.** Enable backward compatibility mode, useful for FreeIPMI 0.5.* (this omits FreeIPMI options "--quiet-cache" and "--sdr-cache-recreate").
1377 ipmi_sensor_type | **Optional.** Limit sensors to query based on IPMI sensor type. Examples for IPMI sensor types are 'Fan', 'Temperature' and 'Voltage'.
1378 ipmi_exclude_sensor_id | **Optional.** Exclude sensor matching ipmi_sensor_id.
1379 ipmi_sensor_id | **Optional.** Include sensor matching ipmi_sensor_id.
1380 ipmi_protocal_lan_version | **Optional.** Change the protocol LAN version. Defaults to "LAN_2_0".
1381 ipmi_number_of_active_fans | **Optional.** Number of fans that should be active. Otherwise a WARNING state is returned.
1382 ipmi_show_fru | **Optional.** Print the product serial number if it is available in the IPMI FRU data.
1383 ipmi_no_sel_checking | **Optional.** Turn off system event log checking via ipmi-sel.
1385 ## <a id="plugins-contrib-network-components"></a> Network Components
1387 This category includes all plugins for various network components like routers, switches and firewalls.
1389 ### <a id="plugins-contrib-command-interfacetable"></a> interfacetable
1391 The plugin `interfacetable` generates a html page containing information about the monitored node and all of its interfaces. The actively developed and maintained version is `interfacetable_v3t` provided by `Yannick Charton` on [http://www.tontonitch.com](http://www.tontonitch.com/tiki/tiki-index.php?page=Nagios+plugins+-+interfacetable_v3t) or [https://github.com](https://github.com/Tontonitch/interfacetable_v3t).
1396 ------------------------------------|-----------------------------------------------------------------------------------------------------
1397 interfacetable_hostquery | **Required.** Specifies the remote host to poll. Defaults to "$address$".
1398 interfacetable_hostdisplay | **Optional.** Specifies the hostname to display in the HTML link. Defaults to "$host.display_name$".
1399 interfacetable_regex | **Optional.** Interface names and property names for some other options will be interpreted as regular expressions. Defaults to false.
1400 interfacetable_outputshort | **Optional.** Reduce the verbosity of the plugin output. Defaults to false.
1401 interfacetable_exclude | **Optional.** Comma separated list of interfaces globally excluded from the monitoring.
1402 interfacetable_include | **Optional.** Comma separated list of interfaces globally included in the monitoring.
1403 interfacetable_aliasmatching | **Optional.** Allow you to specify alias in addition to interface names. Defaults to false.
1404 interfacetable_excludetraffic | **Optional.** Comma separated list of interfaces excluded from traffic checks.
1405 interfacetable_includetraffic | **Optional.** Comma separated list of interfaces included for traffic checks.
1406 interfacetable_warningtraffic | **Optional.** Interface traffic load percentage leading to a warning alert.
1407 interfacetable_criticaltraffic | **Optional.** Interface traffic load percentage leading to a critical alert.
1408 interfacetable_pkt | **Optional.** Add unicast/non-unicast pkt stats for each interface.
1409 interfacetable_trackproperty | **Optional.** List of tracked properties.
1410 interfacetable_excludeproperty | **Optional.** Comma separated list of interfaces excluded from the property tracking.
1411 interfacetable_includeproperty | **Optional.** Comma separated list of interfaces included in the property tracking.
1412 interfacetable_community | **Optional.** Specifies the snmp v1/v2c community string. Defaults to "public" if using snmp v1/v2c, ignored using v3.
1413 interfacetable_snmpv2 | **Optional.** Use snmp v2c. Defaults to false.
1414 interfacetable_login | **Optional.** Login for snmpv3 authentication.
1415 interfacetable_passwd | **Optional.** Auth password for snmpv3 authentication.
1416 interfacetable_privpass | **Optional.** Priv password for snmpv3 authentication.
1417 interfacetable_protocols | **Optional.** Authentication protocol,Priv protocol for snmpv3 authentication.
1418 interfacetable_domain | **Optional.** SNMP transport domain.
1419 interfacetable_contextname | **Optional.** Context name for the snmp requests.
1420 interfacetable_port | **Optional.** SNMP port. Defaults to standard port.
1421 interfacetable_64bits | **Optional.** Use SNMP 64-bits counters. Defaults to false.
1422 interfacetable_maxrepetitions | **Optional.** Increasing this value may enhance snmp query performances by gathering more results at one time.
1423 interfacetable_snmptimeout | **Optional.** Define the Transport Layer timeout for the snmp queries.
1424 interfacetable_snmpretries | **Optional.** Define the number of times to retry sending a SNMP message.
1425 interfacetable_unixsnmp | **Optional.** Use unix snmp utilities for snmp requests. Defaults to false, which means use the perl bindings.
1426 interfacetable_enableperfdata | **Optional.** Enable port performance data. Defaults to false.
1427 interfacetable_perfdataformat | **Optional.** Define which performance data will be generated. Possible values are "full" (default), "loadonly", "globalonly".
1428 interfacetable_perfdatathreshold | **Optional.** Define which thresholds are printed in the generated performance data. Possible values are "full" (default), "loadonly", "globalonly".
1429 interfacetable_perfdatadir | **Optional.** When specified, the performance data are also written directly to a file, in the specified location.
1430 interfacetable_perfdataservicedesc | **Optional.** Specify additional parameters for output performance data to PNP. Defaults to "$service.name$", only affects **interfacetable_perfdatadir**.
1431 interfacetable_grapher | **Optional.** Specify the used graphing solution. Possible values are "pnp4nagios" (default), "nagiosgrapher", "netwaysgrapherv2" and "ingraph".
1432 interfacetable_grapherurl | **Optional.** Graphing system url. Default depends on **interfacetable_grapher**.
1433 interfacetable_portperfunit | **Optional.** Traffic could be reported in bits (counters) or in bps (calculated value).
1434 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".
1435 interfacetable_duplex | **Optional.** Add the duplex mode property for each interface in the interface table. Defaults to false.
1436 interfacetable_stp | **Optional.** Add the stp state property for each interface in the interface table. Defaults to false.
1437 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"
1438 interfacetable_noipinfo | **Optional.** Remove the ip information for each interface from the interface table. Defaults to false.
1439 interfacetable_alias | **Optional.** Add the alias information for each interface in the interface table. Defaults to false.
1440 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.
1441 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.
1442 interfacetable_delta | **Optional.** Set the delta used for interface throuput calculation in seconds.
1443 interfacetable_ifs | **Optional.** Input field separator. Defaults to ",".
1444 interfacetable_cache | **Optional.** Define the retention time of the cached data in seconds.
1445 interfacetable_noifloadgradient | **Optional.** Disable color gradient from green over yellow to red for the load percentage. Defaults to false.
1446 interfacetable_nohuman | **Optional.** Do not translate bandwidth usage in human readable format. Defaults to false.
1447 interfacetable_snapshot | **Optional.** Force the plugin to run like if it was the first launch. Defaults to false.
1448 interfacetable_timeout | **Optional.** Define the global timeout limit of the plugin in seconds. Defaults to "15s".
1449 interfacetable_css | **Optional.** Define the css stylesheet used by the generated html files. Possible values are "classic", "icinga", "icinga-alternate1" or "nagiosxi".
1450 interfacetable_config | **Optional.** Specify a config file to load.
1451 interfacetable_noconfigtable | **Optional.** Disable configuration table on the generated HTML page. Defaults to false.
1452 interfacetable_notips | **Optional.** Disable the tips in the generated html tables. Defaults to false.
1453 interfacetable_defaulttablesorting | **Optional.** Default table sorting can be "index" (default) or "name".
1454 interfacetable_tablesplit | **Optional.** Generate multiple interface tables, one per interface type. Defaults to false.
1455 interfacetable_notype | **Optional.** Remove the interface type for each interface. Defaults to false.
1457 ## <a id="plugins-contrib-web"></a> Web
1459 This category includes all plugins for web-based checks.
1461 ## <a id="plugin-check-command-webinject"></a> webinject
1463 Check command object for the [check_webinject](http://http://www.webinject.org/manual.html) plugin.
1468 ------------------------|--------------
1469 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.
1470 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 ommitted, 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.
1471 webinject_no_output | **Optional.** Suppresses all output to STDOUT except the results summary.
1472 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.
1473 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.
1474 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.
1476 ## <a id="plugins-contrib-operating-system"></a> Operating System
1478 In this category you can find plugins for gathering information about your operating system or the system beneath like memory usage.
1480 ### <a id="plugins-contrib-command-mem"></a> mem
1482 The plugin `mem` is used for gathering information about memory usage on linux and unix hosts. It is able to count cache memory as free when comparing it to the thresholds. It is provided by `Justin Ellison` on [https://github.com](https://github.com/justintime/nagios-plugins). For more details see the developers blog [http://sysadminsjourney.com](http://sysadminsjourney.com/content/2009/06/04/new-and-improved-checkmempl-nagios-plugin).
1487 -------------|-----------------------------------------------------------------------------------------------------------------------
1488 mem_used | **Optional.** Tell the plugin to check for used memory in opposite of **mem_free**. Must specify one of these as true.
1489 mem_free | **Optional.** Tell the plugin to check for free memory in opposite of **mem_used**. Must specify one of these as true.
1490 mem_cache | **Optional.** If set to true plugin will count cache as free memory. Defaults to false.
1491 mem_warning | **Required.** Specifiy the warning threshold as number interpreted as percent.
1492 mem_critical | **Required.** Specifiy the critical threshold as number interpreted as percent.
1494 ## <a id="plugins-contrib-virtualization"></a> Virtualization
1496 This category includes all plugins for various virtualization technologies.
1498 ### <a id="plugins-contrib-command-esxi-hardware"></a> esxi_hardware
1500 The plugin `esxi_hardware` is a plugin to monitor hardware of ESXi servers through the vmware api and cim service. It is provided by `Claudio Kuenzler` on [http://www.claudiokuenzler.com](http://www.claudiokuenzler.com/nagios-plugins/check_esxi_hardware.php). For instruction on creating the required local user and workarounds for some hardware types have a look on his homepage.
1505 ------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
1506 esxi_hardware_host | **Required.** Specifies the host to monitor. Defaults to "$address$".
1507 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.
1508 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.
1509 esxi_hardware_vendor | **Optional.** Defines the vendor of the server: "auto", "dell", "hp", "ibm", "intel", "unknown" (default).
1510 esxi_hardware_html | **Optional.** Add web-links to hardware manuals for Dell servers (use your country extension). Only useful with **esxi_hardware_vendor** = dell.
1511 esxi_hardware_ignore | **Optional.** Comma separated list of elements to ignore.
1512 esxi_hardware_perfdata | **Optional.** Add performcedata for graphers like PNP4Nagios to the output. Defaults to false.
1513 esxi_hardware_nopower | **Optional.** Do not collect power performance data, when **esxi_hardware_perfdata** is set to true. Defaults to false.
1514 esxi_hardware_novolts | **Optional.** Do not collect voltage performance data, when **esxi_hardware_perfdata** is set to true. Defaults to false.
1515 esxi_hardware_nocurrent | **Optional.** Do not collect current performance data, when **esxi_hardware_perfdata** is set to true. Defaults to false.
1516 esxi_hardware_notemp | **Optional.** Do not collect temperature performance data, when **esxi_hardware_perfdata** is set to true. Defaults to false.
1517 esxi_hardware_nofan | **Optional.** Do not collect fan performance data, when **esxi_hardware_perfdata** is set to true. Defaults to false.
1519 # <a id="plugins-contrib-vmware"></a> VMware
1521 Check commands for the [check_vmware_esx](https://github.com/BaldMansMojo/check_vmware_esx) plugin.
1523 ## <a id="plugins-contrib-vmware-esx-dc-volumes"></a> vmware-esx-dc-volumes
1525 Check command object for the `check_vmware_esx` plugin. Shows all datastore volumes info.
1530 ------------------------|--------------
1531 vmware_datacenter | **Required.** Datacenter/vCenter hostname.
1532 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
1533 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".
1534 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".
1535 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
1536 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
1537 vmware_sessionfile | **Optional.** Session file name enhancement.
1538 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
1539 vmware_nosession | **Optional.** No auth session - IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
1540 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
1541 vmware_password | **Optional.** The username's password. No value defined as default.
1542 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
1543 vmware_subselect | **Optional.** Volume name to be checked the free space.
1544 vmware_gigabyte | **Optional.** Output in GB instead of MB.
1545 vmware_usedspace | **Optional.** Output used space instead of free. Defaults to "false".
1546 vmware_alertonly | **Optional.** List only alerting volumes. Defaults to "false".
1547 vmware_exclude | **Optional.** Blacklist volumes name. No value defined as default.
1548 vmware_include | **Optional.** Whitelist volumes name. No value defined as default.
1549 vmware_isregexp | **Optional.** Treat blacklist and whitelist expressions as regexp.
1550 vmware_dc_volume_used | **Optional.** Output used space instead of free. Defaults to "true".
1551 vmware_warn | **Optional.** The warning threshold for volumes. Defaults to "80%".
1552 vmware_crit | **Optional.** The critical threshold for volumes. Defaults to "90%".
1555 ## <a id="plugins-contrib-vmware-esx-dc-runtime-info"></a> vmware-esx-dc-runtime-info
1557 Check command object for the `check_vmware_esx` plugin. Shows all runtime info for the datacenter/Vcenter.
1562 ------------------------|--------------
1563 vmware_datacenter | **Required.** Datacenter/vCenter hostname.
1564 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
1565 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".
1566 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".
1567 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
1568 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
1569 vmware_sessionfile | **Optional.** Session file name enhancement.
1570 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
1571 vmware_nosession | **Optional.** No auth session - IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
1572 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
1573 vmware_password | **Optional.** The username's password. No value defined as default.
1574 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
1577 ## <a id="plugins-contrib-vmware-esx-dc-runtime-listvms"></a> vmware-esx-dc-runtime-listvms
1579 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.
1584 ------------------------|--------------
1585 vmware_datacenter | **Required.** Datacenter/vCenter hostname.
1586 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
1587 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".
1588 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".
1589 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
1590 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
1591 vmware_sessionfile | **Optional.** Session file name enhancement.
1592 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
1593 vmware_nosession | **Optional.** No auth session - IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
1594 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
1595 vmware_password | **Optional.** The username's password. No value defined as default.
1596 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
1597 vmware_alertonly | **Optional.** List only alerting VMs. Important here to avoid masses of data.
1598 vmware_exclude | **Optional.** Blacklist VMs name. No value defined as default.
1599 vmware_include | **Optional.** Whitelist VMs name. No value defined as default.
1600 vmware_isregexp | **Optional.** Treat blacklist and whitelist expressions as regexp.
1601 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.
1604 ## <a id="plugins-contrib-vmware-esx-dc-runtime-listhost"></a> vmware-esx-dc-runtime-listhost
1606 Check command object for the `check_vmware_esx` plugin. List of VMware ESX hosts and their power state.
1611 ------------------------|--------------
1612 vmware_datacenter | **Required.** Datacenter/vCenter hostname.
1613 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
1614 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".
1615 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".
1616 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
1617 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
1618 vmware_sessionfile | **Optional.** Session file name enhancement.
1619 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
1620 vmware_nosession | **Optional.** No auth session - IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
1621 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
1622 vmware_password | **Optional.** The username's password. No value defined as default.
1623 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
1624 vmware_alertonly | **Optional.** List only alerting hosts. Important here to avoid masses of data.
1625 vmware_exclude | **Optional.** Blacklist VMware ESX hosts. No value defined as default.
1626 vmware_include | **Optional.** Whitelist VMware ESX hosts. No value defined as default.
1627 vmware_isregexp | **Optional.** Treat blacklist and whitelist expressions as regexp.
1628 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.
1631 ## <a id="plugins-contrib-vmware-esx-dc-runtime-listcluster"></a> vmware-esx-dc-runtime-listcluster
1633 Check command object for the `check_vmware_esx` plugin. List of VMware clusters and their states.
1638 ------------------------|--------------
1639 vmware_datacenter | **Required.** Datacenter/vCenter hostname.
1640 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
1641 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".
1642 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".
1643 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
1644 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
1645 vmware_sessionfile | **Optional.** Session file name enhancement.
1646 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
1647 vmware_nosession | **Optional.** No auth session - IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
1648 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
1649 vmware_password | **Optional.** The username's password. No value defined as default.
1650 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
1651 vmware_alertonly | **Optional.** List only alerting hosts. Important here to avoid masses of data.
1652 vmware_exclude | **Optional.** Blacklist VMware cluster. No value defined as default.
1653 vmware_include | **Optional.** Whitelist VMware cluster. No value defined as default.
1654 vmware_isregexp | **Optional.** Treat blacklist and whitelist expressions as regexp.
1655 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.
1658 ## <a id="plugins-contrib-vmware-esx-dc-runtime-issues"></a> vmware-esx-dc-runtime-issues
1660 Check command object for the `check_vmware_esx` plugin. All issues for the host.
1665 ------------------------|--------------
1666 vmware_datacenter | **Required.** Datacenter/vCenter hostname.
1667 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
1668 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".
1669 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".
1670 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
1671 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
1672 vmware_sessionfile | **Optional.** Session file name enhancement.
1673 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
1674 vmware_nosession | **Optional.** No auth session - IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
1675 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
1676 vmware_password | **Optional.** The username's password. No value defined as default.
1677 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
1678 vmware_exclude | **Optional.** Blacklist issues. No value defined as default.
1679 vmware_include | **Optional.** Whitelist issues. No value defined as default.
1680 vmware_isregexp | **Optional.** Treat blacklist and whitelist expressions as regexp.
1681 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.
1684 ## <a id="plugins-contrib-vmware-esx-dc-runtime-status"></a> vmware-esx-dc-runtime-status
1686 Check command object for the `check_vmware_esx` plugin. Overall object status (gray/green/red/yellow).
1691 ------------------------|--------------
1692 vmware_datacenter | **Required.** Datacenter/vCenter hostname.
1693 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
1694 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".
1695 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".
1696 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
1697 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
1698 vmware_sessionfile | **Optional.** Session file name enhancement.
1699 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
1700 vmware_nosession | **Optional.** No auth session - IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
1701 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
1702 vmware_password | **Optional.** The username's password. No value defined as default.
1703 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
1706 ## <a id="plugins-contrib-vmware-esx-dc-runtime-tools"></a> vmware-esx-dc-runtime-tools
1708 Check command object for the `check_vmware_esx` plugin. Vmware Tools status.
1713 ------------------------|--------------
1714 vmware_datacenter | **Required.** Datacenter/vCenter hostname.
1715 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
1716 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".
1717 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".
1718 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
1719 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
1720 vmware_sessionfile | **Optional.** Session file name enhancement.
1721 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
1722 vmware_nosession | **Optional.** No auth session - IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
1723 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
1724 vmware_password | **Optional.** The username's password. No value defined as default.
1725 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
1726 vmware_poweredonly | **Optional.** List only VMs which are powered on. No value defined as default.
1727 vmware_alertonly | **Optional.** List only alerting VMs. Important here to avoid masses of data.
1728 vmware_exclude | **Optional.** Blacklist VMs. No value defined as default.
1729 vmware_include | **Optional.** Whitelist VMs. No value defined as default.
1730 vmware_isregexp | **Optional.** Treat blacklist and whitelist expressions as regexp.
1731 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.
1734 ## <a id="plugins-contrib-vmware-esx-soap-host-check"></a> vmware-esx-soap-host-check
1736 Check command object for the `check_vmware_esx` plugin. Simple check to verify a successfull connection to VMware SOAP API.
1741 ------------------------|--------------
1742 vmware_host | **Required.** ESX or ESXi hostname.
1743 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
1744 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".
1745 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".
1746 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
1747 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
1748 vmware_sessionfile | **Optional.** Session file name enhancement.
1749 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
1750 vmware_nosession | **Optional.** No auth session - IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
1751 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
1752 vmware_password | **Optional.** The username's password. No value defined as default.
1753 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
1756 ## <a id="plugins-contrib-vmware-esx-soap-host-uptime"></a> vmware-esx-soap-host-uptime
1758 Check command object for the `check_vmware_esx` plugin. Displays uptime of the VMware host.
1763 ------------------------|--------------
1764 vmware_host | **Required.** ESX or ESXi hostname.
1765 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
1766 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".
1767 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".
1768 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
1769 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
1770 vmware_sessionfile | **Optional.** Session file name enhancement.
1771 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
1772 vmware_nosession | **Optional.** No auth session - IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
1773 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
1774 vmware_password | **Optional.** The username's password. No value defined as default.
1775 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
1778 ## <a id="plugins-contrib-vmware-esx-soap-host-cpu"></a> vmware-esx-soap-host-cpu
1780 Check command object for the `check_vmware_esx` plugin. CPU usage in percentage.
1785 ------------------------|--------------
1786 vmware_host | **Required.** ESX or ESXi hostname.
1787 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
1788 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".
1789 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".
1790 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
1791 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
1792 vmware_sessionfile | **Optional.** Session file name enhancement.
1793 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
1794 vmware_nosession | **Optional.** No auth session - IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
1795 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
1796 vmware_password | **Optional.** The username's password. No value defined as default.
1797 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
1798 vmware_warn | **Optional.** The warning threshold in percent. Defaults to "80%".
1799 vmware_crit | **Optional.** The critical threshold in percent. Defaults to "90%".
1802 ## <a id="plugins-contrib-vmware-esx-soap-host-cpu-ready"></a> vmware-esx-soap-host-cpu-ready
1804 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.
1809 ------------------------|--------------
1810 vmware_host | **Required.** ESX or ESXi hostname.
1811 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
1812 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".
1813 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".
1814 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
1815 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
1816 vmware_sessionfile | **Optional.** Session file name enhancement.
1817 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
1818 vmware_nosession | **Optional.** No auth session - IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
1819 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
1820 vmware_password | **Optional.** The username's password. No value defined as default.
1821 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
1824 ## <a id="plugins-contrib-vmware-esx-soap-host-cpu-wait"></a> vmware-esx-soap-host-cpu-wait
1826 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.
1831 ------------------------|--------------
1832 vmware_host | **Required.** ESX or ESXi hostname.
1833 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
1834 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".
1835 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".
1836 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
1837 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
1838 vmware_sessionfile | **Optional.** Session file name enhancement.
1839 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
1840 vmware_nosession | **Optional.** No auth session - IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
1841 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
1842 vmware_password | **Optional.** The username's password. No value defined as default.
1843 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
1846 ## <a id="plugins-contrib-vmware-esx-soap-host-cpu-usage"></a> vmware-esx-soap-host-cpu-usage
1848 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.
1853 ------------------------|--------------
1854 vmware_host | **Required.** ESX or ESXi hostname.
1855 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
1856 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".
1857 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".
1858 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
1859 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
1860 vmware_sessionfile | **Optional.** Session file name enhancement.
1861 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
1862 vmware_nosession | **Optional.** No auth session - IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
1863 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
1864 vmware_password | **Optional.** The username's password. No value defined as default.
1865 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
1866 vmware_warn | **Optional.** The warning threshold in percent. Defaults to "80%".
1867 vmware_crit | **Optional.** The critical threshold in percent. Defaults to "90%".
1870 ## <a id="plugins-contrib-vmware-esx-soap-host-mem"></a> vmware-esx-soap-host-mem
1872 Check command object for the `check_vmware_esx` plugin. All mem info(except overall and no thresholds).
1877 ------------------------|--------------
1878 vmware_host | **Required.** ESX or ESXi hostname.
1879 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
1880 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".
1881 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".
1882 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
1883 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
1884 vmware_sessionfile | **Optional.** Session file name enhancement.
1885 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
1886 vmware_nosession | **Optional.** No auth session - IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
1887 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
1888 vmware_password | **Optional.** The username's password. No value defined as default.
1889 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
1892 ## <a id="plugins-contrib-vmware-esx-soap-host-mem-usage"></a> vmware-esx-soap-host-mem-usage
1894 Check command object for the `check_vmware_esx` plugin. Average mem usage in percentage.
1899 ------------------------|--------------
1900 vmware_host | **Required.** ESX or ESXi hostname.
1901 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
1902 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".
1903 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".
1904 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
1905 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
1906 vmware_sessionfile | **Optional.** Session file name enhancement.
1907 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
1908 vmware_nosession | **Optional.** No auth session - IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
1909 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
1910 vmware_password | **Optional.** The username's password. No value defined as default.
1911 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
1912 vmware_warn | **Optional.** The warning threshold in percent. Defaults to "80%".
1913 vmware_crit | **Optional.** The critical threshold in percent. Defaults to "90%".
1916 ## <a id="plugins-contrib-vmware-esx-soap-host-mem-consumed"></a> vmware-esx-soap-host-mem-consumed
1918 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.
1923 ------------------------|--------------
1924 vmware_host | **Required.** ESX or ESXi hostname.
1925 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
1926 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".
1927 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".
1928 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
1929 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
1930 vmware_sessionfile | **Optional.** Session file name enhancement.
1931 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
1932 vmware_nosession | **Optional.** No auth session - IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
1933 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
1934 vmware_password | **Optional.** The username's password. No value defined as default.
1935 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
1936 vmware_warn | **Optional.** The warning threshold in percent. No value defined as default.
1937 vmware_crit | **Optional.** The critical threshold in percent. No value defined as default.
1940 ## <a id="plugins-contrib-vmware-esx-soap-host-mem-swapused"></a> vmware-esx-soap-host-mem-swapused
1942 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.
1947 ------------------------|--------------
1948 vmware_host | **Required.** ESX or ESXi hostname.
1949 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
1950 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".
1951 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".
1952 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
1953 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
1954 vmware_sessionfile | **Optional.** Session file name enhancement.
1955 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
1956 vmware_nosession | **Optional.** No auth session - IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
1957 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
1958 vmware_password | **Optional.** The username's password. No value defined as default.
1959 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
1960 vmware_warn | **Optional.** The warning threshold in percent. No value defined as default.
1961 vmware_crit | **Optional.** The critical threshold in percent. No value defined as default.
1962 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.
1965 ## <a id="plugins-contrib-vmware-esx-soap-host-mem-overhead"></a> vmware-esx-soap-host-mem-overhead
1967 Check command object for the `check_vmware_esx` plugin. Additional mem used by VM Server in MB.
1972 ------------------------|--------------
1973 vmware_host | **Required.** ESX or ESXi hostname.
1974 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
1975 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".
1976 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".
1977 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
1978 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
1979 vmware_sessionfile | **Optional.** Session file name enhancement.
1980 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
1981 vmware_nosession | **Optional.** No auth session - IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
1982 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
1983 vmware_password | **Optional.** The username's password. No value defined as default.
1984 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
1985 vmware_warn | **Optional.** The warning threshold in percent. No value defined as default.
1986 vmware_crit | **Optional.** The critical threshold in percent. No value defined as default.
1989 ## <a id="plugins-contrib-vmware-esx-soap-host-mem-memctl"></a> vmware-esx-soap-host-mem-memctl
1991 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.
1996 ------------------------|--------------
1997 vmware_host | **Required.** ESX or ESXi hostname.
1998 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
1999 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".
2000 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".
2001 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
2002 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
2003 vmware_sessionfile | **Optional.** Session file name enhancement.
2004 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
2005 vmware_nosession | **Optional.** No auth session - IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
2006 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
2007 vmware_password | **Optional.** The username's password. No value defined as default.
2008 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
2009 vmware_warn | **Optional.** The warning threshold in percent. No value defined as default.
2010 vmware_crit | **Optional.** The critical threshold in percent. No value defined as default.
2011 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.
2014 ## <a id="plugins-contrib-vmware-esx-soap-host-net"></a> vmware-esx-soap-host-net
2016 Check command object for the `check_vmware_esx` plugin. Shows net info.
2021 ------------------------|--------------
2022 vmware_host | **Required.** ESX or ESXi hostname.
2023 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
2024 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".
2025 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".
2026 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
2027 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
2028 vmware_sessionfile | **Optional.** Session file name enhancement.
2029 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
2030 vmware_nosession | **Optional.** No auth session - IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
2031 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
2032 vmware_password | **Optional.** The username's password. No value defined as default.
2033 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
2034 vmware_exclude | **Optional.** Blacklist NICs. No value defined as default.
2035 vmware_isregexp | **Optional.** Treat blacklist expression as regexp.
2038 ## <a id="plugins-contrib-vmware-esx-soap-host-net-usage"></a> vmware-esx-soap-host-net-usage
2040 Check command object for the `check_vmware_esx` plugin. Overall network usage in KBps(Kilobytes per Second).
2045 ------------------------|--------------
2046 vmware_host | **Required.** ESX or ESXi hostname.
2047 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
2048 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".
2049 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".
2050 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
2051 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
2052 vmware_sessionfile | **Optional.** Session file name enhancement.
2053 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
2054 vmware_nosession | **Optional.** No auth session - IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
2055 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
2056 vmware_password | **Optional.** The username's password. No value defined as default.
2057 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
2058 vmware_warn | **Optional.** The warning threshold in KBps(Kilobytes per Second). No value defined as default.
2059 vmware_crit | **Optional.** The critical threshold in KBps(Kilobytes per Second). No value defined as default.
2062 ## <a id="plugins-contrib-vmware-esx-soap-host-net-receive"></a> vmware-esx-soap-host-net-receive
2064 Check command object for the `check_vmware_esx` plugin. Data receive in KBps(Kilobytes per Second).
2069 ------------------------|--------------
2070 vmware_host | **Required.** ESX or ESXi hostname.
2071 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
2072 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".
2073 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".
2074 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
2075 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
2076 vmware_sessionfile | **Optional.** Session file name enhancement.
2077 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
2078 vmware_nosession | **Optional.** No auth session - IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
2079 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
2080 vmware_password | **Optional.** The username's password. No value defined as default.
2081 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
2082 vmware_warn | **Optional.** The warning threshold in KBps(Kilobytes per Second). No value defined as default.
2083 vmware_crit | **Optional.** The critical threshold in KBps(Kilobytes per Second). No value defined as default.
2086 ## <a id="plugins-contrib-vmware-esx-soap-host-net-send"></a> vmware-esx-soap-host-net-send
2088 Check command object for the `check_vmware_esx` plugin. Data send in KBps(Kilobytes per Second).
2093 ------------------------|--------------
2094 vmware_host | **Required.** ESX or ESXi hostname.
2095 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
2096 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".
2097 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".
2098 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
2099 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
2100 vmware_sessionfile | **Optional.** Session file name enhancement.
2101 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
2102 vmware_nosession | **Optional.** No auth session - IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
2103 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
2104 vmware_password | **Optional.** The username's password. No value defined as default.
2105 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
2106 vmware_warn | **Optional.** The warning threshold in KBps(Kilobytes per Second). No value defined as default.
2107 vmware_crit | **Optional.** The critical threshold in KBps(Kilobytes per Second). No value defined as default.
2110 ## <a id="plugins-contrib-vmware-esx-soap-host-net-nic"></a> vmware-esx-soap-host-net-nic
2112 Check command object for the `check_vmware_esx` plugin. Check all active NICs.
2117 ------------------------|--------------
2118 vmware_host | **Required.** ESX or ESXi hostname.
2119 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
2120 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".
2121 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".
2122 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
2123 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
2124 vmware_sessionfile | **Optional.** Session file name enhancement.
2125 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
2126 vmware_nosession | **Optional.** No auth session - IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
2127 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
2128 vmware_password | **Optional.** The username's password. No value defined as default.
2129 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
2130 vmware_exclude | **Optional.** Blacklist NICs. No value defined as default.
2131 vmware_isregexp | **Optional.** Treat blacklist expression as regexp.
2134 ## <a id="plugins-contrib-vmware-esx-soap-host-volumes"></a> vmware-esx-soap-host-volumes
2136 Check command object for the `check_vmware_esx` plugin. Shows all datastore volumes info.
2141 ------------------------|--------------
2142 vmware_host | **Required.** ESX or ESXi hostname.
2143 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
2144 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".
2145 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".
2146 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
2147 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
2148 vmware_sessionfile | **Optional.** Session file name enhancement.
2149 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
2150 vmware_nosession | **Optional.** No auth session - IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
2151 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
2152 vmware_password | **Optional.** The username's password. No value defined as default.
2153 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
2154 vmware_subselect | **Optional.** Volume name to be checked the free space.
2155 vmware_gigabyte | **Optional.** Output in GB instead of MB.
2156 vmware_usedspace | **Optional.** Output used space instead of free. Defaults to "false".
2157 vmware_alertonly | **Optional.** List only alerting volumes. Defaults to "false".
2158 vmware_exclude | **Optional.** Blacklist volumes name. No value defined as default.
2159 vmware_include | **Optional.** Whitelist volumes name. No value defined as default.
2160 vmware_isregexp | **Optional.** Treat blacklist and whitelist expressions as regexp.
2161 vmware_warn | **Optional.** The warning threshold for volumes. Defaults to "80%".
2162 vmware_crit | **Optional.** The critical threshold for volumes. Defaults to "90%".
2163 vmware_spaceleft | **Optional.** This has to be used in conjunction with thresholds as mentioned above.
2166 ## <a id="plugins-contrib-vmware-esx-soap-host-io"></a> vmware-esx-soap-host-io
2168 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.
2173 ------------------------|--------------
2174 vmware_host | **Required.** ESX or ESXi hostname.
2175 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
2176 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".
2177 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".
2178 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
2179 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
2180 vmware_sessionfile | **Optional.** Session file name enhancement.
2181 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
2182 vmware_nosession | **Optional.** No auth session - IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
2183 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
2184 vmware_password | **Optional.** The username's password. No value defined as default.
2185 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
2188 ## <a id="plugins-contrib-vmware-esx-soap-host-io-aborted"></a> vmware-esx-soap-host-io-aborted
2190 Check command object for the `check_vmware_esx` plugin. Number of aborted SCSI commands.
2195 ------------------------|--------------
2196 vmware_host | **Required.** ESX or ESXi hostname.
2197 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
2198 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".
2199 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".
2200 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
2201 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
2202 vmware_sessionfile | **Optional.** Session file name enhancement.
2203 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
2204 vmware_nosession | **Optional.** No auth session - IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
2205 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
2206 vmware_password | **Optional.** The username's password. No value defined as default.
2207 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
2208 vmware_warn | **Optional.** The warning threshold. No value defined as default.
2209 vmware_crit | **Optional.** The critical threshold. No value defined as default.
2212 ## <a id="plugins-contrib-vmware-esx-soap-host-io-resets"></a> vmware-esx-soap-host-io-resets
2214 Check command object for the `check_vmware_esx` plugin. Number of SCSI bus resets.
2219 ------------------------|--------------
2220 vmware_host | **Required.** ESX or ESXi hostname.
2221 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
2222 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".
2223 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".
2224 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
2225 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
2226 vmware_sessionfile | **Optional.** Session file name enhancement.
2227 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
2228 vmware_nosession | **Optional.** No auth session - IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
2229 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
2230 vmware_password | **Optional.** The username's password. No value defined as default.
2231 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
2232 vmware_warn | **Optional.** The warning threshold. No value defined as default.
2233 vmware_crit | **Optional.** The critical threshold. No value defined as default.
2236 ## <a id="plugins-contrib-vmware-esx-soap-host-io-read"></a> vmware-esx-soap-host-io-read
2238 Check command object for the `check_vmware_esx` plugin. Average number of kilobytes read from the disk each second.
2243 ------------------------|--------------
2244 vmware_host | **Required.** ESX or ESXi hostname.
2245 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
2246 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".
2247 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".
2248 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
2249 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
2250 vmware_sessionfile | **Optional.** Session file name enhancement.
2251 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
2252 vmware_nosession | **Optional.** No auth session - IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
2253 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
2254 vmware_password | **Optional.** The username's password. No value defined as default.
2255 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
2256 vmware_warn | **Optional.** The warning threshold. No value defined as default.
2257 vmware_crit | **Optional.** The critical threshold. No value defined as default.
2260 ## <a id="plugins-contrib-vmware-esx-soap-host-io-read-latency"></a> vmware-esx-soap-host-io-read-latency
2262 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.
2267 ------------------------|--------------
2268 vmware_host | **Required.** ESX or ESXi hostname.
2269 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
2270 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".
2271 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".
2272 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
2273 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
2274 vmware_sessionfile | **Optional.** Session file name enhancement.
2275 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
2276 vmware_nosession | **Optional.** No auth session - IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
2277 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
2278 vmware_password | **Optional.** The username's password. No value defined as default.
2279 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
2280 vmware_warn | **Optional.** The warning threshold. No value defined as default.
2281 vmware_crit | **Optional.** The critical threshold. No value defined as default.
2284 ## <a id="plugins-contrib-vmware-esx-soap-host-io-write"></a> vmware-esx-soap-host-io-write
2286 Check command object for the `check_vmware_esx` plugin. Average number of kilobytes written to disk each second.
2291 ------------------------|--------------
2292 vmware_host | **Required.** ESX or ESXi hostname.
2293 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
2294 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".
2295 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".
2296 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
2297 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
2298 vmware_sessionfile | **Optional.** Session file name enhancement.
2299 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
2300 vmware_nosession | **Optional.** No auth session - IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
2301 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
2302 vmware_password | **Optional.** The username's password. No value defined as default.
2303 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
2304 vmware_warn | **Optional.** The warning threshold. No value defined as default.
2305 vmware_crit | **Optional.** The critical threshold. No value defined as default.
2308 ## <a id="plugins-contrib-vmware-esx-soap-host-io-write-latency"></a> vmware-esx-soap-host-io-write-latency
2310 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.
2315 ------------------------|--------------
2316 vmware_host | **Required.** ESX or ESXi hostname.
2317 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
2318 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".
2319 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".
2320 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
2321 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
2322 vmware_sessionfile | **Optional.** Session file name enhancement.
2323 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
2324 vmware_nosession | **Optional.** No auth session - IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
2325 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
2326 vmware_password | **Optional.** The username's password. No value defined as default.
2327 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
2328 vmware_warn | **Optional.** The warning threshold. No value defined as default.
2329 vmware_crit | **Optional.** The critical threshold. No value defined as default.
2332 ## <a id="plugins-contrib-vmware-esx-soap-host-io-usage"></a> vmware-esx-soap-host-io-usage
2334 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.
2339 ------------------------|--------------
2340 vmware_host | **Required.** ESX or ESXi hostname.
2341 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
2342 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".
2343 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".
2344 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
2345 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
2346 vmware_sessionfile | **Optional.** Session file name enhancement.
2347 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
2348 vmware_nosession | **Optional.** No auth session - IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
2349 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
2350 vmware_password | **Optional.** The username's password. No value defined as default.
2351 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
2352 vmware_warn | **Optional.** The warning threshold. No value defined as default.
2353 vmware_crit | **Optional.** The critical threshold. No value defined as default.
2356 ## <a id="plugins-contrib-vmware-esx-soap-host-io-kernel-latency"></a> vmware-esx-soap-host-io-kernel-latency
2358 Check command object for the `check_vmware_esx` plugin. Average amount of time (ms) spent by VMkernel processing each SCSI command.
2363 ------------------------|--------------
2364 vmware_host | **Required.** ESX or ESXi hostname.
2365 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
2366 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".
2367 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".
2368 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
2369 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
2370 vmware_sessionfile | **Optional.** Session file name enhancement.
2371 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
2372 vmware_nosession | **Optional.** No auth session - IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
2373 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
2374 vmware_password | **Optional.** The username's password. No value defined as default.
2375 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
2376 vmware_warn | **Optional.** The warning threshold. No value defined as default.
2377 vmware_crit | **Optional.** The critical threshold. No value defined as default.
2380 ## <a id="plugins-contrib-vmware-esx-soap-host-io-device-latency"></a> vmware-esx-soap-host-io-device-latency
2382 Check command object for the `check_vmware_esx` plugin. Average amount of time (ms) to complete a SCSI command from the physical device.
2387 ------------------------|--------------
2388 vmware_host | **Required.** ESX or ESXi hostname.
2389 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
2390 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".
2391 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".
2392 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
2393 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
2394 vmware_sessionfile | **Optional.** Session file name enhancement.
2395 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
2396 vmware_nosession | **Optional.** No auth session - IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
2397 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
2398 vmware_password | **Optional.** The username's password. No value defined as default.
2399 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
2400 vmware_warn | **Optional.** The warning threshold. No value defined as default.
2401 vmware_crit | **Optional.** The critical threshold. No value defined as default.
2404 ## <a id="plugins-contrib-vmware-esx-soap-host-io-queue-latency"></a> vmware-esx-soap-host-io-queue-latency
2406 Check command object for the `check_vmware_esx` plugin. Average amount of time (ms) spent in the VMkernel queue.
2411 ------------------------|--------------
2412 vmware_host | **Required.** ESX or ESXi hostname.
2413 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
2414 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".
2415 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".
2416 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
2417 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
2418 vmware_sessionfile | **Optional.** Session file name enhancement.
2419 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
2420 vmware_nosession | **Optional.** No auth session - IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
2421 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
2422 vmware_password | **Optional.** The username's password. No value defined as default.
2423 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
2424 vmware_warn | **Optional.** The warning threshold. No value defined as default.
2425 vmware_crit | **Optional.** The critical threshold. No value defined as default.
2428 ## <a id="plugins-contrib-vmware-esx-soap-host-io-total-latency"></a> vmware-esx-soap-host-io-total-latency
2430 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.
2435 ------------------------|--------------
2436 vmware_host | **Required.** ESX or ESXi hostname.
2437 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
2438 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".
2439 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".
2440 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
2441 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
2442 vmware_sessionfile | **Optional.** Session file name enhancement.
2443 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
2444 vmware_nosession | **Optional.** No auth session - IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
2445 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
2446 vmware_password | **Optional.** The username's password. No value defined as default.
2447 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
2448 vmware_warn | **Optional.** The warning threshold. No value defined as default.
2449 vmware_crit | **Optional.** The critical threshold. No value defined as default.
2452 ## <a id="plugins-contrib-vmware-esx-soap-host-media"></a> vmware-esx-soap-host-media
2454 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.
2459 ------------------------|--------------
2460 vmware_host | **Required.** ESX or ESXi hostname.
2461 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
2462 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".
2463 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".
2464 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
2465 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
2466 vmware_sessionfile | **Optional.** Session file name enhancement.
2467 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
2468 vmware_nosession | **Optional.** No auth session - IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
2469 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
2470 vmware_password | **Optional.** The username's password. No value defined as default.
2471 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
2472 vmware_exclude | **Optional.** Blacklist VMs name. No value defined as default.
2473 vmware_include | **Optional.** Whitelist VMs name. No value defined as default.
2474 vmware_isregexp | **Optional.** Treat blacklist and whitelist expressions as regexp.
2475 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.
2478 ## <a id="plugins-contrib-vmware-esx-soap-host-service"></a> vmware-esx-soap-host-service
2480 Check command object for the `check_vmware_esx` plugin. Shows host service info.
2485 ------------------------|--------------
2486 vmware_host | **Required.** ESX or ESXi hostname.
2487 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
2488 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".
2489 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".
2490 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
2491 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
2492 vmware_sessionfile | **Optional.** Session file name enhancement.
2493 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
2494 vmware_nosession | **Optional.** No auth session - IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
2495 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
2496 vmware_password | **Optional.** The username's password. No value defined as default.
2497 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
2498 vmware_exclude | **Optional.** Blacklist services name. No value defined as default.
2499 vmware_include | **Optional.** Whitelist services name. No value defined as default.
2500 vmware_isregexp | **Optional.** Treat blacklist and whitelist expressions as regexp.
2501 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.
2504 ## <a id="plugins-contrib-vmware-esx-soap-host-runtime"></a> vmware-esx-soap-host-runtime
2506 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.
2511 ------------------------|--------------
2512 vmware_host | **Required.** ESX or ESXi hostname.
2513 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
2514 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".
2515 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".
2516 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
2517 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
2518 vmware_sessionfile | **Optional.** Session file name enhancement.
2519 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
2520 vmware_nosession | **Optional.** No auth session - IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
2521 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
2522 vmware_password | **Optional.** The username's password. No value defined as default.
2523 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
2526 ## <a id="plugins-contrib-vmware-esx-soap-host-runtime-con"></a> vmware-esx-soap-host-runtime-con
2528 Check command object for the `check_vmware_esx` plugin. Shows connection state.
2533 ------------------------|--------------
2534 vmware_host | **Required.** ESX or ESXi hostname.
2535 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
2536 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".
2537 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".
2538 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
2539 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
2540 vmware_sessionfile | **Optional.** Session file name enhancement.
2541 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
2542 vmware_nosession | **Optional.** No auth session - IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
2543 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
2544 vmware_password | **Optional.** The username's password. No value defined as default.
2545 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
2548 ## <a id="plugins-contrib-vmware-esx-soap-host-runtime-listvms"></a> vmware-esx-soap-host-runtime-listvms
2550 Check command object for the `check_vmware_esx` plugin. List of VMware machines and their status.
2555 ------------------------|--------------
2556 vmware_host | **Required.** ESX or ESXi hostname.
2557 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
2558 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".
2559 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".
2560 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
2561 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
2562 vmware_sessionfile | **Optional.** Session file name enhancement.
2563 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
2564 vmware_nosession | **Optional.** No auth session - IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
2565 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
2566 vmware_password | **Optional.** The username's password. No value defined as default.
2567 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
2568 vmware_exclude | **Optional.** Blacklist VMs name. No value defined as default.
2569 vmware_include | **Optional.** Whitelist VMs name. No value defined as default.
2570 vmware_isregexp | **Optional.** Treat blacklist and whitelist expressions as regexp.
2571 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.
2574 ## <a id="plugins-contrib-vmware-esx-soap-host-runtime-status"></a> vmware-esx-soap-host-runtime-status
2576 Check command object for the `check_vmware_esx` plugin. Overall object status (gray/green/red/yellow).
2581 ------------------------|--------------
2582 vmware_host | **Required.** ESX or ESXi hostname.
2583 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
2584 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".
2585 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".
2586 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
2587 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
2588 vmware_sessionfile | **Optional.** Session file name enhancement.
2589 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
2590 vmware_nosession | **Optional.** No auth session - IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
2591 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
2592 vmware_password | **Optional.** The username's password. No value defined as default.
2593 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
2596 ## <a id="plugins-contrib-vmware-esx-soap-host-runtime-health"></a> vmware-esx-soap-host-runtime-health
2598 Check command object for the `check_vmware_esx` plugin. Checks cpu/storage/memory/sensor status.
2603 ------------------------|--------------
2604 vmware_host | **Required.** ESX or ESXi hostname.
2605 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
2606 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".
2607 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".
2608 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
2609 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
2610 vmware_sessionfile | **Optional.** Session file name enhancement.
2611 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
2612 vmware_nosession | **Optional.** No auth session - IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
2613 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
2614 vmware_password | **Optional.** The username's password. No value defined as default.
2615 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
2616 vmware_exclude | **Optional.** Blacklist status name. No value defined as default.
2617 vmware_include | **Optional.** Whitelist status name. No value defined as default.
2618 vmware_isregexp | **Optional.** Treat blacklist and whitelist expressions as regexp.
2621 ## <a id="plugins-contrib-vmware-esx-soap-host-runtime-health-listsensors"></a> vmware-esx-soap-host-runtime-health-listsensors
2623 Check command object for the `check_vmware_esx` plugin. List all available sensors(use for listing purpose only).
2628 ------------------------|--------------
2629 vmware_host | **Required.** ESX or ESXi hostname.
2630 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
2631 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".
2632 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".
2633 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
2634 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
2635 vmware_sessionfile | **Optional.** Session file name enhancement.
2636 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
2637 vmware_nosession | **Optional.** No auth session - IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
2638 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
2639 vmware_password | **Optional.** The username's password. No value defined as default.
2640 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
2641 vmware_exclude | **Optional.** Blacklist status name. No value defined as default.
2642 vmware_include | **Optional.** Whitelist status name. No value defined as default.
2643 vmware_isregexp | **Optional.** Treat blacklist and whitelist expressions as regexp.
2646 ## <a id="plugins-contrib-vmware-esx-soap-host-runtime-health-nostoragestatus"></a> vmware-esx-soap-host-runtime-health-nostoragestatus
2648 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**.
2653 ------------------------|--------------
2654 vmware_host | **Required.** ESX or ESXi hostname.
2655 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
2656 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".
2657 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".
2658 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
2659 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
2660 vmware_sessionfile | **Optional.** Session file name enhancement.
2661 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
2662 vmware_nosession | **Optional.** No auth session - IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
2663 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
2664 vmware_password | **Optional.** The username's password. No value defined as default.
2665 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
2666 vmware_exclude | **Optional.** Blacklist status name. No value defined as default.
2667 vmware_include | **Optional.** Whitelist status name. No value defined as default.
2668 vmware_isregexp | **Optional.** Treat blacklist and whitelist expressions as regexp.
2671 ## <a id="plugins-contrib-vmware-esx-soap-host-runtime-storagehealth"></a> vmware-esx-soap-host-runtime-storagehealth
2673 Check command object for the `check_vmware_esx` plugin. Local storage status check.
2678 ------------------------|--------------
2679 vmware_host | **Required.** ESX or ESXi hostname.
2680 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
2681 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".
2682 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".
2683 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
2684 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
2685 vmware_sessionfile | **Optional.** Session file name enhancement.
2686 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
2687 vmware_nosession | **Optional.** No auth session - IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
2688 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
2689 vmware_password | **Optional.** The username's password. No value defined as default.
2690 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
2691 vmware_exclude | **Optional.** Blacklist storage name. No value defined as default.
2692 vmware_include | **Optional.** Whitelist storage name. No value defined as default.
2693 vmware_isregexp | **Optional.** Treat blacklist and whitelist expressions as regexp.
2694 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.
2697 ## <a id="plugins-contrib-vmware-esx-soap-host-runtime-temp"></a> vmware-esx-soap-host-runtime-temp
2699 Check command object for the `check_vmware_esx` plugin. Lists all temperature sensors.
2704 ------------------------|--------------
2705 vmware_host | **Required.** ESX or ESXi hostname.
2706 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
2707 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".
2708 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".
2709 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
2710 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
2711 vmware_sessionfile | **Optional.** Session file name enhancement.
2712 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
2713 vmware_nosession | **Optional.** No auth session - IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
2714 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
2715 vmware_password | **Optional.** The username's password. No value defined as default.
2716 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
2717 vmware_exclude | **Optional.** Blacklist sensor name. No value defined as default.
2718 vmware_include | **Optional.** Whitelist sensor name. No value defined as default.
2719 vmware_isregexp | **Optional.** Treat blacklist and whitelist expressions as regexp.
2720 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.
2723 ## <a id="plugins-contrib-vmware-esx-soap-host-runtime-issues"></a> vmware-esx-soap-host-runtime-issues
2725 Check command object for the `check_vmware_esx` plugin. Lists all configuration issues for the host.
2730 ------------------------|--------------
2731 vmware_host | **Required.** ESX or ESXi hostname.
2732 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
2733 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".
2734 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".
2735 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
2736 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
2737 vmware_sessionfile | **Optional.** Session file name enhancement.
2738 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
2739 vmware_nosession | **Optional.** No auth session - IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
2740 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
2741 vmware_password | **Optional.** The username's password. No value defined as default.
2742 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
2743 vmware_exclude | **Optional.** Blacklist configuration issues. No value defined as default.
2744 vmware_include | **Optional.** Whitelist configuration issues. No value defined as default.
2745 vmware_isregexp | **Optional.** Treat blacklist and whitelist expressions as regexp.
2746 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.
2749 ## <a id="plugins-contrib-vmware-esx-soap-host-storage"></a> vmware-esx-soap-host-storage
2751 Check command object for the `check_vmware_esx` plugin. Shows Host storage info.
2756 ------------------------|--------------
2757 vmware_host | **Required.** ESX or ESXi hostname.
2758 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
2759 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".
2760 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".
2761 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
2762 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
2763 vmware_sessionfile | **Optional.** Session file name enhancement.
2764 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
2765 vmware_nosession | **Optional.** No auth session - IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
2766 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
2767 vmware_password | **Optional.** The username's password. No value defined as default.
2768 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
2769 vmware_exclude | **Optional.** Blacklist adapters, luns and paths. No value defined as default.
2770 vmware_include | **Optional.** Whitelist adapters, luns and paths. No value defined as default.
2771 vmware_isregexp | **Optional.** Treat blacklist and whitelist expressions as regexp.
2774 ## <a id="plugins-contrib-vmware-esx-soap-host-storage-adapter"></a> vmware-esx-soap-host-storage-adapter
2776 Check command object for the `check_vmware_esx` plugin. List host bus adapters.
2781 ------------------------|--------------
2782 vmware_host | **Required.** ESX or ESXi hostname.
2783 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
2784 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".
2785 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".
2786 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
2787 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
2788 vmware_sessionfile | **Optional.** Session file name enhancement.
2789 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
2790 vmware_nosession | **Optional.** No auth session - IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
2791 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
2792 vmware_password | **Optional.** The username's password. No value defined as default.
2793 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
2794 vmware_exclude | **Optional.** Blacklist adapters. No value defined as default.
2795 vmware_include | **Optional.** Whitelist adapters. No value defined as default.
2796 vmware_isregexp | **Optional.** Treat blacklist and whitelist expressions as regexp.
2797 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.
2800 ## <a id="plugins-contrib-vmware-esx-soap-host-storage-lun"></a> vmware-esx-soap-host-storage-lun
2802 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.
2807 ------------------------|--------------
2808 vmware_host | **Required.** ESX or ESXi hostname.
2809 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
2810 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".
2811 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".
2812 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
2813 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
2814 vmware_sessionfile | **Optional.** Session file name enhancement.
2815 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
2816 vmware_nosession | **Optional.** No auth session - IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
2817 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
2818 vmware_password | **Optional.** The username's password. No value defined as default.
2819 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
2820 vmware_exclude | **Optional.** Blacklist luns. No value defined as default.
2821 vmware_include | **Optional.** Whitelist luns. No value defined as default.
2822 vmware_isregexp | **Optional.** Treat blacklist and whitelist expressions as regexp.
2823 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.
2826 ## <a id="plugins-contrib-vmware-esx-soap-host-storage-path"></a> vmware-esx-soap-host-storage-path
2828 Check command object for the `check_vmware_esx` plugin. List multipaths and the associated paths.
2833 ------------------------|--------------
2834 vmware_host | **Required.** ESX or ESXi hostname.
2835 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
2836 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".
2837 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".
2838 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
2839 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
2840 vmware_sessionfile | **Optional.** Session file name enhancement.
2841 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
2842 vmware_nosession | **Optional.** No auth session - IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
2843 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
2844 vmware_password | **Optional.** The username's password. No value defined as default.
2845 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
2846 vmware_alertonly | **Optional.** List only alerting units. Important here to avoid masses of data. Defaults to "false".
2847 vmware_exclude | **Optional.** Blacklist paths. No value defined as default.
2848 vmware_include | **Optional.** Whitelist paths. No value defined as default.
2849 vmware_isregexp | **Optional.** Treat blacklist and whitelist expressions as regexp.
2850 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.
2853 ## <a id="plugins-contrib-vmware-esx-soap-vm-cpu"></a> vmware-esx-soap-vm-cpu
2855 Check command object for the `check_vmware_esx` plugin. Shows all CPU usage info.
2860 ------------------------|--------------
2861 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. Conflicts with **vmware_host**.
2862 vmware_host | **Optional.** ESX or ESXi hostname. Conflicts with **vmware_datacenter**.
2863 vmware_vmname | **Required.** Virtual machine name.
2864 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
2865 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".
2866 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".
2867 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
2868 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
2869 vmware_sessionfile | **Optional.** Session file name enhancement.
2870 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
2871 vmware_nosession | **Optional.** No auth session - IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
2872 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
2873 vmware_password | **Optional.** The username's password. No value defined as default.
2874 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
2878 ## <a id="plugins-contrib-vmware-esx-soap-vm-cpu-ready"></a> vmware-esx-soap-vm-cpu-ready
2880 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.
2885 ------------------------|--------------
2886 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. Conflicts with **vmware_host**.
2887 vmware_host | **Optional.** ESX or ESXi hostname. Conflicts with **vmware_datacenter**.
2888 vmware_vmname | **Required.** Virtual machine name.
2889 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
2890 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".
2891 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".
2892 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
2893 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
2894 vmware_sessionfile | **Optional.** Session file name enhancement.
2895 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
2896 vmware_nosession | **Optional.** No auth session - IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
2897 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
2898 vmware_password | **Optional.** The username's password. No value defined as default.
2899 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
2900 vmware_warn | **Optional.** The warning threshold. No value defined as default.
2901 vmware_crit | **Optional.** The critical threshold. No value defined as default.
2904 ## <a id="plugins-contrib-vmware-esx-soap-vm-cpu-wait"></a> vmware-esx-soap-vm-cpu-wait
2906 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.
2911 ------------------------|--------------
2912 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. Conflicts with **vmware_host**.
2913 vmware_host | **Optional.** ESX or ESXi hostname. Conflicts with **vmware_datacenter**.
2914 vmware_vmname | **Required.** Virtual machine name.
2915 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
2916 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".
2917 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".
2918 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
2919 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
2920 vmware_sessionfile | **Optional.** Session file name enhancement.
2921 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
2922 vmware_nosession | **Optional.** No auth session - IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
2923 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
2924 vmware_password | **Optional.** The username's password. No value defined as default.
2925 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
2926 vmware_warn | **Optional.** The warning threshold. No value defined as default.
2927 vmware_crit | **Optional.** The critical threshold. No value defined as default.
2930 ## <a id="plugins-contrib-vmware-esx-soap-vm-cpu-usage"></a> vmware-esx-soap-vm-cpu-usage
2932 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.
2937 ------------------------|--------------
2938 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. Conflicts with **vmware_host**.
2939 vmware_host | **Optional.** ESX or ESXi hostname. Conflicts with **vmware_datacenter**.
2940 vmware_vmname | **Required.** Virtual machine name.
2941 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
2942 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".
2943 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".
2944 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
2945 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
2946 vmware_sessionfile | **Optional.** Session file name enhancement.
2947 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
2948 vmware_nosession | **Optional.** No auth session - IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
2949 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
2950 vmware_password | **Optional.** The username's password. No value defined as default.
2951 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
2952 vmware_warn | **Optional.** Warning threshold in percent. Defaults to "80%".
2953 vmware_crit | **Optional.** Critical threshold in percent. Defaults to "90%".
2956 ## <a id="plugins-contrib-vmware-esx-soap-vm-mem"></a> vmware-esx-soap-vm-mem
2958 Check command object for the `check_vmware_esx` plugin. Shows all memory info, except overall.
2963 ------------------------|--------------
2964 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. Conflicts with **vmware_host**.
2965 vmware_host | **Optional.** ESX or ESXi hostname. Conflicts with **vmware_datacenter**.
2966 vmware_vmname | **Required.** Virtual machine name.
2967 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
2968 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".
2969 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".
2970 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
2971 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
2972 vmware_sessionfile | **Optional.** Session file name enhancement.
2973 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
2974 vmware_nosession | **Optional.** No auth session - IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
2975 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
2976 vmware_password | **Optional.** The username's password. No value defined as default.
2977 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
2980 ## <a id="plugins-contrib-vmware-esx-soap-vm-mem-usage"></a> vmware-esx-soap-vm-mem-usage
2982 Check command object for the `check_vmware_esx` plugin. Average mem usage in percentage of configured virtual machine "physical" memory.
2987 ------------------------|--------------
2988 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. Conflicts with **vmware_host**.
2989 vmware_host | **Optional.** ESX or ESXi hostname. Conflicts with **vmware_datacenter**.
2990 vmware_vmname | **Required.** Virtual machine name.
2991 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
2992 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".
2993 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".
2994 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
2995 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
2996 vmware_sessionfile | **Optional.** Session file name enhancement.
2997 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
2998 vmware_nosession | **Optional.** No auth session - IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
2999 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
3000 vmware_password | **Optional.** The username's password. No value defined as default.
3001 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
3002 vmware_warn | **Optional.** Warning threshold in percent. Defaults to "80%".
3003 vmware_crit | **Optional.** Critical threshold in percent. Defaults to "90%".
3006 ## <a id="plugins-contrib-vmware-esx-soap-vm-mem-consumed"></a> vmware-esx-soap-vm-mem-consumed
3008 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>
3009 **vm consumed memory = memory granted - memory saved**
3014 ------------------------|--------------
3015 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. Conflicts with **vmware_host**.
3016 vmware_host | **Optional.** ESX or ESXi hostname. Conflicts with **vmware_datacenter**.
3017 vmware_vmname | **Required.** Virtual machine name.
3018 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
3019 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".
3020 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".
3021 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
3022 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
3023 vmware_sessionfile | **Optional.** Session file name enhancement.
3024 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
3025 vmware_nosession | **Optional.** No auth session - IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
3026 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
3027 vmware_password | **Optional.** The username's password. No value defined as default.
3028 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
3029 vmware_warn | **Optional.** The warning threshold. No value defined as default.
3030 vmware_crit | **Optional.** The critical threshold. No value defined as default.
3033 ## <a id="plugins-contrib-vmware-esx-soap-vm-mem-memctl"></a> vmware-esx-soap-vm-mem-memctl
3035 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.
3040 ------------------------|--------------
3041 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. Conflicts with **vmware_host**.
3042 vmware_host | **Optional.** ESX or ESXi hostname. Conflicts with **vmware_datacenter**.
3043 vmware_vmname | **Required.** Virtual machine name.
3044 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
3045 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".
3046 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".
3047 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
3048 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
3049 vmware_sessionfile | **Optional.** Session file name enhancement.
3050 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
3051 vmware_nosession | **Optional.** No auth session - IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
3052 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
3053 vmware_password | **Optional.** The username's password. No value defined as default.
3054 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
3055 vmware_warn | **Optional.** The warning threshold. No value defined as default.
3056 vmware_crit | **Optional.** The critical threshold. No value defined as default.
3060 ## <a id="plugins-contrib-vmware-esx-soap-vm-net"></a> vmware-esx-soap-vm-net
3062 Check command object for the `check_vmware_esx` plugin. Shows net info.
3067 ------------------------|--------------
3068 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. Conflicts with **vmware_host**.
3069 vmware_host | **Optional.** ESX or ESXi hostname. Conflicts with **vmware_datacenter**.
3070 vmware_vmname | **Required.** Virtual machine name.
3071 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
3072 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".
3073 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".
3074 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
3075 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
3076 vmware_sessionfile | **Optional.** Session file name enhancement.
3077 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
3078 vmware_nosession | **Optional.** No auth session - IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
3079 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
3080 vmware_password | **Optional.** The username's password. No value defined as default.
3081 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
3084 ## <a id="plugins-contrib-vmware-esx-soap-vm-net-usage"></a> vmware-esx-soap-vm-net-usage
3086 Check command object for the `check_vmware_esx` plugin. Overall network usage in KBps(Kilobytes per Second).
3091 ------------------------|--------------
3092 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. Conflicts with **vmware_host**.
3093 vmware_host | **Optional.** ESX or ESXi hostname. Conflicts with **vmware_datacenter**.
3094 vmware_vmname | **Required.** Virtual machine name.
3095 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
3096 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".
3097 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".
3098 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
3099 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
3100 vmware_sessionfile | **Optional.** Session file name enhancement.
3101 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
3102 vmware_nosession | **Optional.** No auth session - IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
3103 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
3104 vmware_password | **Optional.** The username's password. No value defined as default.
3105 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
3106 vmware_warn | **Optional.** The warning threshold. No value defined as default.
3107 vmware_crit | **Optional.** The critical threshold. No value defined as default.
3110 ## <a id="plugins-contrib-vmware-esx-soap-vm-net-receive"></a> vmware-esx-soap-vm-net-receive
3112 Check command object for the `check_vmware_esx` plugin. Receive in KBps(Kilobytes per Second).
3117 ------------------------|--------------
3118 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. Conflicts with **vmware_host**.
3119 vmware_host | **Optional.** ESX or ESXi hostname. Conflicts with **vmware_datacenter**.
3120 vmware_vmname | **Required.** Virtual machine name.
3121 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
3122 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".
3123 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".
3124 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
3125 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
3126 vmware_sessionfile | **Optional.** Session file name enhancement.
3127 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
3128 vmware_nosession | **Optional.** No auth session - IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
3129 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
3130 vmware_password | **Optional.** The username's password. No value defined as default.
3131 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
3132 vmware_warn | **Optional.** The warning threshold. No value defined as default.
3133 vmware_crit | **Optional.** The critical threshold. No value defined as default.
3136 ## <a id="plugins-contrib-vmware-esx-soap-vm-net-send"></a> vmware-esx-soap-vm-net-send
3138 Check command object for the `check_vmware_esx` plugin. Send in KBps(Kilobytes per Second).
3143 ------------------------|--------------
3144 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. Conflicts with **vmware_host**.
3145 vmware_host | **Optional.** ESX or ESXi hostname. Conflicts with **vmware_datacenter**.
3146 vmware_vmname | **Required.** Virtual machine name.
3147 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
3148 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".
3149 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".
3150 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
3151 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
3152 vmware_sessionfile | **Optional.** Session file name enhancement.
3153 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
3154 vmware_nosession | **Optional.** No auth session - IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
3155 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
3156 vmware_password | **Optional.** The username's password. No value defined as default.
3157 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
3158 vmware_warn | **Optional.** The warning threshold. No value defined as default.
3159 vmware_crit | **Optional.** The critical threshold. No value defined as default.
3162 ## <a id="plugins-contrib-vmware-esx-soap-vm-io"></a> vmware-esx-soap-vm-io
3164 Check command object for the `check_vmware_esx` plugin. SShows all disk io info. Without subselect no thresholds can be given. All I/O values are aggregated from historical intervals over the past 24 hours with a 5 minute sample rate.
3169 ------------------------|--------------
3170 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. Conflicts with **vmware_host**.
3171 vmware_host | **Optional.** ESX or ESXi hostname. Conflicts with **vmware_datacenter**.
3172 vmware_vmname | **Required.** Virtual machine name.
3173 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
3174 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".
3175 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".
3176 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
3177 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
3178 vmware_sessionfile | **Optional.** Session file name enhancement.
3179 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
3180 vmware_nosession | **Optional.** No auth session - IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
3181 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
3182 vmware_password | **Optional.** The username's password. No value defined as default.
3183 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
3186 ## <a id="plugins-contrib-vmware-esx-soap-vm-io-read"></a> vmware-esx-soap-vm-io-read
3188 Check command object for the `check_vmware_esx` plugin. Average number of kilobytes read from the disk each second.
3193 ------------------------|--------------
3194 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. Conflicts with **vmware_host**.
3195 vmware_host | **Optional.** ESX or ESXi hostname. Conflicts with **vmware_datacenter**.
3196 vmware_vmname | **Required.** Virtual machine name.
3197 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
3198 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".
3199 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".
3200 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
3201 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
3202 vmware_sessionfile | **Optional.** Session file name enhancement.
3203 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
3204 vmware_nosession | **Optional.** No auth session - IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
3205 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
3206 vmware_password | **Optional.** The username's password. No value defined as default.
3207 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
3208 vmware_warn | **Optional.** The warning threshold. No value defined as default.
3209 vmware_crit | **Optional.** The critical threshold. No value defined as default.
3212 ## <a id="plugins-contrib-vmware-esx-soap-vm-io-write"></a> vmware-esx-soap-vm-io-write
3214 Check command object for the `check_vmware_esx` plugin. Average number of kilobytes written to disk each second.
3219 ------------------------|--------------
3220 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. Conflicts with **vmware_host**.
3221 vmware_host | **Optional.** ESX or ESXi hostname. Conflicts with **vmware_datacenter**.
3222 vmware_vmname | **Required.** Virtual machine name.
3223 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
3224 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".
3225 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".
3226 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
3227 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
3228 vmware_sessionfile | **Optional.** Session file name enhancement.
3229 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
3230 vmware_nosession | **Optional.** No auth session - IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
3231 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
3232 vmware_password | **Optional.** The username's password. No value defined as default.
3233 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
3234 vmware_warn | **Optional.** The warning threshold. No value defined as default.
3235 vmware_crit | **Optional.** The critical threshold. No value defined as default.
3238 ## <a id="plugins-contrib-vmware-esx-soap-vm-io-usage"></a> vmware-esx-soap-vm-io-usage
3240 Check command object for the `check_vmware_esx` plugin. Aggregated disk I/O rate.
3245 ------------------------|--------------
3246 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. Conflicts with **vmware_host**.
3247 vmware_host | **Optional.** ESX or ESXi hostname. Conflicts with **vmware_datacenter**.
3248 vmware_vmname | **Required.** Virtual machine name.
3249 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
3250 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".
3251 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".
3252 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
3253 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
3254 vmware_sessionfile | **Optional.** Session file name enhancement.
3255 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
3256 vmware_nosession | **Optional.** No auth session - IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
3257 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
3258 vmware_password | **Optional.** The username's password. No value defined as default.
3259 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
3260 vmware_warn | **Optional.** The warning threshold. No value defined as default.
3261 vmware_crit | **Optional.** The critical threshold. No value defined as default.
3264 ## <a id="plugins-contrib-vmware-esx-soap-vm-runtime"></a> vmware-esx-soap-vm-runtime
3266 Check command object for the `check_vmware_esx` plugin. Shows virtual machine runtime info.
3271 ------------------------|--------------
3272 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. Conflicts with **vmware_host**.
3273 vmware_host | **Optional.** ESX or ESXi hostname. Conflicts with **vmware_datacenter**.
3274 vmware_vmname | **Required.** Virtual machine name.
3275 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
3276 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".
3277 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".
3278 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
3279 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
3280 vmware_sessionfile | **Optional.** Session file name enhancement.
3281 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
3282 vmware_nosession | **Optional.** No auth session - IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
3283 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
3284 vmware_password | **Optional.** The username's password. No value defined as default.
3285 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
3288 ## <a id="plugins-contrib-vmware-esx-soap-vm-runtime-con"></a> vmware-esx-soap-vm-runtime-con
3290 Check command object for the `check_vmware_esx` plugin. Shows the connection state.
3295 ------------------------|--------------
3296 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. Conflicts with **vmware_host**.
3297 vmware_host | **Optional.** ESX or ESXi hostname. Conflicts with **vmware_datacenter**.
3298 vmware_vmname | **Required.** Virtual machine name.
3299 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
3300 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".
3301 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".
3302 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
3303 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
3304 vmware_sessionfile | **Optional.** Session file name enhancement.
3305 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
3306 vmware_nosession | **Optional.** No auth session - IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
3307 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
3308 vmware_password | **Optional.** The username's password. No value defined as default.
3309 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
3312 ## <a id="plugins-contrib-vmware-esx-soap-vm-runtime-powerstate"></a> vmware-esx-soap-vm-runtime-powerstate
3314 Check command object for the `check_vmware_esx` plugin. Shows virtual machine power state: poweredOn, poweredOff or suspended.
3319 ------------------------|--------------
3320 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. Conflicts with **vmware_host**.
3321 vmware_host | **Optional.** ESX or ESXi hostname. Conflicts with **vmware_datacenter**.
3322 vmware_vmname | **Required.** Virtual machine name.
3323 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
3324 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".
3325 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".
3326 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
3327 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
3328 vmware_sessionfile | **Optional.** Session file name enhancement.
3329 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
3330 vmware_nosession | **Optional.** No auth session - IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
3331 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
3332 vmware_password | **Optional.** The username's password. No value defined as default.
3333 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
3336 ## <a id="plugins-contrib-vmware-esx-soap-vm-runtime-status"></a> vmware-esx-soap-vm-runtime-status
3338 Check command object for the `check_vmware_esx` plugin. Overall object status (gray/green/red/yellow).
3343 ------------------------|--------------
3344 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. Conflicts with **vmware_host**.
3345 vmware_host | **Optional.** ESX or ESXi hostname. Conflicts with **vmware_datacenter**.
3346 vmware_vmname | **Required.** Virtual machine name.
3347 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
3348 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".
3349 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".
3350 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
3351 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
3352 vmware_sessionfile | **Optional.** Session file name enhancement.
3353 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
3354 vmware_nosession | **Optional.** No auth session - IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
3355 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
3356 vmware_password | **Optional.** The username's password. No value defined as default.
3357 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
3360 ## <a id="plugins-contrib-vmware-esx-soap-vm-runtime-consoleconnections"></a> vmware-esx-soap-vm-runtime-consoleconnections
3362 Check command object for the `check_vmware_esx` plugin. Console connections to virtual machine.
3367 ------------------------|--------------
3368 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. Conflicts with **vmware_host**.
3369 vmware_host | **Optional.** ESX or ESXi hostname. Conflicts with **vmware_datacenter**.
3370 vmware_vmname | **Required.** Virtual machine name.
3371 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
3372 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".
3373 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".
3374 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
3375 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
3376 vmware_sessionfile | **Optional.** Session file name enhancement.
3377 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
3378 vmware_nosession | **Optional.** No auth session - IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
3379 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
3380 vmware_password | **Optional.** The username's password. No value defined as default.
3381 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
3382 vmware_warn | **Optional.** The warning threshold. No value defined as default.
3383 vmware_crit | **Optional.** The critical threshold. No value defined as default.
3386 ## <a id="plugins-contrib-vmware-esx-soap-vm-runtime-gueststate"></a> vmware-esx-soap-vm-runtime-gueststate
3388 Check command object for the `check_vmware_esx` plugin. Guest OS status. Needs VMware Tools installed and running.
3393 ------------------------|--------------
3394 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. Conflicts with **vmware_host**.
3395 vmware_host | **Optional.** ESX or ESXi hostname. Conflicts with **vmware_datacenter**.
3396 vmware_vmname | **Required.** Virtual machine name.
3397 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
3398 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".
3399 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".
3400 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
3401 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
3402 vmware_sessionfile | **Optional.** Session file name enhancement.
3403 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
3404 vmware_nosession | **Optional.** No auth session - IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
3405 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
3406 vmware_password | **Optional.** The username's password. No value defined as default.
3407 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
3409 ## <a id="plugins-contrib-vmware-esx-soap-vm-runtime-tools"></a> vmware-esx-soap-vm-runtime-tools
3411 Check command object for the `check_vmware_esx` plugin. Guest OS status. VMware tools status.
3416 ------------------------|--------------
3417 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. Conflicts with **vmware_host**.
3418 vmware_host | **Optional.** ESX or ESXi hostname. Conflicts with **vmware_datacenter**.
3419 vmware_vmname | **Required.** Virtual machine name.
3420 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
3421 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".
3422 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".
3423 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
3424 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
3425 vmware_sessionfile | **Optional.** Session file name enhancement.
3426 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
3427 vmware_nosession | **Optional.** No auth session - IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
3428 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
3429 vmware_password | **Optional.** The username's password. No value defined as default.
3430 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
3433 ## <a id="plugins-contrib-vmware-esx-soap-vm-runtime-issues"></a> vmware-esx-soap-vm-runtime-issues
3435 Check command object for the `check_vmware_esx` plugin. All issues for the virtual machine.
3440 ------------------------|--------------
3441 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. Conflicts with **vmware_host**.
3442 vmware_host | **Optional.** ESX or ESXi hostname. Conflicts with **vmware_datacenter**.
3443 vmware_vmname | **Required.** Virtual machine name.
3444 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
3445 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".
3446 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".
3447 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
3448 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
3449 vmware_sessionfile | **Optional.** Session file name enhancement.
3450 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
3451 vmware_nosession | **Optional.** No auth session - IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
3452 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
3453 vmware_password | **Optional.** The username's password. No value defined as default.
3454 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
3455 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.