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.
202 ## <a id="plugin-check-command-dummy"></a> dummy
204 Check command object for the `check_dummy` plugin.
209 ----------------|--------------
210 dummy_state | **Optional.** The state. Can be one of 0 (ok), 1 (warning), 2 (critical) and 3 (unknown). Defaults to 0.
211 dummy_text | **Optional.** Plugin output. Defaults to "Check was successful.".
214 ## <a id="plugin-check-command-fping4"></a> fping4
216 Check command object for the `check_fping` plugin.
221 ----------------|--------------
222 fping_address | **Optional.** The host's IPv4 address. Defaults to "$address$".
223 fping_wrta | **Optional.** The RTA warning threshold in milliseconds. Defaults to 100.
224 fping_wpl | **Optional.** The packet loss warning threshold in %. Defaults to 5.
225 fping_crta | **Optional.** The RTA critical threshold in milliseconds. Defaults to 200.
226 fping_cpl | **Optional.** The packet loss critical threshold in %. Defaults to 15.
227 fping_number | **Optional.** The number of packets to send. Defaults to 5.
228 fping_interval | **Optional.** The interval between packets in milli-seconds. Defaults to 500.
229 fping_bytes | **Optional.** The size of ICMP packet.
230 fping_target_timeout | **Optional.** The target timeout in milli-seconds.
231 fping_source_ip | **Optional.** The name or ip address of the source ip.
232 fping_source_interface | **Optional.** The source interface name.
235 ## <a id="plugin-check-command-fping6"></a> fping6
237 Check command object for the `check_fping` plugin.
242 ----------------|--------------
243 fping_address | **Optional.** The host's IPv6 address. Defaults to "$address6$".
244 fping_wrta | **Optional.** The RTA warning threshold in milliseconds. Defaults to 100.
245 fping_wpl | **Optional.** The packet loss warning threshold in %. Defaults to 5.
246 fping_crta | **Optional.** The RTA critical threshold in milliseconds. Defaults to 200.
247 fping_cpl | **Optional.** The packet loss critical threshold in %. Defaults to 15.
248 fping_number | **Optional.** The number of packets to send. Defaults to 5.
249 fping_interval | **Optional.** The interval between packets in milli-seconds. Defaults to 500.
250 fping_bytes | **Optional.** The size of ICMP packet.
251 fping_target_timeout | **Optional.** The target timeout in milli-seconds.
252 fping_source_ip | **Optional.** The name or ip address of the source ip.
253 fping_source_interface | **Optional.** The source interface name.
256 ## <a id="plugin-check-command-ftp"></a> ftp
258 Check command object for the `check_ftp` plugin.
263 -------------------|--------------
264 ftp_address | **Optional.** The host's address. Defaults to "$address$" if the host's `address` attribute is set, "$address6$" otherwise.
267 ## <a id="plugin-check-command-hostalive"></a> hostalive
269 Check command object for the `check_ping` plugin with host check default values. This variant
270 uses the host's `address` attribute if available and falls back to using the `address6` attribute
271 if the `address` attribute is not set.
276 ----------------|--------------
277 ping_address | **Optional.** The host's address. Defaults to "$address$" if the host's `address` attribute is set, "$address6$" otherwise.
278 ping_wrta | **Optional.** The RTA warning threshold in milliseconds. Defaults to 3000.
279 ping_wpl | **Optional.** The packet loss warning threshold in %. Defaults to 80.
280 ping_crta | **Optional.** The RTA critical threshold in milliseconds. Defaults to 5000.
281 ping_cpl | **Optional.** The packet loss critical threshold in %. Defaults to 100.
282 ping_packets | **Optional.** The number of packets to send. Defaults to 5.
283 ping_timeout | **Optional.** The plugin timeout in seconds. Defaults to 0 (no timeout).
286 ## <a id="plugin-check-command-hostalive4"></a> hostalive4
288 Check command object for the `check_ping` plugin with host check default values. This variant
289 uses the host's `address` attribute.
294 ----------------|--------------
295 ping_address | **Optional.** The host's IPv4 address. Defaults to "$address$".
296 ping_wrta | **Optional.** The RTA warning threshold in milliseconds. Defaults to 3000.
297 ping_wpl | **Optional.** The packet loss warning threshold in %. Defaults to 80.
298 ping_crta | **Optional.** The RTA critical threshold in milliseconds. Defaults to 5000.
299 ping_cpl | **Optional.** The packet loss critical threshold in %. Defaults to 100.
300 ping_packets | **Optional.** The number of packets to send. Defaults to 5.
301 ping_timeout | **Optional.** The plugin timeout in seconds. Defaults to 0 (no timeout).
304 ## <a id="plugin-check-command-hostalive6"></a> hostalive6
306 Check command object for the `check_ping` plugin with host check default values. This variant
307 uses the host's `address6` attribute.
312 ----------------|--------------
313 ping_address | **Optional.** The host's IPv6 address. Defaults to "$address6$".
314 ping_wrta | **Optional.** The RTA warning threshold in milliseconds. Defaults to 3000.
315 ping_wpl | **Optional.** The packet loss warning threshold in %. Defaults to 80.
316 ping_crta | **Optional.** The RTA critical threshold in milliseconds. Defaults to 5000.
317 ping_cpl | **Optional.** The packet loss critical threshold in %. Defaults to 100.
318 ping_packets | **Optional.** The number of packets to send. Defaults to 5.
319 ping_timeout | **Optional.** The plugin timeout in seconds. Defaults to 0 (no timeout).
322 ## <a id="plugin-check-command-hpjd"></a> hpjd
324 Check command object for the `check_hpjd` plugin.
329 ----------------|--------------
330 hpjd_address | **Optional.** The host's address. Defaults to "$address$" if the host's `address` attribute is set, "$address6$" otherwise.
331 hpjd_port | **Optional.** The host's SNMP port. Defaults to 161.
332 hpjd_community | **Optional.** The SNMP community. Defaults to "public".
335 ## <a id="plugin-check-command-http"></a> http
337 Check command object for the `check_http` plugin.
342 -------------------------|--------------
343 http_address | **Optional.** The host's address. Defaults to "$address$" if the host's `address` attribute is set, "$address6$" otherwise.
344 http_vhost | **Optional.** The virtual host that should be sent in the "Host" header.
345 http_uri | **Optional.** The request URI.
346 http_port | **Optional.** The TCP port. Defaults to 80 when not using SSL, 443 otherwise.
347 http_ssl | **Optional.** Whether to use SSL. Defaults to false.
348 http_sni | **Optional.** Whether to use SNI. Defaults to false.
349 http_auth_pair | **Optional.** Add 'username:password' authorization pair.
350 http_proxy_auth_pair | **Optional.** Add 'username:password' authorization pair for proxy.
351 http_ignore_body | **Optional.** Don't download the body, just the headers.
352 http_linespan | **Optional.** Allow regex to span newline.
353 http_expect_body_regex | **Optional.** A regular expression which the body must match against. Incompatible with http_ignore_body.
354 http_expect_body_eregi | **Optional.** A case-insensitive expression which the body must match against. Incompatible with http_ignore_body.
355 http_invertregex | **Optional.** Changes behaviour of http_expect_body_regex and http_expect_body_eregi to return CRITICAL if found, OK if not.
356 http_warn_time | **Optional.** The warning threshold.
357 http_critical_time | **Optional.** The critical threshold.
358 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.
359 http_certificate | **Optional.** Minimum number of days a certificate has to be valid. Port defaults to 443.
360 http_clientcert | **Optional.** Name of file contains the client certificate (PEM format).
361 http_privatekey | **Optional.** Name of file contains the private key (PEM format).
362 http_headerstring | **Optional.** String to expect in the response headers.
363 http_string | **Optional.** String to expect in the content.
364 http_post | **Optional.** URL encoded http POST data.
365 http_method | **Optional.** Set http method (for example: HEAD, OPTIONS, TRACE, PUT, DELETE).
366 http_maxage | **Optional.** Warn if document is more than seconds old.
367 http_contenttype | **Optional.** Specify Content-Type header when POSTing.
368 http_useragent | **Optional.** String to be sent in http header as User Agent.
369 http_header | **Optional.** Any other tags to be sent in http header.
370 http_extendedperfdata | **Optional.** Print additional perfdata. Defaults to false.
371 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)
372 http_pagesize | **Optional.** Minimum page size required:Maximum page size required.
373 http_timeout | **Optional.** Seconds before connection times out.
376 ## <a id="plugin-check-command-icmp"></a> icmp
378 Check command object for the `check_icmp` plugin.
383 ----------------|--------------
384 icmp_address | **Optional.** The host's address. This can either be a single address or an array of addresses. Defaults to "$address$".
385 icmp_wrta | **Optional.** The RTA warning threshold in milliseconds. Defaults to 100.
386 icmp_wpl | **Optional.** The packet loss warning threshold in %. Defaults to 5.
387 icmp_crta | **Optional.** The RTA critical threshold in milliseconds. Defaults to 200.
388 icmp_cpl | **Optional.** The packet loss critical threshold in %. Defaults to 15.
389 icmp_source | **Optional.** The source IP address to send packets from.
390 icmp_packets | **Optional.** The number of packets to send. Defaults to 5.
391 icmp_packet_interval | **Optional** The maximum packet interval. Defaults to 80 (milliseconds).
392 icmp_target_interval | **Optional.** The maximum target interval.
393 icmp_hosts_alive | **Optional.** The number of hosts which have to be alive for the check to succeed.
394 icmp_data_bytes | **Optional.** Payload size for each ICMP request. Defaults to 8.
395 icmp_timeout | **Optional.** The plugin timeout in seconds. Defaults to 10 (seconds).
398 ## <a id="plugin-check-command-imap"></a> imap
400 Check command object for the `check_imap` plugin.
405 ----------------|--------------
406 imap_address | **Optional.** The host's address. Defaults to "$address$" if the host's `address` attribute is set, "$address6$" otherwise.
407 imap_port | **Optional.** The port that should be checked. Defaults to 143.
410 ## <a id="plugin-check-command-load"></a> load
412 Check command object for the `check_load` plugin.
417 ----------------|--------------
418 load_wload1 | **Optional.** The 1-minute warning threshold. Defaults to 5.
419 load_wload5 | **Optional.** The 5-minute warning threshold. Defaults to 4.
420 load_wload15 | **Optional.** The 15-minute warning threshold. Defaults to 3.
421 load_cload1 | **Optional.** The 1-minute critical threshold. Defaults to 10.
422 load_cload5 | **Optional.** The 5-minute critical threshold. Defaults to 6.
423 load_cload15 | **Optional.** The 15-minute critical threshold. Defaults to 4.
426 ## <a id="plugin-check-command-nrpe"></a> nrpe
428 Check command object for the `check_nrpe` plugin.
433 ----------------|--------------
434 nrpe_address | **Optional.** The host's address. Defaults to "$address$" if the host's `address` attribute is set, "$address6$" otherwise.
435 nrpe_port | **Optional.** The NRPE port. Defaults to 5668.
436 nrpe_command | **Optional.** The command that should be executed.
437 nrpe_no_ssl | **Optional.** Whether to disable SSL or not. Defaults to `false`.
438 nrpe_timeout_unknown | **Optional.** Whether to set timeouts to unknown instead of critical state. Defaults to `false`.
439 nrpe_timeout | **Optional.** The timeout in seconds.
440 nrpe_arguments | **Optional.** Arguments that should be passed to the command. Multiple arguments must be defined as array.
443 ## <a id="plugin-check-command-nscp"></a> nscp
445 Check command object for the `check_nt` plugin.
450 ----------------|--------------
451 nscp_address | **Optional.** The host's address. Defaults to "$address$" if the host's `address` attribute is set, "$address6$" otherwise.
452 nscp_port | **Optional.** The NSClient++ port. Defaults to 12489.
453 nscp_password | **Optional.** The NSClient++ password.
454 nscp_variable | **Required.** The variable that should be checked.
455 nscp_params | **Optional.** Parameters for the query. Multiple parameters must be defined as array.
456 nscp_warn | **Optional.** The warning threshold.
457 nscp_crit | **Optional.** The critical threshold.
458 nscp_timeout | **Optional.** The query timeout in seconds.
461 ## <a id="plugin-check-command-ntp-time"></a> ntp_time
463 Check command object for the `check_ntp_time` plugin.
468 ----------------|--------------
469 ntp_address | **Optional.** The host's address. Defaults to "$address$" if the host's `address` attribute is set, "$address6$" otherwise.
472 ## <a id="plugin-check-command-passive"></a> passive
474 Specialised check command object for passive checks executing the `check_dummy` plugin with appropriate default values.
479 ----------------|--------------
480 dummy_state | **Optional.** The state. Can be one of 0 (ok), 1 (warning), 2 (critical) and 3 (unknown). Defaults to 3.
481 dummy_text | **Optional.** Plugin output. Defaults to "No Passive Check Result Received.".
484 ## <a id="plugin-check-command-ping"></a> ping
486 Check command object for the `check_ping` plugin. This command uses the host's `address` attribute
487 if available and falls back to using the `address6` attribute if the `address` attribute is not set.
493 ----------------|--------------
494 ping_address | **Optional.** The host's address. Defaults to "$address$" if the host's `address` attribute is set, "$address6$" otherwise.
495 ping_wrta | **Optional.** The RTA warning threshold in milliseconds. Defaults to 100.
496 ping_wpl | **Optional.** The packet loss warning threshold in %. Defaults to 5.
497 ping_crta | **Optional.** The RTA critical threshold in milliseconds. Defaults to 200.
498 ping_cpl | **Optional.** The packet loss critical threshold in %. Defaults to 15.
499 ping_packets | **Optional.** The number of packets to send. Defaults to 5.
500 ping_timeout | **Optional.** The plugin timeout in seconds. Defaults to 0 (no timeout).
503 ## <a id="plugin-check-command-ping4"></a> ping4
505 Check command object for the `check_ping` plugin.
510 ----------------|--------------
511 ping_address | **Optional.** The host's IPv4 address. Defaults to "$address$".
512 ping_wrta | **Optional.** The RTA warning threshold in milliseconds. Defaults to 100.
513 ping_wpl | **Optional.** The packet loss warning threshold in %. Defaults to 5.
514 ping_crta | **Optional.** The RTA critical threshold in milliseconds. Defaults to 200.
515 ping_cpl | **Optional.** The packet loss critical threshold in %. Defaults to 15.
516 ping_packets | **Optional.** The number of packets to send. Defaults to 5.
517 ping_timeout | **Optional.** The plugin timeout in seconds. Defaults to 0 (no timeout).
519 ## <a id="plugin-check-command-ping6"></a> ping6
521 Check command object for the `check_ping` plugin.
526 ----------------|--------------
527 ping_address | **Optional.** The host's IPv6 address. Defaults to "$address6$".
528 ping_wrta | **Optional.** The RTA warning threshold in milliseconds. Defaults to 100.
529 ping_wpl | **Optional.** The packet loss warning threshold in %. Defaults to 5.
530 ping_crta | **Optional.** The RTA critical threshold in milliseconds. Defaults to 200.
531 ping_cpl | **Optional.** The packet loss critical threshold in %. Defaults to 15.
532 ping_packets | **Optional.** The number of packets to send. Defaults to 5.
533 ping_timeout | **Optional.** The plugin timeout in seconds. Defaults to 0 (no timeout).
536 ## <a id="plugin-check-command-pop"></a> pop
538 Check command object for the `check_pop` plugin.
543 ----------------|--------------
544 pop_address | **Optional.** The host's address. Defaults to "$address$" if the host's `address` attribute is set, "$address6$" otherwise.
545 pop_port | **Optional.** The port that should be checked. Defaults to 110.
548 ## <a id="plugin-check-command-processes"></a> procs
550 Check command object for the `check_procs` plugin.
555 ---------------------|--------------
556 procs_warning | **Optional.** The process count warning threshold. Defaults to 250.
557 procs_critical | **Optional.** The process count critical threshold. Defaults to 400.
558 procs_metric | **Optional.** Check thresholds against metric.
559 procs_timeout | **Optional.** Seconds before plugin times out.
560 procs_traditional | **Optional.** Filter own process the traditional way by PID instead of /proc/pid/exe. Defaults to false.
561 procs_state | **Optional.** Only scan for processes that have one or more of the status flags you specify.
562 procs_ppid | **Optional.** Only scan for children of the parent process ID indicated.
563 procs_vsz | **Optional.** Only scan for processes with VSZ higher than indicated.
564 procs_rss | **Optional.** Only scan for processes with RSS higher than indicated.
565 procs_pcpu | **Optional.** Only scan for processes with PCPU higher than indicated.
566 procs_user | **Optional.** Only scan for processes with user name or ID indicated.
567 procs_argument | **Optional.** Only scan for processes with args that contain STRING.
568 procs_argument_regex | **Optional.** Only scan for processes with args that contain the regex STRING.
569 procs_command | **Optional.** Only scan for exact matches of COMMAND (without path).
570 procs_nokthreads | **Optional.** Only scan for non kernel threads. Defaults to false.
573 ## <a id="plugin-check-command-running-kernel"></a> running_kernel
575 Check command object for the `check_running_kernel` plugin
576 provided by the `nagios-plugins-contrib` package on Debian.
578 The `running_kernel` check command does not support any vars.
581 ## <a id="plugin-check-command-simap"></a> simap
583 Check command object for the `check_simap` plugin.
588 ----------------|--------------
589 simap_address | **Optional.** The host's address. Defaults to "$address$" if the host's `address` attribute is set, "$address6$" otherwise.
590 simap_port | **Optional.** The host's port.
593 ## <a id="plugin-check-command-smtp"></a> smtp
595 Check command object for the `check_smtp` plugin.
600 ---------------------|--------------
601 smtp_address | **Optional.** The host's address. Defaults to "$address$" if the host's `address` attribute is set, "$address6$" otherwise.
602 smtp_port | **Optional.** The port that should be checked. Defaults to 25.
603 smtp_mail_from | **Optional.** Test a MAIL FROM command with the given email address.
606 ## <a id="plugin-check-command-snmp"></a> snmp
608 Check command object for the `check_snmp` plugin.
613 --------------------|--------------
614 snmp_address | **Optional.** The host's address. Defaults to "$address$" if the host's `address` attribute is set, "$address6$" otherwise.
615 snmp_oid | **Required.** The SNMP OID.
616 snmp_community | **Optional.** The SNMP community. Defaults to "public".
617 snmp_warn | **Optional.** The warning threshold.
618 snmp_crit | **Optional.** The critical threshold.
619 snmp_string | **Optional.** Return OK state if the string matches exactly with the output value
620 snmp_ereg | **Optional.** Return OK state if extended regular expression REGEX matches with the output value
621 snmp_eregi | **Optional.** Return OK state if case-insensitive extended REGEX matches with the output value
622 snmp_label | **Optional.** Prefix label for output value
623 snmp_invert_search | **Optional.** Invert search result and return CRITICAL state if found
624 snmp_units | **Optional.** Units label(s) for output value (e.g., 'sec.').
625 snmp_version | **Optional.** Version to use. E.g. 1, 2, 2c or 3.
626 snmp_miblist | **Optional.** MIB's to use, comma separated. Defaults to "ALL".
627 snmp_rate_multiplier | **Optional.** Converts rate per second. For example, set to 60 to convert to per minute.
628 snmp_rate | **Optional.** Boolean. Enable rate calculation.
629 snmp_getnext | **Optional.** Boolean. Use SNMP GETNEXT. Defaults to false.
630 snmp_timeout | **Optional.** The command timeout in seconds. Defaults to 10 seconds.
632 ## <a id="plugin-check-command-snmpv3"></a> snmpv3
634 Check command object for the `check_snmp` plugin, using SNMPv3 authentication and encryption options.
639 ------------------|--------------
640 snmpv3_address | **Optional.** The host's address. Defaults to "$address$" if the host's `address` attribute is set, "$address6$" otherwise.
641 snmpv3_user | **Required.** The username to log in with.
642 snmpv3_auth_alg | **Optional.** The authentication algorithm. Defaults to SHA.
643 snmpv3_auth_key | **Required.** The authentication key.
644 snmpv3_priv_alg | **Optional.** The encryption algorithm. Defaults to AES.
645 snmpv3_priv_key | **Required.** The encryption key.
646 snmpv3_oid | **Required.** The SNMP OID.
647 snmpv3_warn | **Optional.** The warning threshold.
648 snmpv3_crit | **Optional.** The critical threshold.
649 snmpv3_label | **Optional.** Prefix label for output value.
651 ## <a id="plugin-check-command-snmp-uptime"></a> snmp-uptime
653 Check command object for the `check_snmp` plugin.
658 ----------------|--------------
659 snmp_address | **Optional.** The host's address. Defaults to "$address$" if the host's `address` attribute is set, "$address6$" otherwise.
660 snmp_oid | **Optional.** The SNMP OID. Defaults to "1.3.6.1.2.1.1.3.0".
661 snmp_community | **Optional.** The SNMP community. Defaults to "public".
664 ## <a id="plugin-check-command-spop"></a> spop
666 Check command object for the `check_spop` plugin.
671 ----------------|--------------
672 spop_address | **Optional.** The host's address. Defaults to "$address$" if the host's `address` attribute is set, "$address6$" otherwise.
673 spop_port | **Optional.** The host's port.
676 ## <a id="plugin-check-command-ssh"></a> ssh
678 Check command object for the `check_ssh` plugin.
683 ----------------|--------------
684 ssh_address | **Optional.** The host's address. Defaults to "$address$" if the host's `address` attribute is set, "$address6$" otherwise.
685 ssh_port | **Optional.** The port that should be checked. Defaults to 22.
686 ssh_timeout | **Optional.** Seconds before connection times out. Defaults to 10.
689 ## <a id="plugin-check-command-ssl"></a> ssl
691 Check command object for the `check_tcp` plugin, using ssl-related options.
696 ------------------------------|--------------
697 ssl_address | **Optional.** The host's address. Defaults to "$address$" if the host's `address` attribute is set, "$address6$" otherwise.
698 ssl_port | **Required.** The port that should be checked.
699 ssl_timeout | **Optional.** Timeout in seconds for the connect and handshake. The plugin default is 10 seconds.
700 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.
701 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.
704 ## <a id="plugin-check-command-ssmtp"></a> ssmtp
706 Check command object for the `check_ssmtp` plugin.
711 ----------------|--------------
712 ssmtp_address | **Required.** The host's address. Defaults to "$address$" if the host's `address` attribute is set, "$address6$" otherwise.
713 ssmtp_port | **Optional.** The port that should be checked. Defaults to 465.
716 ## <a id="plugin-check-command-swap"></a> swap
718 Check command object for the `check_swap` plugin.
723 ----------------|--------------
724 swap_wfree | **Optional.** The free swap space warning threshold in %. Defaults to 50.
725 swap_cfree | **Optional.** The free swap space critical threshold in %. Defaults to 25.
728 ## <a id="plugin-check-command-tcp"></a> tcp
730 Check command object for the `check_tcp` plugin.
735 ----------------|--------------
736 tcp_address | **Optional.** The host's address. Defaults to "$address$" if the host's `address` attribute is set, "$address6$" otherwise.
737 tcp_port | **Required.** The port that should be checked.
740 ## <a id="plugin-check-command-udp"></a> udp
742 Check command object for the `check_udp` plugin.
747 ----------------|--------------
748 udp_address | **Optional.** The host's address. Defaults to "$address$" if the host's `address` attribute is set, "$address6$" otherwise.
749 udp_port | **Required.** The port that should be checked.
750 udp_send | **Required.** The payload to send in the UDP datagram.
751 udp_expect | **Required.** The payload to expect in the response datagram.
752 udp_quit | **Optional.** The payload to send to 'close' the session.
755 ## <a id="plugin-check-command-ups"></a> ups
757 Check command object for the `check_ups` plugin.
762 ----------------|--------------
763 ups_address | **Required.** The address of the host running upsd. Defaults to "$address$" if the host's `address` attribute is set, "$address6$" otherwise.
764 ups_name | **Required.** The UPS name. Defaults to `ups`.
765 ups_port | **Optional.** The port to which to connect. Defaults to 3493.
766 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`.
767 ups_warning | **Optional.** The warning threshold for the selected variable.
768 ups_critical | **Optional.** The critical threshold for the selected variable.
769 ups_celsius | **Optional.** Display the temperature in degrees Celsius instead of Fahrenheit. Defaults to `false`.
770 ups_timeout | **Optional.** The number of seconds before the connection times out. Defaults to 10.
773 ## <a id="plugin-check-command-users"></a> users
775 Check command object for the `check_users` plugin.
780 ----------------|--------------
781 users_wgreater | **Optional.** The user count warning threshold. Defaults to 20.
782 users_cgreater | **Optional.** The user count critical threshold. Defaults to 50.
785 # <a id="windows-plugins"></a>Icinga 2 Windows plugins
787 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.
789 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:
791 include <windows-plugins>
793 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.
796 ## <a id"windows-plugins-thresholds"></a>Threshold syntax
798 So not specified differently the thresholds for the plugins all follow the same pattern
801 :------------|:----------
802 "29" | The threshold is 29.
803 "!29" | The threshold is 29, but the negative of the result is returned.
804 "[10-40]" | The threshold is a range from (including) 20 to 40, a value inside means the threshold has been exceeded.
805 "![10-40]" | Same as above, but the result is inverted.
808 ## <a id="windows-plugins-disk-windows"></a>disk-windows
810 Check command object for the `check_disk.exe` plugin.
811 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.).
816 :---------------|:------------
817 disk\_win\_warn | **Optional**. The warning threshold.
818 disk\_win\_crit | **Optional**. The critical threshold.
819 disk\_win\_path | **Optional**. Check only these paths, default checks all.
820 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.
823 ## <a id="windows-plugins-load-windows"></a>load-windows
825 Check command object for the `check_load.exe` plugin.
826 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).
831 :---------------|:------------
832 load\_win\_warn | **Optional**. The warning threshold.
833 load\_win\_crit | **Optional**. The critical threshold.
836 ## <a id="windows-plugins-memory-windows"></a>memory-windows
838 Check command object for the `check_memory.exe` plugin.
839 The memory collection is instant.
844 :-----------------|:------------
845 memory\_win\_warn | **Optional**. The warning threshold.
846 memory\_win\_crit | **Optional**. The critical threshold.
847 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.
850 ## <a id="windows-plugins-network-windows"></a>network-windows
852 Check command object for the `check_network.exe` plugin.
853 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).
858 :------------------|:------------
859 network\_win\_warn | **Optional**. The warning threshold.
860 network\_win\_crit | **Optional**. The critical threshold.
863 ## <a id="windows-plugins-permon-windows"></a>perfmon-windows
865 Check command object for the `check_perfmon.exe` plugin.
866 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`.
868 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"`
873 :---------------------|:------------
874 perfmon\_win\_warn | **Optional**. The warning threshold.
875 perfmon\_win\_crit | **Optional**. The critical threshold.
876 perfmon\_win\_counter | **Required**. The Performance Counter to use. Ex. `\Processor(_Total)\% Idle Time`.
877 perfmon\_win\_wait | **Optional**. Time in milliseconds to wait between data collection (default: 1000).
878 perfmon\_win\_type | **Optional**. Format in which to expect perfomance values. Possible are: long, int64 and double (default).
881 ## <a id="windows-plugins-ping-windows"></a>ping-windows
883 Check command object for the `check_ping.exe` plugin.
884 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.
889 :------------------|:------------
890 ping\_win\_warn | **Optional**. The warning threshold. RTA and package loss seperated by comma.
891 ping\_win\_crit | **Optional**. The critical threshold. RTA and package loss seperated by comma.
892 ping\_win\_address | **Required**. An IPv4 or IPv6 address
893 ping\_win\_packets | **Optional**. Number of packages to send. Default: 5.
894 ping\_win\_timeout | **Optional**. The timeout in milliseconds. Default: 1000
897 ## <a id="windows-plugins-procs-windows"></a>procs-windows
899 Check command object for `check_procs.exe` plugin.
900 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.
905 :----------------|:------------
906 procs\_win\_warn | **Optional**. The warning threshold.
907 procs\_win\_crit | **Optional**. The critical threshold.
908 procs\_win\_user | **Optional**. Count this useres processes.
911 ## <a id="windows-plugins-service-windows"></a>service-windows
913 Check command object for `check_service.exe` plugin.
914 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.
919 :---------------------|:------------
920 service\_win\_warn | **Optional**. Warn when service is not running.
921 service\_win\_service | **Required**. The critical threshold.
924 ## <a id="windows-plugins-swap-windows"></a>swap-windows
926 Check command object for `check_swap.exe` plugin.
927 The data collection is instant.
932 :---------------|:------------
933 swap\_win\_warn | **Optional**. The warning threshold.
934 swap\_win\_crit | **Optional**. The critical threshold.
935 swap\_win\_unit | **Optional**. The unit to display the received value in, thresholds are interpreted in this unit. Defaults to "mb" (megabyte).
938 ## <a id="windows-plugins-update-windows"></a>update-windows
940 Check command object for `check_update.exe` plugin.
941 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.
946 :-------------------|:------------
947 update\_win\_warn | If set returns warning when important updates are available
948 update\_win\_crit | If set return critical when important updates that require a reboot are available.
949 update\_win\_reboot | Set to treat 'may need update' as 'definitely needs update'
952 ## <a id="windows-plugins-uptime-windows"></a>uptime-windows
954 Check command opject for `check_uptime.exe` plugin.
955 Uses GetTickCount64 to get the uptime, so boot time is not included.
960 :-----------------|:------------
961 uptime\_win\_warn | **Optional**. The warning threshold.
962 uptime\_win\_crit | **Optional**. The critical threshold.
963 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).
966 ## <a id="windows-plugins-users-windows"></a>users-windows
968 Check command object for `check_users.exe` plugin.
973 :----------------|:------------
974 users\_win\_warn | **Optional**. The warning threshold.
975 users\_win\_crit | **Optional**. The critical threshold.
978 # <a id="nscp-plugin-check-commands"></a> NSClient++ Check Commands
980 Icinga 2 can use the `nscp client` command to run arbitrary NSClient++ checks.
982 You can enable these check commands by adding the following the include directive in your
983 [icinga2.conf](5-configuring-icinga-2.md#icinga2-conf) configuration file:
987 You can also optionally specify an alternative installation directory for NSClient++ by adding
988 the NscpPath constant in your [constants.conf](5-configuring-icinga-2.md#constants-conf) configuration
991 const NscpPath = "C:\\Program Files (x86)\\NSClient++"
993 By default the check commands assume that NSClient++ is installed in "C:\Program Files\NSClient++".
995 Note that it is not necessary to run NSClient++ as a Windows service for these commands to work.
997 ## <a id="nscp-check-local"></a> nscp-local
999 Check command object for NSClient++
1004 ----------------|--------------
1005 nscp_path | **Optional.** Can be used to override the NSClient++ on a per-command basis. Defaults to NscpPath.
1006 nscp_boot | **Optional.** Whether to use the --boot option. Defaults to true.
1007 nscp_query | **Required.** The NSClient++ query. Try `nscp client -q x` for a list.
1008 nscp_arguments | **Optional.** An array of query arguments.
1010 ## <a id="nscp-check-local-cpu"></a> nscp-local-cpu
1012 Check command object for the `check_cpu` NSClient++ plugin.
1014 This command has the same custom attributes like the `nscp-local` check command.
1016 ## <a id="nscp-check-local-memory"></a> nscp-local-memory
1018 Check command object for the `check_memory` NSClient++ plugin.
1020 This command has the same custom attributes like the `nscp-local` check command.
1022 ## <a id="nscp-check-local-os-version"></a> nscp-local-os-version
1024 Check command object for the `check_os_version` NSClient++ plugin.
1026 This command has the same custom attributes like the `nscp-local` check command.
1028 ## <a id="nscp-check-local-pagefile"></a> nscp-local-pagefile
1030 Check command object for the `check_pagefile` NSClient++ plugin.
1032 This command has the same custom attributes like the `nscp-local` check command.
1034 ## <a id="nscp-check-local-process"></a> nscp-local-process
1036 Check command object for the `check_process` NSClient++ plugin.
1038 This command has the same custom attributes like the `nscp-local` check command.
1040 ## <a id="nscp-check-local-service"></a> nscp-local-service
1042 Check command object for the `check_service` NSClient++ plugin.
1044 This command has the same custom attributes like the `nscp-local` check command.
1046 ## <a id="nscp-check-local-uptime"></a> nscp-local-uptime
1048 Check command object for the `check_uptime` NSClient++ plugin.
1050 This command has the same custom attributes like the `nscp-local` check command.
1052 ## <a id="nscp-check-local-version"></a> nscp-local-version
1054 Check command object for the `check_version` NSClient++ plugin.
1056 This command has the same custom attributes like the `nscp-local` check command.
1058 # <a id="snmp-manubulon-plugin-check-commands"></a> SNMP Manubulon Plugin Check Commands
1060 The `SNMP Manubulon Plugin Check Commands` provide example configuration for plugin check
1061 commands provided by the [SNMP Manubulon project](http://nagios.manubulon.com/index_snmp.html).
1063 The SNMP manubulon plugin check commands assume that the global constant named `ManubulonPluginDir`
1064 is set to the path where the Manubublon SNMP plugins are installed.
1066 You can enable these plugin check commands by adding the following the include directive in your
1067 [icinga2.conf](5-configuring-icinga-2.md#icinga2-conf) configuration file:
1071 ## Checks by Host Type
1073 **N/A** : Not available for this type.
1075 **SNMP** : Available for simple SNMP query.
1079 **Specific** : Script name for platform specific checks.
1082 Host type | Interface | storage | load/cpu | mem | process | env | specific
1083 ------------------------|------------|----------|-----------|-----|----------|-----|-------------------------
1084 Linux | Yes | Yes | Yes | Yes | Yes | No |
1085 Windows | Yes | Yes | Yes | Yes | Yes | No | check_snmp_win.pl
1086 Cisco router/switch | Yes | N/A | Yes | Yes | N/A | Yes |
1087 HP router/switch | Yes | N/A | Yes | Yes | N/A | No |
1088 Bluecoat proxy | Yes | SNMP | Yes | SNMP| No | Yes |
1089 CheckPoint on SPLAT | Yes | Yes | Yes | Yes | Yes | No | check_snmp_cpfw.pl
1090 CheckPoint on Nokia IP | Yes | Yes | Yes | No | ?? | No | check_snmp_vrrp.pl
1091 Boostedge | Yes | Yes | Yes | Yes | ?? | No | check_snmp_boostedge.pl
1092 AS400 | Yes | Yes | Yes | Yes | No | No |
1093 NetsecureOne Netbox | Yes | Yes | Yes | ?? | Yes | No |
1094 Radware Linkproof | Yes | N/A | SNMP | SNMP| No | No | check_snmp_linkproof_nhr <br> check_snmp_vrrp.pl
1095 IronPort | Yes | SNMP | SNMP | SNMP| No | Yes |
1096 Cisco CSS | Yes | ?? | Yes | Yes | No | ?? | check_snmp_css.pl
1099 ## <a id="plugin-check-command-snmp-load"></a> snmp-load
1101 Check command object for the [check_snmp_load.pl](http://nagios.manubulon.com/snmp_load.html) plugin.
1107 ------------------------|--------------
1108 snmp_address | **Optional.** The host's address. Defaults to "$address$" if the host's `address` attribute is set, "$address6$" otherwise.
1109 snmp_nocrypt | **Optional.** Define SNMP encryption. If set **snmp_v3** needs to be set. Defaults to false.
1110 snmp_community | **Optional.** The SNMP community. Defaults to "public".
1111 snmp_port | **Optional.** The SNMP port connection.
1112 snmp_v2 | **Optional.** SNMP version to 2c. Defaults to false.
1113 snmp_v3 | **Optional.** SNMP version to 3. Defaults to false.
1114 snmp_login | **Optional.** SNMP version 3 username. Defaults to "snmpuser".
1115 snmp_password | **Required.** SNMP version 3 password. No value defined as default.
1116 snmp_v3_use_privpass | **Optional.** Define to use SNMP version 3 priv password. Defaults to false.
1117 snmp_authprotocol | **Optional.** SNMP version 3 authentication protocol. Defaults to "md5,des".
1118 snmp_privpass | **Required.** SNMP version 3 priv password. No value defined as default.
1119 snmp_warn | **Optional.** The warning threshold. Change the `snmp_load_type` var to "netsl" for using 3 values.
1120 snmp_crit | **Optional.** The critical threshold. Change the `snmp_load_type` var to "netsl" for using 3 values.
1121 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.
1122 snmp_perf | **Optional.** Enable perfdata values. Defaults to true.
1123 snmp_timeout | **Optional.** The command timeout in seconds. Defaults to 5 seconds.
1125 ## <a id="plugin-check-command-snmp-memory"></a> snmp-memory
1127 Check command object for the [check_snmp_mem.pl](http://nagios.manubulon.com/snmp_mem.html) plugin.
1132 ------------------------|--------------
1133 snmp_address | **Optional.** The host's address. Defaults to "$address$" if the host's `address` attribute is set, "$address6$" otherwise.
1134 snmp_nocrypt | **Optional.** Define SNMP encryption. If set **snmp_v3** needs to be set. Defaults to false.
1135 snmp_community | **Optional.** The SNMP community. Defaults to "public".
1136 snmp_port | **Optional.** The SNMP port connection.
1137 snmp_v2 | **Optional.** SNMP version to 2c. Defaults to false.
1138 snmp_v3 | **Optional.** SNMP version to 3. Defaults to false.
1139 snmp_login | **Optional.** SNMP version 3 username. Defaults to "snmpuser".
1140 snmp_password | **Required.** SNMP version 3 password. No value defined as default.
1141 snmp_v3_use_privpass | **Optional.** Define to use SNMP version 3 priv password. Defaults to false.
1142 snmp_authprotocol | **Optional.** SNMP version 3 authentication protocol. Defaults to "md5,des".
1143 snmp_privpass | **Required.** SNMP version 3 priv password. No value defined as default.
1144 snmp_warn | **Optional.** The warning threshold.
1145 snmp_crit | **Optional.** The critical threshold.
1146 snmp_perf | **Optional.** Enable perfdata values. Defaults to true.
1147 snmp_timeout | **Optional.** The command timeout in seconds. Defaults to 5 seconds.
1149 ## <a id="plugin-check-command-snmp-storage"></a> snmp-storage
1151 Check command object for the [check_snmp_storage.pl](http://nagios.manubulon.com/snmp_storage.html) plugin.
1156 ------------------------|--------------
1157 snmp_address | **Optional.** The host's address. Defaults to "$address$" if the host's `address` attribute is set, "$address6$" otherwise.
1158 snmp_nocrypt | **Optional.** Define SNMP encryption. If set **snmp_v3** needs to be set. Defaults to false.
1159 snmp_community | **Optional.** The SNMP community. Defaults to "public".
1160 snmp_port | **Optional.** The SNMP port connection.
1161 snmp_v2 | **Optional.** SNMP version to 2c. Defaults to false.
1162 snmp_v3 | **Optional.** SNMP version to 3. Defaults to false.
1163 snmp_login | **Optional.** SNMP version 3 username. Defaults to "snmpuser".
1164 snmp_password | **Required.** SNMP version 3 password. No value defined as default.
1165 snmp_v3_use_privpass | **Optional.** Define to use SNMP version 3 priv password. Defaults to false.
1166 snmp_authprotocol | **Optional.** SNMP version 3 authentication protocol. Defaults to "md5,des".
1167 snmp_privpass | **Required.** SNMP version 3 priv password. No value defined as default.
1168 snmp_warn | **Optional.** The warning threshold.
1169 snmp_crit | **Optional.** The critical threshold.
1170 snmp_storage_name | **Optional.** Storage name. Default to regex "^/$$". More options available in the [snmp storage](http://nagios.manubulon.com/snmp_storage.html) documentation.
1171 snmp_perf | **Optional.** Enable perfdata values. Defaults to true.
1172 snmp_timeout | **Optional.** The command timeout in seconds. Defaults to 5 seconds.
1174 ## <a id="plugin-check-command-snmp-interface"></a> snmp-interface
1176 Check command object for the [check_snmp_int.pl](http://nagios.manubulon.com/snmp_int.html) plugin.
1181 ----------------------------|--------------
1182 snmp_address | **Optional.** The host's address. Defaults to "$address$" if the host's `address` attribute is set, "$address6$" otherwise.
1183 snmp_nocrypt | **Optional.** Define SNMP encryption. If set **snmp_v3** needs to be set. Defaults to false.
1184 snmp_community | **Optional.** The SNMP community. Defaults to "public".
1185 snmp_port | **Optional.** The SNMP port connection.
1186 snmp_v2 | **Optional.** SNMP version to 2c. Defaults to false.
1187 snmp_v3 | **Optional.** SNMP version to 3. Defaults to false.
1188 snmp_login | **Optional.** SNMP version 3 username. Defaults to "snmpuser".
1189 snmp_password | **Required.** SNMP version 3 password. No value defined as default.
1190 snmp_v3_use_privpass | **Optional.** Define to use SNMP version 3 priv password. Defaults to false.
1191 snmp_authprotocol | **Optional.** SNMP version 3 authentication protocol. Defaults to "md5,des".
1192 snmp_privpass | **Required.** SNMP version 3 priv password. No value defined as default.
1193 snmp_warn | **Optional.** The warning threshold.
1194 snmp_crit | **Optional.** The critical threshold.
1195 snmp_interface | **Optional.** Network interface name. Default to regex "eth0".
1196 snmp_interface_perf | **Optional.** Check the input/ouput bandwidth of the interface. Defaults to true.
1197 snmp_interface_label | **Optional.** Add label before speed in output: in=, out=, errors-out=, etc...
1198 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.
1199 snmp_interface_percent | **Optional.** Output performance data in % of max speed. Defaults to false.
1200 snmp_interface_kbits | **Optional.** Make the warning and critical levels in KBits/s. Defaults to true.
1201 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.
1202 snmp_interface_64bit | **Optional.** Use 64 bits counters instead of the standard counters when checking bandwidth & performance data for interface >= 1Gbps. Defaults to false.
1203 snmp_interface_errors | **Optional.** Add error & discard to Perfparse output. Defaults to true.
1204 snmp_interface_noregexp | **Optional.** Do not use regexp to match interface name in description OID. Defaults to false.
1205 snmp_interface_delta | **Optional.** Delta time of perfcheck. Defaults to "300" (5 min).
1206 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.
1207 snmp_perf | **Optional.** Enable perfdata values. Defaults to true.
1208 snmp_timeout | **Optional.** The command timeout in seconds. Defaults to 5 seconds.
1210 ## <a id="plugin-check-command-snmp-process"></a> snmp-process
1212 Check command object for the [check_snmp_process.pl](http://nagios.manubulon.com/snmp_process.html) plugin.
1217 ------------------------|--------------
1218 snmp_address | **Optional.** The host's address. Defaults to "$address$" if the host's `address` attribute is set, "$address6$" otherwise.
1219 snmp_nocrypt | **Optional.** Define SNMP encryption. If set **snmp_v3** needs to be set. Defaults to false.
1220 snmp_community | **Optional.** The SNMP community. Defaults to "public".
1221 snmp_port | **Optional.** The SNMP port connection.
1222 snmp_v2 | **Optional.** SNMP version to 2c. Defaults to false.
1223 snmp_v3 | **Optional.** SNMP version to 3. Defaults to false.
1224 snmp_login | **Optional.** SNMP version 3 username. Defaults to "snmpuser".
1225 snmp_password | **Required.** SNMP version 3 password. No value defined as default.
1226 snmp_v3_use_privpass | **Optional.** Define to use SNMP version 3 priv password. Defaults to false.
1227 snmp_authprotocol | **Optional.** SNMP version 3 authentication protocol. Defaults to "md5,des".
1228 snmp_privpass | **Required.** SNMP version 3 priv password. No value defined as default..
1229 snmp_warn | **Optional.** The warning threshold.
1230 snmp_crit | **Optional.** The critical threshold.
1231 snmp_process_name | **Optional.** Name of the process (regexp). No trailing slash!. Defaults to ".*".
1232 snmp_perf | **Optional.** Enable perfdata values. Defaults to true.
1233 snmp_timeout | **Optional.** The command timeout in seconds. Defaults to 5 seconds.
1235 # <a id="plugins-contrib"></a> Plugins Contrib
1237 The Plugins contrib collects various contributed command definitions.
1239 These check commands assume that the global constant named `PluginContribDir`
1240 is set to the path where the user installs custom plugins and can be enabled by uncommenting the corresponding line in icinga2.conf.
1242 ## <a id="plugins-contrib-ipmi"></a> IPMI Devices
1244 This category includes all plugins for IPMI devices.
1246 ### <a id="plugins-contrib-command-ipmi-sensor"></a> ipmi-sensor
1248 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.
1253 ---------------------------------|-----------------------------------------------------------------------------------------------------
1254 ipmi_address | **Required.** Specifies the remote host (IPMI device) to check. Defaults to "$address$".
1255 ipmi_config_file | **Optional.** Path to the FreeIPMI configuration file. It should contain IPMI username, IPMI password, and IPMI privilege-level.
1256 ipmi_username | **Optional.** The IPMI username.
1257 ipmi_password | **Optional.** The IPMI password.
1258 ipmi_privilege_level | **Optional.** The IPMI privilege level of the IPMI user.
1259 ipmi_backward_compatibility_mode | **Optional.** Enable backward compatibility mode, useful for FreeIPMI 0.5.* (this omits FreeIPMI options "--quiet-cache" and "--sdr-cache-recreate").
1260 ipmi_sensor_type | **Optional.** Limit sensors to query based on IPMI sensor type. Examples for IPMI sensor types are 'Fan', 'Temperature' and 'Voltage'.
1261 ipmi_exclude_sensor_id | **Optional.** Exclude sensor matching ipmi_sensor_id.
1262 ipmi_sensor_id | **Optional.** Include sensor matching ipmi_sensor_id.
1263 ipmi_protocal_lan_version | **Optional.** Change the protocol LAN version. Defaults to "LAN_2_0".
1264 ipmi_number_of_active_fans | **Optional.** Number of fans that should be active. Otherwise a WARNING state is returned.
1265 ipmi_show_fru | **Optional.** Print the product serial number if it is available in the IPMI FRU data.
1266 ipmi_no_sel_checking | **Optional.** Turn off system event log checking via ipmi-sel.
1268 ## <a id="plugins-contrib-network-components"></a> Network Components
1270 This category includes all plugins for various network components like routers, switches and firewalls.
1272 ### <a id="plugins-contrib-command-interfacetable"></a> interfacetable
1274 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).
1279 ------------------------------------|-----------------------------------------------------------------------------------------------------
1280 interfacetable_hostquery | **Required.** Specifies the remote host to poll. Defaults to "$address$".
1281 interfacetable_hostdisplay | **Optional.** Specifies the hostname to display in the HTML link. Defaults to "$host.display_name$".
1282 interfacetable_regex | **Optional.** Interface names and property names for some other options will be interpreted as regular expressions. Defaults to false.
1283 interfacetable_outputshort | **Optional.** Reduce the verbosity of the plugin output. Defaults to false.
1284 interfacetable_exclude | **Optional.** Comma separated list of interfaces globally excluded from the monitoring.
1285 interfacetable_include | **Optional.** Comma separated list of interfaces globally included in the monitoring.
1286 interfacetable_aliasmatching | **Optional.** Allow you to specify alias in addition to interface names. Defaults to false.
1287 interfacetable_excludetraffic | **Optional.** Comma separated list of interfaces excluded from traffic checks.
1288 interfacetable_includetraffic | **Optional.** Comma separated list of interfaces included for traffic checks.
1289 interfacetable_warningtraffic | **Optional.** Interface traffic load percentage leading to a warning alert.
1290 interfacetable_criticaltraffic | **Optional.** Interface traffic load percentage leading to a critical alert.
1291 interfacetable_pkt | **Optional.** Add unicast/non-unicast pkt stats for each interface.
1292 interfacetable_trackproperty | **Optional.** List of tracked properties.
1293 interfacetable_excludeproperty | **Optional.** Comma separated list of interfaces excluded from the property tracking.
1294 interfacetable_includeproperty | **Optional.** Comma separated list of interfaces included in the property tracking.
1295 interfacetable_community | **Optional.** Specifies the snmp v1/v2c community string. Defaults to "public" if using snmp v1/v2c, ignored using v3.
1296 interfacetable_snmpv2 | **Optional.** Use snmp v2c. Defaults to false.
1297 interfacetable_login | **Optional.** Login for snmpv3 authentication.
1298 interfacetable_passwd | **Optional.** Auth password for snmpv3 authentication.
1299 interfacetable_privpass | **Optional.** Priv password for snmpv3 authentication.
1300 interfacetable_protocols | **Optional.** Authentication protocol,Priv protocol for snmpv3 authentication.
1301 interfacetable_domain | **Optional.** SNMP transport domain.
1302 interfacetable_contextname | **Optional.** Context name for the snmp requests.
1303 interfacetable_port | **Optional.** SNMP port. Defaults to standard port.
1304 interfacetable_64bits | **Optional.** Use SNMP 64-bits counters. Defaults to false.
1305 interfacetable_maxrepetitions | **Optional.** Increasing this value may enhance snmp query performances by gathering more results at one time.
1306 interfacetable_snmptimeout | **Optional.** Define the Transport Layer timeout for the snmp queries.
1307 interfacetable_snmpretries | **Optional.** Define the number of times to retry sending a SNMP message.
1308 interfacetable_unixsnmp | **Optional.** Use unix snmp utilities for snmp requests. Defaults to false, which means use the perl bindings.
1309 interfacetable_enableperfdata | **Optional.** Enable port performance data. Defaults to false.
1310 interfacetable_perfdataformat | **Optional.** Define which performance data will be generated. Possible values are "full" (default), "loadonly", "globalonly".
1311 interfacetable_perfdatathreshold | **Optional.** Define which thresholds are printed in the generated performance data. Possible values are "full" (default), "loadonly", "globalonly".
1312 interfacetable_perfdatadir | **Optional.** When specified, the performance data are also written directly to a file, in the specified location.
1313 interfacetable_perfdataservicedesc | **Optional.** Specify additional parameters for output performance data to PNP. Defaults to "$service.name$", only affects **interfacetable_perfdatadir**.
1314 interfacetable_grapher | **Optional.** Specify the used graphing solution. Possible values are "pnp4nagios" (default), "nagiosgrapher", "netwaysgrapherv2" and "ingraph".
1315 interfacetable_grapherurl | **Optional.** Graphing system url. Default depends on **interfacetable_grapher**.
1316 interfacetable_portperfunit | **Optional.** Traffic could be reported in bits (counters) or in bps (calculated value).
1317 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".
1318 interfacetable_duplex | **Optional.** Add the duplex mode property for each interface in the interface table. Defaults to false.
1319 interfacetable_stp | **Optional.** Add the stp state property for each interface in the interface table. Defaults to false.
1320 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"
1321 interfacetable_noipinfo | **Optional.** Remove the ip information for each interface from the interface table. Defaults to false.
1322 interfacetable_alias | **Optional.** Add the alias information for each interface in the interface table. Defaults to false.
1323 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.
1324 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.
1325 interfacetable_delta | **Optional.** Set the delta used for interface throuput calculation in seconds.
1326 interfacetable_ifs | **Optional.** Input field separator. Defaults to ",".
1327 interfacetable_cache | **Optional.** Define the retention time of the cached data in seconds.
1328 interfacetable_noifloadgradient | **Optional.** Disable color gradient from green over yellow to red for the load percentage. Defaults to false.
1329 interfacetable_nohuman | **Optional.** Do not translate bandwidth usage in human readable format. Defaults to false.
1330 interfacetable_snapshot | **Optional.** Force the plugin to run like if it was the first launch. Defaults to false.
1331 interfacetable_timeout | **Optional.** Define the global timeout limit of the plugin in seconds. Defaults to "15s".
1332 interfacetable_css | **Optional.** Define the css stylesheet used by the generated html files. Possible values are "classic", "icinga", "icinga-alternate1" or "nagiosxi".
1333 interfacetable_config | **Optional.** Specify a config file to load.
1334 interfacetable_noconfigtable | **Optional.** Disable configuration table on the generated HTML page. Defaults to false.
1335 interfacetable_notips | **Optional.** Disable the tips in the generated html tables. Defaults to false.
1336 interfacetable_defaulttablesorting | **Optional.** Default table sorting can be "index" (default) or "name".
1337 interfacetable_tablesplit | **Optional.** Generate multiple interface tables, one per interface type. Defaults to false.
1338 interfacetable_notype | **Optional.** Remove the interface type for each interface. Defaults to false.
1340 ## <a id="plugins-contrib-web"></a> Web
1342 This category includes all plugins for web-based checks.
1344 ## <a id="plugin-check-command-webinject"></a> webinject
1346 Check command object for the [check_webinject](http://http://www.webinject.org/manual.html) plugin.
1351 ------------------------|--------------
1352 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.
1353 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.
1354 webinject_no_output | **Optional.** Suppresses all output to STDOUT except the results summary.
1355 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.
1356 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.
1357 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.
1359 ## <a id="plugins-contrib-operating-system"></a> Operating System
1361 In this category you can find plugins for gathering information about your operating system or the system beneath like memory usage.
1363 ### <a id="plugins-contrib-command-mem"></a> mem
1365 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).
1370 -------------|-----------------------------------------------------------------------------------------------------------------------
1371 mem_used | **Optional.** Tell the plugin to check for used memory in opposite of **mem_free**. Must specify one of these as true.
1372 mem_free | **Optional.** Tell the plugin to check for free memory in opposite of **mem_used**. Must specify one of these as true.
1373 mem_cache | **Optional.** If set to true plugin will count cache as free memory. Defaults to false.
1374 mem_warning | **Required.** Specifiy the warning threshold as number interpreted as percent.
1375 mem_critical | **Required.** Specifiy the critical threshold as number interpreted as percent.
1377 ## <a id="plugins-contrib-virtualization"></a> Virtualization
1379 This category includes all plugins for various virtualization technologies.
1381 ### <a id="plugins-contrib-command-esxi-hardware"></a> esxi_hardware
1383 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.
1388 ------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
1389 esxi_hardware_host | **Required.** Specifies the host to monitor. Defaults to "$address$".
1390 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.
1391 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.
1392 esxi_hardware_vendor | **Optional.** Defines the vendor of the server: "auto", "dell", "hp", "ibm", "intel", "unknown" (default).
1393 esxi_hardware_html | **Optional.** Add web-links to hardware manuals for Dell servers (use your country extension). Only useful with **esxi_hardware_vendor** = dell.
1394 esxi_hardware_ignore | **Optional.** Comma separated list of elements to ignore.
1395 esxi_hardware_perfdata | **Optional.** Add performcedata for graphers like PNP4Nagios to the output. Defaults to false.
1396 esxi_hardware_nopower | **Optional.** Do not collect power performance data, when **esxi_hardware_perfdata** is set to true. Defaults to false.
1397 esxi_hardware_novolts | **Optional.** Do not collect voltage performance data, when **esxi_hardware_perfdata** is set to true. Defaults to false.
1398 esxi_hardware_nocurrent | **Optional.** Do not collect current performance data, when **esxi_hardware_perfdata** is set to true. Defaults to false.
1399 esxi_hardware_notemp | **Optional.** Do not collect temperature performance data, when **esxi_hardware_perfdata** is set to true. Defaults to false.
1400 esxi_hardware_nofan | **Optional.** Do not collect fan performance data, when **esxi_hardware_perfdata** is set to true. Defaults to false.
1402 # <a id="plugins-contrib-vmware"></a> VMware
1404 Check commands for the [check_vmware_esx](https://github.com/BaldMansMojo/check_vmware_esx) plugin.
1406 ## <a id="plugins-contrib-vmware-esx-dc-volumes"></a> vmware-esx-dc-volumes
1408 Check command object for the `check_vmware_esx` plugin. Shows all datastore volumes info.
1413 ------------------------|--------------
1414 vmware_datacenter | **Required.** Datacenter/vCenter hostname.
1415 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
1416 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".
1417 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".
1418 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
1419 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
1420 vmware_sessionfile | **Optional.** Session file name enhancement.
1421 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
1422 vmware_nosession | **Optional.** No auth session - IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
1423 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
1424 vmware_password | **Optional.** The username's password. No value defined as default.
1425 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
1426 vmware_subselect | **Optional.** Volume name to be checked the free space.
1427 vmware_gigabyte | **Optional.** Output in GB instead of MB.
1428 vmware_usedspace | **Optional.** Output used space instead of free. Defaults to "false".
1429 vmware_alertonly | **Optional.** List only alerting volumes. Defaults to "false".
1430 vmware_exclude | **Optional.** Blacklist volumes name. No value defined as default.
1431 vmware_include | **Optional.** Whitelist volumes name. No value defined as default.
1432 vmware_isregexp | **Optional.** Treat blacklist and whitelist expressions as regexp.
1433 vmware_dc_volume_used | **Optional.** Output used space instead of free. Defaults to "true".
1434 vmware_warn | **Optional.** The warning threshold for volumes. Defaults to "80%".
1435 vmware_crit | **Optional.** The critical threshold for volumes. Defaults to "90%".
1438 ## <a id="plugins-contrib-vmware-esx-dc-runtime-info"></a> vmware-esx-dc-runtime-info
1440 Check command object for the `check_vmware_esx` plugin. Shows all runtime info for the datacenter/Vcenter.
1445 ------------------------|--------------
1446 vmware_datacenter | **Required.** Datacenter/vCenter hostname.
1447 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
1448 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".
1449 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".
1450 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
1451 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
1452 vmware_sessionfile | **Optional.** Session file name enhancement.
1453 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
1454 vmware_nosession | **Optional.** No auth session - IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
1455 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
1456 vmware_password | **Optional.** The username's password. No value defined as default.
1457 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
1460 ## <a id="plugins-contrib-vmware-esx-dc-runtime-listvms"></a> vmware-esx-dc-runtime-listvms
1462 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.
1467 ------------------------|--------------
1468 vmware_datacenter | **Required.** Datacenter/vCenter hostname.
1469 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
1470 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".
1471 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".
1472 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
1473 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
1474 vmware_sessionfile | **Optional.** Session file name enhancement.
1475 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
1476 vmware_nosession | **Optional.** No auth session - IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
1477 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
1478 vmware_password | **Optional.** The username's password. No value defined as default.
1479 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
1480 vmware_alertonly | **Optional.** List only alerting VMs. Important here to avoid masses of data.
1481 vmware_exclude | **Optional.** Blacklist VMs name. No value defined as default.
1482 vmware_include | **Optional.** Whitelist VMs name. No value defined as default.
1483 vmware_isregexp | **Optional.** Treat blacklist and whitelist expressions as regexp.
1484 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.
1487 ## <a id="plugins-contrib-vmware-esx-dc-runtime-listhost"></a> vmware-esx-dc-runtime-listhost
1489 Check command object for the `check_vmware_esx` plugin. List of VMware ESX hosts and their power state.
1494 ------------------------|--------------
1495 vmware_datacenter | **Required.** Datacenter/vCenter hostname.
1496 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
1497 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".
1498 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".
1499 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
1500 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
1501 vmware_sessionfile | **Optional.** Session file name enhancement.
1502 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
1503 vmware_nosession | **Optional.** No auth session - IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
1504 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
1505 vmware_password | **Optional.** The username's password. No value defined as default.
1506 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
1507 vmware_alertonly | **Optional.** List only alerting hosts. Important here to avoid masses of data.
1508 vmware_exclude | **Optional.** Blacklist VMware ESX hosts. No value defined as default.
1509 vmware_include | **Optional.** Whitelist VMware ESX hosts. No value defined as default.
1510 vmware_isregexp | **Optional.** Treat blacklist and whitelist expressions as regexp.
1511 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.
1514 ## <a id="plugins-contrib-vmware-esx-dc-runtime-listcluster"></a> vmware-esx-dc-runtime-listcluster
1516 Check command object for the `check_vmware_esx` plugin. List of VMware clusters and their states.
1521 ------------------------|--------------
1522 vmware_datacenter | **Required.** Datacenter/vCenter hostname.
1523 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
1524 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".
1525 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".
1526 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
1527 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
1528 vmware_sessionfile | **Optional.** Session file name enhancement.
1529 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
1530 vmware_nosession | **Optional.** No auth session - IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
1531 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
1532 vmware_password | **Optional.** The username's password. No value defined as default.
1533 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
1534 vmware_alertonly | **Optional.** List only alerting hosts. Important here to avoid masses of data.
1535 vmware_exclude | **Optional.** Blacklist VMware cluster. No value defined as default.
1536 vmware_include | **Optional.** Whitelist VMware cluster. No value defined as default.
1537 vmware_isregexp | **Optional.** Treat blacklist and whitelist expressions as regexp.
1538 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.
1541 ## <a id="plugins-contrib-vmware-esx-dc-runtime-issues"></a> vmware-esx-dc-runtime-issues
1543 Check command object for the `check_vmware_esx` plugin. All issues for the host.
1548 ------------------------|--------------
1549 vmware_datacenter | **Required.** Datacenter/vCenter hostname.
1550 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
1551 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".
1552 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".
1553 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
1554 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
1555 vmware_sessionfile | **Optional.** Session file name enhancement.
1556 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
1557 vmware_nosession | **Optional.** No auth session - IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
1558 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
1559 vmware_password | **Optional.** The username's password. No value defined as default.
1560 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
1561 vmware_exclude | **Optional.** Blacklist issues. No value defined as default.
1562 vmware_include | **Optional.** Whitelist issues. No value defined as default.
1563 vmware_isregexp | **Optional.** Treat blacklist and whitelist expressions as regexp.
1564 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.
1567 ## <a id="plugins-contrib-vmware-esx-dc-runtime-status"></a> vmware-esx-dc-runtime-status
1569 Check command object for the `check_vmware_esx` plugin. Overall object status (gray/green/red/yellow).
1574 ------------------------|--------------
1575 vmware_datacenter | **Required.** Datacenter/vCenter hostname.
1576 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
1577 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".
1578 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".
1579 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
1580 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
1581 vmware_sessionfile | **Optional.** Session file name enhancement.
1582 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
1583 vmware_nosession | **Optional.** No auth session - IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
1584 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
1585 vmware_password | **Optional.** The username's password. No value defined as default.
1586 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
1589 ## <a id="plugins-contrib-vmware-esx-dc-runtime-tools"></a> vmware-esx-dc-runtime-tools
1591 Check command object for the `check_vmware_esx` plugin. Vmware Tools status.
1596 ------------------------|--------------
1597 vmware_datacenter | **Required.** Datacenter/vCenter hostname.
1598 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
1599 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".
1600 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".
1601 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
1602 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
1603 vmware_sessionfile | **Optional.** Session file name enhancement.
1604 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
1605 vmware_nosession | **Optional.** No auth session - IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
1606 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
1607 vmware_password | **Optional.** The username's password. No value defined as default.
1608 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
1609 vmware_poweredonly | **Optional.** List only VMs which are powered on. No value defined as default.
1610 vmware_alertonly | **Optional.** List only alerting VMs. Important here to avoid masses of data.
1611 vmware_exclude | **Optional.** Blacklist VMs. No value defined as default.
1612 vmware_include | **Optional.** Whitelist VMs. No value defined as default.
1613 vmware_isregexp | **Optional.** Treat blacklist and whitelist expressions as regexp.
1614 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.
1617 ## <a id="plugins-contrib-vmware-esx-soap-host-check"></a> vmware-esx-soap-host-check
1619 Check command object for the `check_vmware_esx` plugin. Simple check to verify a successfull connection to VMware SOAP API.
1624 ------------------------|--------------
1625 vmware_host | **Required.** ESX or ESXi hostname.
1626 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
1627 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".
1628 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".
1629 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
1630 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
1631 vmware_sessionfile | **Optional.** Session file name enhancement.
1632 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
1633 vmware_nosession | **Optional.** No auth session - IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
1634 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
1635 vmware_password | **Optional.** The username's password. No value defined as default.
1636 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
1639 ## <a id="plugins-contrib-vmware-esx-soap-host-uptime"></a> vmware-esx-soap-host-uptime
1641 Check command object for the `check_vmware_esx` plugin. Displays uptime of the VMware host.
1646 ------------------------|--------------
1647 vmware_host | **Required.** ESX or ESXi hostname.
1648 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
1649 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".
1650 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".
1651 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
1652 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
1653 vmware_sessionfile | **Optional.** Session file name enhancement.
1654 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
1655 vmware_nosession | **Optional.** No auth session - IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
1656 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
1657 vmware_password | **Optional.** The username's password. No value defined as default.
1658 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
1661 ## <a id="plugins-contrib-vmware-esx-soap-host-cpu"></a> vmware-esx-soap-host-cpu
1663 Check command object for the `check_vmware_esx` plugin. CPU usage in percentage.
1668 ------------------------|--------------
1669 vmware_host | **Required.** ESX or ESXi hostname.
1670 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
1671 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".
1672 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".
1673 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
1674 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
1675 vmware_sessionfile | **Optional.** Session file name enhancement.
1676 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
1677 vmware_nosession | **Optional.** No auth session - IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
1678 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
1679 vmware_password | **Optional.** The username's password. No value defined as default.
1680 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
1681 vmware_warn | **Optional.** The warning threshold in percent. Defaults to "80%".
1682 vmware_crit | **Optional.** The critical threshold in percent. Defaults to "90%".
1685 ## <a id="plugins-contrib-vmware-esx-soap-host-cpu-ready"></a> vmware-esx-soap-host-cpu-ready
1687 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.
1692 ------------------------|--------------
1693 vmware_host | **Required.** ESX or ESXi hostname.
1694 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
1695 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".
1696 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".
1697 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
1698 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
1699 vmware_sessionfile | **Optional.** Session file name enhancement.
1700 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
1701 vmware_nosession | **Optional.** No auth session - IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
1702 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
1703 vmware_password | **Optional.** The username's password. No value defined as default.
1704 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
1707 ## <a id="plugins-contrib-vmware-esx-soap-host-cpu-wait"></a> vmware-esx-soap-host-cpu-wait
1709 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.
1714 ------------------------|--------------
1715 vmware_host | **Required.** ESX or ESXi hostname.
1716 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
1717 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".
1718 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".
1719 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
1720 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
1721 vmware_sessionfile | **Optional.** Session file name enhancement.
1722 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
1723 vmware_nosession | **Optional.** No auth session - IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
1724 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
1725 vmware_password | **Optional.** The username's password. No value defined as default.
1726 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
1729 ## <a id="plugins-contrib-vmware-esx-soap-host-cpu-usage"></a> vmware-esx-soap-host-cpu-usage
1731 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.
1736 ------------------------|--------------
1737 vmware_host | **Required.** ESX or ESXi hostname.
1738 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
1739 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".
1740 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".
1741 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
1742 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
1743 vmware_sessionfile | **Optional.** Session file name enhancement.
1744 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
1745 vmware_nosession | **Optional.** No auth session - IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
1746 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
1747 vmware_password | **Optional.** The username's password. No value defined as default.
1748 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
1749 vmware_warn | **Optional.** The warning threshold in percent. Defaults to "80%".
1750 vmware_crit | **Optional.** The critical threshold in percent. Defaults to "90%".
1753 ## <a id="plugins-contrib-vmware-esx-soap-host-mem"></a> vmware-esx-soap-host-mem
1755 Check command object for the `check_vmware_esx` plugin. All mem info(except overall and no thresholds).
1760 ------------------------|--------------
1761 vmware_host | **Required.** ESX or ESXi hostname.
1762 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
1763 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".
1764 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".
1765 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
1766 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
1767 vmware_sessionfile | **Optional.** Session file name enhancement.
1768 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
1769 vmware_nosession | **Optional.** No auth session - IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
1770 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
1771 vmware_password | **Optional.** The username's password. No value defined as default.
1772 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
1775 ## <a id="plugins-contrib-vmware-esx-soap-host-mem-usage"></a> vmware-esx-soap-host-mem-usage
1777 Check command object for the `check_vmware_esx` plugin. Average mem usage in percentage.
1782 ------------------------|--------------
1783 vmware_host | **Required.** ESX or ESXi hostname.
1784 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
1785 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".
1786 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".
1787 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
1788 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
1789 vmware_sessionfile | **Optional.** Session file name enhancement.
1790 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
1791 vmware_nosession | **Optional.** No auth session - IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
1792 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
1793 vmware_password | **Optional.** The username's password. No value defined as default.
1794 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
1795 vmware_warn | **Optional.** The warning threshold in percent. Defaults to "80%".
1796 vmware_crit | **Optional.** The critical threshold in percent. Defaults to "90%".
1799 ## <a id="plugins-contrib-vmware-esx-soap-host-mem-consumed"></a> vmware-esx-soap-host-mem-consumed
1801 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.
1806 ------------------------|--------------
1807 vmware_host | **Required.** ESX or ESXi hostname.
1808 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
1809 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".
1810 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".
1811 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
1812 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
1813 vmware_sessionfile | **Optional.** Session file name enhancement.
1814 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
1815 vmware_nosession | **Optional.** No auth session - IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
1816 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
1817 vmware_password | **Optional.** The username's password. No value defined as default.
1818 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
1819 vmware_warn | **Optional.** The warning threshold in percent. No value defined as default.
1820 vmware_crit | **Optional.** The critical threshold in percent. No value defined as default.
1823 ## <a id="plugins-contrib-vmware-esx-soap-host-mem-swapused"></a> vmware-esx-soap-host-mem-swapused
1825 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.
1830 ------------------------|--------------
1831 vmware_host | **Required.** ESX or ESXi hostname.
1832 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
1833 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".
1834 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".
1835 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
1836 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
1837 vmware_sessionfile | **Optional.** Session file name enhancement.
1838 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
1839 vmware_nosession | **Optional.** No auth session - IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
1840 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
1841 vmware_password | **Optional.** The username's password. No value defined as default.
1842 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
1843 vmware_warn | **Optional.** The warning threshold in percent. No value defined as default.
1844 vmware_crit | **Optional.** The critical threshold in percent. No value defined as default.
1845 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.
1848 ## <a id="plugins-contrib-vmware-esx-soap-host-mem-overhead"></a> vmware-esx-soap-host-mem-overhead
1850 Check command object for the `check_vmware_esx` plugin. Additional mem used by VM Server in MB.
1855 ------------------------|--------------
1856 vmware_host | **Required.** ESX or ESXi hostname.
1857 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
1858 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".
1859 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".
1860 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
1861 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
1862 vmware_sessionfile | **Optional.** Session file name enhancement.
1863 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
1864 vmware_nosession | **Optional.** No auth session - IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
1865 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
1866 vmware_password | **Optional.** The username's password. No value defined as default.
1867 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
1868 vmware_warn | **Optional.** The warning threshold in percent. No value defined as default.
1869 vmware_crit | **Optional.** The critical threshold in percent. No value defined as default.
1872 ## <a id="plugins-contrib-vmware-esx-soap-host-mem-memctl"></a> vmware-esx-soap-host-mem-memctl
1874 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.
1879 ------------------------|--------------
1880 vmware_host | **Required.** ESX or ESXi hostname.
1881 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
1882 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".
1883 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".
1884 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
1885 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
1886 vmware_sessionfile | **Optional.** Session file name enhancement.
1887 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
1888 vmware_nosession | **Optional.** No auth session - IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
1889 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
1890 vmware_password | **Optional.** The username's password. No value defined as default.
1891 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 vmware_warn | **Optional.** The warning threshold in percent. No value defined as default.
1893 vmware_crit | **Optional.** The critical threshold in percent. No value defined as default.
1894 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.
1897 ## <a id="plugins-contrib-vmware-esx-soap-host-net"></a> vmware-esx-soap-host-net
1899 Check command object for the `check_vmware_esx` plugin. Shows net info.
1904 ------------------------|--------------
1905 vmware_host | **Required.** ESX or ESXi hostname.
1906 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
1907 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".
1908 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".
1909 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
1910 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
1911 vmware_sessionfile | **Optional.** Session file name enhancement.
1912 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
1913 vmware_nosession | **Optional.** No auth session - IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
1914 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
1915 vmware_password | **Optional.** The username's password. No value defined as default.
1916 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
1917 vmware_exclude | **Optional.** Blacklist NICs. No value defined as default.
1918 vmware_isregexp | **Optional.** Treat blacklist expression as regexp.
1921 ## <a id="plugins-contrib-vmware-esx-soap-host-net-usage"></a> vmware-esx-soap-host-net-usage
1923 Check command object for the `check_vmware_esx` plugin. Overall network usage in KBps(Kilobytes per Second).
1928 ------------------------|--------------
1929 vmware_host | **Required.** ESX or ESXi hostname.
1930 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
1931 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".
1932 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".
1933 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
1934 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
1935 vmware_sessionfile | **Optional.** Session file name enhancement.
1936 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
1937 vmware_nosession | **Optional.** No auth session - IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
1938 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
1939 vmware_password | **Optional.** The username's password. No value defined as default.
1940 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
1941 vmware_warn | **Optional.** The warning threshold in KBps(Kilobytes per Second). No value defined as default.
1942 vmware_crit | **Optional.** The critical threshold in KBps(Kilobytes per Second). No value defined as default.
1945 ## <a id="plugins-contrib-vmware-esx-soap-host-net-receive"></a> vmware-esx-soap-host-net-receive
1947 Check command object for the `check_vmware_esx` plugin. Data receive in KBps(Kilobytes per Second).
1952 ------------------------|--------------
1953 vmware_host | **Required.** ESX or ESXi hostname.
1954 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
1955 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".
1956 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".
1957 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
1958 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
1959 vmware_sessionfile | **Optional.** Session file name enhancement.
1960 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
1961 vmware_nosession | **Optional.** No auth session - IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
1962 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
1963 vmware_password | **Optional.** The username's password. No value defined as default.
1964 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
1965 vmware_warn | **Optional.** The warning threshold in KBps(Kilobytes per Second). No value defined as default.
1966 vmware_crit | **Optional.** The critical threshold in KBps(Kilobytes per Second). No value defined as default.
1969 ## <a id="plugins-contrib-vmware-esx-soap-host-net-send"></a> vmware-esx-soap-host-net-send
1971 Check command object for the `check_vmware_esx` plugin. Data send in KBps(Kilobytes per Second).
1976 ------------------------|--------------
1977 vmware_host | **Required.** ESX or ESXi hostname.
1978 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
1979 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".
1980 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".
1981 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
1982 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
1983 vmware_sessionfile | **Optional.** Session file name enhancement.
1984 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
1985 vmware_nosession | **Optional.** No auth session - IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
1986 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
1987 vmware_password | **Optional.** The username's password. No value defined as default.
1988 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
1989 vmware_warn | **Optional.** The warning threshold in KBps(Kilobytes per Second). No value defined as default.
1990 vmware_crit | **Optional.** The critical threshold in KBps(Kilobytes per Second). No value defined as default.
1993 ## <a id="plugins-contrib-vmware-esx-soap-host-net-nic"></a> vmware-esx-soap-host-net-nic
1995 Check command object for the `check_vmware_esx` plugin. Check all active NICs.
2000 ------------------------|--------------
2001 vmware_host | **Required.** ESX or ESXi hostname.
2002 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
2003 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".
2004 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".
2005 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
2006 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
2007 vmware_sessionfile | **Optional.** Session file name enhancement.
2008 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
2009 vmware_nosession | **Optional.** No auth session - IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
2010 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
2011 vmware_password | **Optional.** The username's password. No value defined as default.
2012 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
2013 vmware_exclude | **Optional.** Blacklist NICs. No value defined as default.
2014 vmware_isregexp | **Optional.** Treat blacklist expression as regexp.
2017 ## <a id="plugins-contrib-vmware-esx-soap-host-volumes"></a> vmware-esx-soap-host-volumes
2019 Check command object for the `check_vmware_esx` plugin. Shows all datastore volumes info.
2024 ------------------------|--------------
2025 vmware_host | **Required.** ESX or ESXi hostname.
2026 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
2027 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".
2028 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".
2029 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
2030 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
2031 vmware_sessionfile | **Optional.** Session file name enhancement.
2032 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
2033 vmware_nosession | **Optional.** No auth session - IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
2034 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
2035 vmware_password | **Optional.** The username's password. No value defined as default.
2036 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
2037 vmware_subselect | **Optional.** Volume name to be checked the free space.
2038 vmware_gigabyte | **Optional.** Output in GB instead of MB.
2039 vmware_usedspace | **Optional.** Output used space instead of free. Defaults to "false".
2040 vmware_alertonly | **Optional.** List only alerting volumes. Defaults to "false".
2041 vmware_exclude | **Optional.** Blacklist volumes name. No value defined as default.
2042 vmware_include | **Optional.** Whitelist volumes name. No value defined as default.
2043 vmware_isregexp | **Optional.** Treat blacklist and whitelist expressions as regexp.
2044 vmware_warn | **Optional.** The warning threshold for volumes. Defaults to "80%".
2045 vmware_crit | **Optional.** The critical threshold for volumes. Defaults to "90%".
2046 vmware_spaceleft | **Optional.** This has to be used in conjunction with thresholds as mentioned above.
2049 ## <a id="plugins-contrib-vmware-esx-soap-host-io"></a> vmware-esx-soap-host-io
2051 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.
2056 ------------------------|--------------
2057 vmware_host | **Required.** ESX or ESXi hostname.
2058 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
2059 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".
2060 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".
2061 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
2062 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
2063 vmware_sessionfile | **Optional.** Session file name enhancement.
2064 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
2065 vmware_nosession | **Optional.** No auth session - IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
2066 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
2067 vmware_password | **Optional.** The username's password. No value defined as default.
2068 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
2071 ## <a id="plugins-contrib-vmware-esx-soap-host-io-aborted"></a> vmware-esx-soap-host-io-aborted
2073 Check command object for the `check_vmware_esx` plugin. Number of aborted SCSI commands.
2078 ------------------------|--------------
2079 vmware_host | **Required.** ESX or ESXi hostname.
2080 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
2081 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".
2082 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".
2083 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
2084 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
2085 vmware_sessionfile | **Optional.** Session file name enhancement.
2086 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
2087 vmware_nosession | **Optional.** No auth session - IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
2088 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
2089 vmware_password | **Optional.** The username's password. No value defined as default.
2090 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
2091 vmware_warn | **Optional.** The warning threshold. No value defined as default.
2092 vmware_crit | **Optional.** The critical threshold. No value defined as default.
2095 ## <a id="plugins-contrib-vmware-esx-soap-host-io-resets"></a> vmware-esx-soap-host-io-resets
2097 Check command object for the `check_vmware_esx` plugin. Number of SCSI bus resets.
2102 ------------------------|--------------
2103 vmware_host | **Required.** ESX or ESXi hostname.
2104 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
2105 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".
2106 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".
2107 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
2108 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
2109 vmware_sessionfile | **Optional.** Session file name enhancement.
2110 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
2111 vmware_nosession | **Optional.** No auth session - IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
2112 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
2113 vmware_password | **Optional.** The username's password. No value defined as default.
2114 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
2115 vmware_warn | **Optional.** The warning threshold. No value defined as default.
2116 vmware_crit | **Optional.** The critical threshold. No value defined as default.
2119 ## <a id="plugins-contrib-vmware-esx-soap-host-io-read"></a> vmware-esx-soap-host-io-read
2121 Check command object for the `check_vmware_esx` plugin. Average number of kilobytes read from the disk each second.
2126 ------------------------|--------------
2127 vmware_host | **Required.** ESX or ESXi hostname.
2128 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
2129 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".
2130 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".
2131 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
2132 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
2133 vmware_sessionfile | **Optional.** Session file name enhancement.
2134 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
2135 vmware_nosession | **Optional.** No auth session - IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
2136 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
2137 vmware_password | **Optional.** The username's password. No value defined as default.
2138 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
2139 vmware_warn | **Optional.** The warning threshold. No value defined as default.
2140 vmware_crit | **Optional.** The critical threshold. No value defined as default.
2143 ## <a id="plugins-contrib-vmware-esx-soap-host-io-read-latency"></a> vmware-esx-soap-host-io-read-latency
2145 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.
2150 ------------------------|--------------
2151 vmware_host | **Required.** ESX or ESXi hostname.
2152 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
2153 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".
2154 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".
2155 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
2156 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
2157 vmware_sessionfile | **Optional.** Session file name enhancement.
2158 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
2159 vmware_nosession | **Optional.** No auth session - IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
2160 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
2161 vmware_password | **Optional.** The username's password. No value defined as default.
2162 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
2163 vmware_warn | **Optional.** The warning threshold. No value defined as default.
2164 vmware_crit | **Optional.** The critical threshold. No value defined as default.
2167 ## <a id="plugins-contrib-vmware-esx-soap-host-io-write"></a> vmware-esx-soap-host-io-write
2169 Check command object for the `check_vmware_esx` plugin. Average number of kilobytes written to disk each second.
2174 ------------------------|--------------
2175 vmware_host | **Required.** ESX or ESXi hostname.
2176 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
2177 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".
2178 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".
2179 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
2180 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
2181 vmware_sessionfile | **Optional.** Session file name enhancement.
2182 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
2183 vmware_nosession | **Optional.** No auth session - IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
2184 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
2185 vmware_password | **Optional.** The username's password. No value defined as default.
2186 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
2187 vmware_warn | **Optional.** The warning threshold. No value defined as default.
2188 vmware_crit | **Optional.** The critical threshold. No value defined as default.
2191 ## <a id="plugins-contrib-vmware-esx-soap-host-io-write-latency"></a> vmware-esx-soap-host-io-write-latency
2193 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.
2198 ------------------------|--------------
2199 vmware_host | **Required.** ESX or ESXi hostname.
2200 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
2201 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".
2202 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".
2203 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
2204 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
2205 vmware_sessionfile | **Optional.** Session file name enhancement.
2206 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
2207 vmware_nosession | **Optional.** No auth session - IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
2208 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
2209 vmware_password | **Optional.** The username's password. No value defined as default.
2210 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
2211 vmware_warn | **Optional.** The warning threshold. No value defined as default.
2212 vmware_crit | **Optional.** The critical threshold. No value defined as default.
2215 ## <a id="plugins-contrib-vmware-esx-soap-host-io-usage"></a> vmware-esx-soap-host-io-usage
2217 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.
2222 ------------------------|--------------
2223 vmware_host | **Required.** ESX or ESXi hostname.
2224 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
2225 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".
2226 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".
2227 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
2228 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
2229 vmware_sessionfile | **Optional.** Session file name enhancement.
2230 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
2231 vmware_nosession | **Optional.** No auth session - IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
2232 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
2233 vmware_password | **Optional.** The username's password. No value defined as default.
2234 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
2235 vmware_warn | **Optional.** The warning threshold. No value defined as default.
2236 vmware_crit | **Optional.** The critical threshold. No value defined as default.
2239 ## <a id="plugins-contrib-vmware-esx-soap-host-io-kernel-latency"></a> vmware-esx-soap-host-io-kernel-latency
2241 Check command object for the `check_vmware_esx` plugin. Average amount of time (ms) spent by VMkernel processing each SCSI command.
2246 ------------------------|--------------
2247 vmware_host | **Required.** ESX or ESXi hostname.
2248 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
2249 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".
2250 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".
2251 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
2252 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
2253 vmware_sessionfile | **Optional.** Session file name enhancement.
2254 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
2255 vmware_nosession | **Optional.** No auth session - IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
2256 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
2257 vmware_password | **Optional.** The username's password. No value defined as default.
2258 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
2259 vmware_warn | **Optional.** The warning threshold. No value defined as default.
2260 vmware_crit | **Optional.** The critical threshold. No value defined as default.
2263 ## <a id="plugins-contrib-vmware-esx-soap-host-io-device-latency"></a> vmware-esx-soap-host-io-device-latency
2265 Check command object for the `check_vmware_esx` plugin. Average amount of time (ms) to complete a SCSI command from the physical device.
2270 ------------------------|--------------
2271 vmware_host | **Required.** ESX or ESXi hostname.
2272 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
2273 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".
2274 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".
2275 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
2276 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
2277 vmware_sessionfile | **Optional.** Session file name enhancement.
2278 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
2279 vmware_nosession | **Optional.** No auth session - IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
2280 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
2281 vmware_password | **Optional.** The username's password. No value defined as default.
2282 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
2283 vmware_warn | **Optional.** The warning threshold. No value defined as default.
2284 vmware_crit | **Optional.** The critical threshold. No value defined as default.
2287 ## <a id="plugins-contrib-vmware-esx-soap-host-io-queue-latency"></a> vmware-esx-soap-host-io-queue-latency
2289 Check command object for the `check_vmware_esx` plugin. Average amount of time (ms) spent in the VMkernel queue.
2294 ------------------------|--------------
2295 vmware_host | **Required.** ESX or ESXi hostname.
2296 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
2297 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".
2298 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".
2299 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
2300 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
2301 vmware_sessionfile | **Optional.** Session file name enhancement.
2302 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
2303 vmware_nosession | **Optional.** No auth session - IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
2304 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
2305 vmware_password | **Optional.** The username's password. No value defined as default.
2306 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
2307 vmware_warn | **Optional.** The warning threshold. No value defined as default.
2308 vmware_crit | **Optional.** The critical threshold. No value defined as default.
2311 ## <a id="plugins-contrib-vmware-esx-soap-host-io-total-latency"></a> vmware-esx-soap-host-io-total-latency
2313 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.
2318 ------------------------|--------------
2319 vmware_host | **Required.** ESX or ESXi hostname.
2320 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
2321 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".
2322 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".
2323 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
2324 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
2325 vmware_sessionfile | **Optional.** Session file name enhancement.
2326 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
2327 vmware_nosession | **Optional.** No auth session - IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
2328 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
2329 vmware_password | **Optional.** The username's password. No value defined as default.
2330 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
2331 vmware_warn | **Optional.** The warning threshold. No value defined as default.
2332 vmware_crit | **Optional.** The critical threshold. No value defined as default.
2335 ## <a id="plugins-contrib-vmware-esx-soap-host-media"></a> vmware-esx-soap-host-media
2337 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.
2342 ------------------------|--------------
2343 vmware_host | **Required.** ESX or ESXi hostname.
2344 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
2345 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".
2346 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".
2347 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
2348 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
2349 vmware_sessionfile | **Optional.** Session file name enhancement.
2350 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
2351 vmware_nosession | **Optional.** No auth session - IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
2352 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
2353 vmware_password | **Optional.** The username's password. No value defined as default.
2354 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
2355 vmware_exclude | **Optional.** Blacklist VMs name. No value defined as default.
2356 vmware_include | **Optional.** Whitelist VMs name. No value defined as default.
2357 vmware_isregexp | **Optional.** Treat blacklist and whitelist expressions as regexp.
2358 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.
2361 ## <a id="plugins-contrib-vmware-esx-soap-host-service"></a> vmware-esx-soap-host-service
2363 Check command object for the `check_vmware_esx` plugin. Shows host service info.
2368 ------------------------|--------------
2369 vmware_host | **Required.** ESX or ESXi hostname.
2370 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
2371 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".
2372 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".
2373 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
2374 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
2375 vmware_sessionfile | **Optional.** Session file name enhancement.
2376 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
2377 vmware_nosession | **Optional.** No auth session - IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
2378 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
2379 vmware_password | **Optional.** The username's password. No value defined as default.
2380 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
2381 vmware_exclude | **Optional.** Blacklist services name. No value defined as default.
2382 vmware_include | **Optional.** Whitelist services name. No value defined as default.
2383 vmware_isregexp | **Optional.** Treat blacklist and whitelist expressions as regexp.
2384 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.
2387 ## <a id="plugins-contrib-vmware-esx-soap-host-runtime"></a> vmware-esx-soap-host-runtime
2389 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.
2394 ------------------------|--------------
2395 vmware_host | **Required.** ESX or ESXi hostname.
2396 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
2397 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".
2398 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".
2399 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
2400 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
2401 vmware_sessionfile | **Optional.** Session file name enhancement.
2402 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
2403 vmware_nosession | **Optional.** No auth session - IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
2404 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
2405 vmware_password | **Optional.** The username's password. No value defined as default.
2406 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
2409 ## <a id="plugins-contrib-vmware-esx-soap-host-runtime-con"></a> vmware-esx-soap-host-runtime-con
2411 Check command object for the `check_vmware_esx` plugin. Shows connection state.
2416 ------------------------|--------------
2417 vmware_host | **Required.** ESX or ESXi hostname.
2418 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
2419 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".
2420 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".
2421 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
2422 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
2423 vmware_sessionfile | **Optional.** Session file name enhancement.
2424 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
2425 vmware_nosession | **Optional.** No auth session - IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
2426 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
2427 vmware_password | **Optional.** The username's password. No value defined as default.
2428 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
2431 ## <a id="plugins-contrib-vmware-esx-soap-host-runtime-listvms"></a> vmware-esx-soap-host-runtime-listvms
2433 Check command object for the `check_vmware_esx` plugin. List of VMware machines and their status.
2438 ------------------------|--------------
2439 vmware_host | **Required.** ESX or ESXi hostname.
2440 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
2441 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".
2442 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".
2443 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
2444 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
2445 vmware_sessionfile | **Optional.** Session file name enhancement.
2446 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
2447 vmware_nosession | **Optional.** No auth session - IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
2448 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
2449 vmware_password | **Optional.** The username's password. No value defined as default.
2450 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
2451 vmware_exclude | **Optional.** Blacklist VMs name. No value defined as default.
2452 vmware_include | **Optional.** Whitelist VMs name. No value defined as default.
2453 vmware_isregexp | **Optional.** Treat blacklist and whitelist expressions as regexp.
2454 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.
2457 ## <a id="plugins-contrib-vmware-esx-soap-host-runtime-status"></a> vmware-esx-soap-host-runtime-status
2459 Check command object for the `check_vmware_esx` plugin. Overall object status (gray/green/red/yellow).
2464 ------------------------|--------------
2465 vmware_host | **Required.** ESX or ESXi hostname.
2466 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
2467 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".
2468 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".
2469 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
2470 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
2471 vmware_sessionfile | **Optional.** Session file name enhancement.
2472 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
2473 vmware_nosession | **Optional.** No auth session - IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
2474 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
2475 vmware_password | **Optional.** The username's password. No value defined as default.
2476 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
2479 ## <a id="plugins-contrib-vmware-esx-soap-host-runtime-health"></a> vmware-esx-soap-host-runtime-health
2481 Check command object for the `check_vmware_esx` plugin. Checks cpu/storage/memory/sensor status.
2486 ------------------------|--------------
2487 vmware_host | **Required.** ESX or ESXi hostname.
2488 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
2489 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".
2490 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".
2491 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
2492 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
2493 vmware_sessionfile | **Optional.** Session file name enhancement.
2494 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
2495 vmware_nosession | **Optional.** No auth session - IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
2496 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
2497 vmware_password | **Optional.** The username's password. No value defined as default.
2498 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
2499 vmware_exclude | **Optional.** Blacklist status name. No value defined as default.
2500 vmware_include | **Optional.** Whitelist status name. No value defined as default.
2501 vmware_isregexp | **Optional.** Treat blacklist and whitelist expressions as regexp.
2504 ## <a id="plugins-contrib-vmware-esx-soap-host-runtime-health-listsensors"></a> vmware-esx-soap-host-runtime-health-listsensors
2506 Check command object for the `check_vmware_esx` plugin. List all available sensors(use for listing purpose only).
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
2524 vmware_exclude | **Optional.** Blacklist status name. No value defined as default.
2525 vmware_include | **Optional.** Whitelist status name. No value defined as default.
2526 vmware_isregexp | **Optional.** Treat blacklist and whitelist expressions as regexp.
2529 ## <a id="plugins-contrib-vmware-esx-soap-host-runtime-health-nostoragestatus"></a> vmware-esx-soap-host-runtime-health-nostoragestatus
2531 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**.
2536 ------------------------|--------------
2537 vmware_host | **Required.** ESX or ESXi hostname.
2538 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
2539 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".
2540 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".
2541 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
2542 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
2543 vmware_sessionfile | **Optional.** Session file name enhancement.
2544 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
2545 vmware_nosession | **Optional.** No auth session - IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
2546 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
2547 vmware_password | **Optional.** The username's password. No value defined as default.
2548 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
2549 vmware_exclude | **Optional.** Blacklist status name. No value defined as default.
2550 vmware_include | **Optional.** Whitelist status name. No value defined as default.
2551 vmware_isregexp | **Optional.** Treat blacklist and whitelist expressions as regexp.
2554 ## <a id="plugins-contrib-vmware-esx-soap-host-runtime-storagehealth"></a> vmware-esx-soap-host-runtime-storagehealth
2556 Check command object for the `check_vmware_esx` plugin. Local storage status check.
2561 ------------------------|--------------
2562 vmware_host | **Required.** ESX or ESXi hostname.
2563 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
2564 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".
2565 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".
2566 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
2567 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
2568 vmware_sessionfile | **Optional.** Session file name enhancement.
2569 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
2570 vmware_nosession | **Optional.** No auth session - IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
2571 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
2572 vmware_password | **Optional.** The username's password. No value defined as default.
2573 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
2574 vmware_exclude | **Optional.** Blacklist storage name. No value defined as default.
2575 vmware_include | **Optional.** Whitelist storage name. No value defined as default.
2576 vmware_isregexp | **Optional.** Treat blacklist and whitelist expressions as regexp.
2577 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.
2580 ## <a id="plugins-contrib-vmware-esx-soap-host-runtime-temp"></a> vmware-esx-soap-host-runtime-temp
2582 Check command object for the `check_vmware_esx` plugin. Lists all temperature sensors.
2587 ------------------------|--------------
2588 vmware_host | **Required.** ESX or ESXi hostname.
2589 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
2590 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".
2591 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".
2592 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
2593 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
2594 vmware_sessionfile | **Optional.** Session file name enhancement.
2595 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
2596 vmware_nosession | **Optional.** No auth session - IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
2597 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
2598 vmware_password | **Optional.** The username's password. No value defined as default.
2599 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
2600 vmware_exclude | **Optional.** Blacklist sensor name. No value defined as default.
2601 vmware_include | **Optional.** Whitelist sensor name. No value defined as default.
2602 vmware_isregexp | **Optional.** Treat blacklist and whitelist expressions as regexp.
2603 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.
2606 ## <a id="plugins-contrib-vmware-esx-soap-host-runtime-issues"></a> vmware-esx-soap-host-runtime-issues
2608 Check command object for the `check_vmware_esx` plugin. Lists all configuration issues for the host.
2613 ------------------------|--------------
2614 vmware_host | **Required.** ESX or ESXi hostname.
2615 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
2616 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".
2617 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".
2618 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
2619 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
2620 vmware_sessionfile | **Optional.** Session file name enhancement.
2621 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
2622 vmware_nosession | **Optional.** No auth session - IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
2623 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
2624 vmware_password | **Optional.** The username's password. No value defined as default.
2625 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
2626 vmware_exclude | **Optional.** Blacklist configuration issues. No value defined as default.
2627 vmware_include | **Optional.** Whitelist configuration issues. No value defined as default.
2628 vmware_isregexp | **Optional.** Treat blacklist and whitelist expressions as regexp.
2629 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.
2632 ## <a id="plugins-contrib-vmware-esx-soap-host-storage"></a> vmware-esx-soap-host-storage
2634 Check command object for the `check_vmware_esx` plugin. Shows Host storage info.
2639 ------------------------|--------------
2640 vmware_host | **Required.** ESX or ESXi hostname.
2641 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
2642 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".
2643 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".
2644 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
2645 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
2646 vmware_sessionfile | **Optional.** Session file name enhancement.
2647 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
2648 vmware_nosession | **Optional.** No auth session - IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
2649 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
2650 vmware_password | **Optional.** The username's password. No value defined as default.
2651 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
2652 vmware_exclude | **Optional.** Blacklist adapters, luns and paths. No value defined as default.
2653 vmware_include | **Optional.** Whitelist adapters, luns and paths. No value defined as default.
2654 vmware_isregexp | **Optional.** Treat blacklist and whitelist expressions as regexp.
2657 ## <a id="plugins-contrib-vmware-esx-soap-host-storage-adapter"></a> vmware-esx-soap-host-storage-adapter
2659 Check command object for the `check_vmware_esx` plugin. List host bus adapters.
2664 ------------------------|--------------
2665 vmware_host | **Required.** ESX or ESXi hostname.
2666 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
2667 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".
2668 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".
2669 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
2670 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
2671 vmware_sessionfile | **Optional.** Session file name enhancement.
2672 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
2673 vmware_nosession | **Optional.** No auth session - IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
2674 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
2675 vmware_password | **Optional.** The username's password. No value defined as default.
2676 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
2677 vmware_exclude | **Optional.** Blacklist adapters. No value defined as default.
2678 vmware_include | **Optional.** Whitelist adapters. No value defined as default.
2679 vmware_isregexp | **Optional.** Treat blacklist and whitelist expressions as regexp.
2680 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.
2683 ## <a id="plugins-contrib-vmware-esx-soap-host-storage-lun"></a> vmware-esx-soap-host-storage-lun
2685 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.
2690 ------------------------|--------------
2691 vmware_host | **Required.** ESX or ESXi hostname.
2692 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
2693 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".
2694 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".
2695 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
2696 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
2697 vmware_sessionfile | **Optional.** Session file name enhancement.
2698 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
2699 vmware_nosession | **Optional.** No auth session - IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
2700 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
2701 vmware_password | **Optional.** The username's password. No value defined as default.
2702 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
2703 vmware_exclude | **Optional.** Blacklist luns. No value defined as default.
2704 vmware_include | **Optional.** Whitelist luns. No value defined as default.
2705 vmware_isregexp | **Optional.** Treat blacklist and whitelist expressions as regexp.
2706 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.
2709 ## <a id="plugins-contrib-vmware-esx-soap-host-storage-path"></a> vmware-esx-soap-host-storage-path
2711 Check command object for the `check_vmware_esx` plugin. List multipaths and the associated paths.
2716 ------------------------|--------------
2717 vmware_host | **Required.** ESX or ESXi hostname.
2718 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
2719 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".
2720 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".
2721 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
2722 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
2723 vmware_sessionfile | **Optional.** Session file name enhancement.
2724 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
2725 vmware_nosession | **Optional.** No auth session - IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
2726 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
2727 vmware_password | **Optional.** The username's password. No value defined as default.
2728 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
2729 vmware_alertonly | **Optional.** List only alerting units. Important here to avoid masses of data. Defaults to "false".
2730 vmware_exclude | **Optional.** Blacklist paths. No value defined as default.
2731 vmware_include | **Optional.** Whitelist paths. No value defined as default.
2732 vmware_isregexp | **Optional.** Treat blacklist and whitelist expressions as regexp.
2733 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.
2736 ## <a id="plugins-contrib-vmware-esx-soap-vm-cpu"></a> vmware-esx-soap-vm-cpu
2738 Check command object for the `check_vmware_esx` plugin. Shows all CPU usage info.
2743 ------------------------|--------------
2744 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. Conflicts with **vmware_host**.
2745 vmware_host | **Optional.** ESX or ESXi hostname. Conflicts with **vmware_datacenter**.
2746 vmware_vmname | **Required.** Virtual machine name.
2747 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
2748 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".
2749 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".
2750 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
2751 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
2752 vmware_sessionfile | **Optional.** Session file name enhancement.
2753 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
2754 vmware_nosession | **Optional.** No auth session - IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
2755 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
2756 vmware_password | **Optional.** The username's password. No value defined as default.
2757 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
2761 ## <a id="plugins-contrib-vmware-esx-soap-vm-cpu-ready"></a> vmware-esx-soap-vm-cpu-ready
2763 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.
2768 ------------------------|--------------
2769 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. Conflicts with **vmware_host**.
2770 vmware_host | **Optional.** ESX or ESXi hostname. Conflicts with **vmware_datacenter**.
2771 vmware_vmname | **Required.** Virtual machine name.
2772 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
2773 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".
2774 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".
2775 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
2776 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
2777 vmware_sessionfile | **Optional.** Session file name enhancement.
2778 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
2779 vmware_nosession | **Optional.** No auth session - IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
2780 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
2781 vmware_password | **Optional.** The username's password. No value defined as default.
2782 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
2783 vmware_warn | **Optional.** The warning threshold. No value defined as default.
2784 vmware_crit | **Optional.** The critical threshold. No value defined as default.
2787 ## <a id="plugins-contrib-vmware-esx-soap-vm-cpu-wait"></a> vmware-esx-soap-vm-cpu-wait
2789 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.
2794 ------------------------|--------------
2795 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. Conflicts with **vmware_host**.
2796 vmware_host | **Optional.** ESX or ESXi hostname. Conflicts with **vmware_datacenter**.
2797 vmware_vmname | **Required.** Virtual machine name.
2798 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
2799 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".
2800 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".
2801 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
2802 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
2803 vmware_sessionfile | **Optional.** Session file name enhancement.
2804 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
2805 vmware_nosession | **Optional.** No auth session - IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
2806 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
2807 vmware_password | **Optional.** The username's password. No value defined as default.
2808 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
2809 vmware_warn | **Optional.** The warning threshold. No value defined as default.
2810 vmware_crit | **Optional.** The critical threshold. No value defined as default.
2813 ## <a id="plugins-contrib-vmware-esx-soap-vm-cpu-usage"></a> vmware-esx-soap-vm-cpu-usage
2815 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.
2820 ------------------------|--------------
2821 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. Conflicts with **vmware_host**.
2822 vmware_host | **Optional.** ESX or ESXi hostname. Conflicts with **vmware_datacenter**.
2823 vmware_vmname | **Required.** Virtual machine name.
2824 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
2825 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".
2826 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".
2827 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
2828 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
2829 vmware_sessionfile | **Optional.** Session file name enhancement.
2830 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
2831 vmware_nosession | **Optional.** No auth session - IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
2832 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
2833 vmware_password | **Optional.** The username's password. No value defined as default.
2834 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
2835 vmware_warn | **Optional.** Warning threshold in percent. Defaults to "80%".
2836 vmware_crit | **Optional.** Critical threshold in percent. Defaults to "90%".
2839 ## <a id="plugins-contrib-vmware-esx-soap-vm-mem"></a> vmware-esx-soap-vm-mem
2841 Check command object for the `check_vmware_esx` plugin. Shows all memory info, except overall.
2846 ------------------------|--------------
2847 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. Conflicts with **vmware_host**.
2848 vmware_host | **Optional.** ESX or ESXi hostname. Conflicts with **vmware_datacenter**.
2849 vmware_vmname | **Required.** Virtual machine name.
2850 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
2851 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".
2852 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".
2853 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
2854 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
2855 vmware_sessionfile | **Optional.** Session file name enhancement.
2856 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
2857 vmware_nosession | **Optional.** No auth session - IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
2858 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
2859 vmware_password | **Optional.** The username's password. No value defined as default.
2860 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
2863 ## <a id="plugins-contrib-vmware-esx-soap-vm-mem-usage"></a> vmware-esx-soap-vm-mem-usage
2865 Check command object for the `check_vmware_esx` plugin. Average mem usage in percentage of configured virtual machine "physical" memory.
2870 ------------------------|--------------
2871 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. Conflicts with **vmware_host**.
2872 vmware_host | **Optional.** ESX or ESXi hostname. Conflicts with **vmware_datacenter**.
2873 vmware_vmname | **Required.** Virtual machine name.
2874 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
2875 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".
2876 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".
2877 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
2878 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
2879 vmware_sessionfile | **Optional.** Session file name enhancement.
2880 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
2881 vmware_nosession | **Optional.** No auth session - IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
2882 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
2883 vmware_password | **Optional.** The username's password. No value defined as default.
2884 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
2885 vmware_warn | **Optional.** Warning threshold in percent. Defaults to "80%".
2886 vmware_crit | **Optional.** Critical threshold in percent. Defaults to "90%".
2889 ## <a id="plugins-contrib-vmware-esx-soap-vm-mem-consumed"></a> vmware-esx-soap-vm-mem-consumed
2891 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>
2892 **vm consumed memory = memory granted - memory saved**
2897 ------------------------|--------------
2898 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. Conflicts with **vmware_host**.
2899 vmware_host | **Optional.** ESX or ESXi hostname. Conflicts with **vmware_datacenter**.
2900 vmware_vmname | **Required.** Virtual machine name.
2901 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
2902 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".
2903 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".
2904 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
2905 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
2906 vmware_sessionfile | **Optional.** Session file name enhancement.
2907 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
2908 vmware_nosession | **Optional.** No auth session - IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
2909 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
2910 vmware_password | **Optional.** The username's password. No value defined as default.
2911 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
2912 vmware_warn | **Optional.** The warning threshold. No value defined as default.
2913 vmware_crit | **Optional.** The critical threshold. No value defined as default.
2916 ## <a id="plugins-contrib-vmware-esx-soap-vm-mem-memctl"></a> vmware-esx-soap-vm-mem-memctl
2918 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.
2923 ------------------------|--------------
2924 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. Conflicts with **vmware_host**.
2925 vmware_host | **Optional.** ESX or ESXi hostname. Conflicts with **vmware_datacenter**.
2926 vmware_vmname | **Required.** Virtual machine name.
2927 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
2928 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".
2929 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".
2930 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
2931 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
2932 vmware_sessionfile | **Optional.** Session file name enhancement.
2933 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
2934 vmware_nosession | **Optional.** No auth session - IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
2935 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
2936 vmware_password | **Optional.** The username's password. No value defined as default.
2937 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
2938 vmware_warn | **Optional.** The warning threshold. No value defined as default.
2939 vmware_crit | **Optional.** The critical threshold. No value defined as default.
2943 ## <a id="plugins-contrib-vmware-esx-soap-vm-net"></a> vmware-esx-soap-vm-net
2945 Check command object for the `check_vmware_esx` plugin. Shows net info.
2950 ------------------------|--------------
2951 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. Conflicts with **vmware_host**.
2952 vmware_host | **Optional.** ESX or ESXi hostname. Conflicts with **vmware_datacenter**.
2953 vmware_vmname | **Required.** Virtual machine name.
2954 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
2955 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".
2956 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".
2957 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
2958 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
2959 vmware_sessionfile | **Optional.** Session file name enhancement.
2960 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
2961 vmware_nosession | **Optional.** No auth session - IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
2962 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
2963 vmware_password | **Optional.** The username's password. No value defined as default.
2964 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
2967 ## <a id="plugins-contrib-vmware-esx-soap-vm-net-usage"></a> vmware-esx-soap-vm-net-usage
2969 Check command object for the `check_vmware_esx` plugin. Overall network usage in KBps(Kilobytes per Second).
2974 ------------------------|--------------
2975 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. Conflicts with **vmware_host**.
2976 vmware_host | **Optional.** ESX or ESXi hostname. Conflicts with **vmware_datacenter**.
2977 vmware_vmname | **Required.** Virtual machine name.
2978 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
2979 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".
2980 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".
2981 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
2982 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
2983 vmware_sessionfile | **Optional.** Session file name enhancement.
2984 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
2985 vmware_nosession | **Optional.** No auth session - IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
2986 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
2987 vmware_password | **Optional.** The username's password. No value defined as default.
2988 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
2989 vmware_warn | **Optional.** The warning threshold. No value defined as default.
2990 vmware_crit | **Optional.** The critical threshold. No value defined as default.
2993 ## <a id="plugins-contrib-vmware-esx-soap-vm-net-receive"></a> vmware-esx-soap-vm-net-receive
2995 Check command object for the `check_vmware_esx` plugin. Receive in KBps(Kilobytes per Second).
3000 ------------------------|--------------
3001 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. Conflicts with **vmware_host**.
3002 vmware_host | **Optional.** ESX or ESXi hostname. Conflicts with **vmware_datacenter**.
3003 vmware_vmname | **Required.** Virtual machine name.
3004 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
3005 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".
3006 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".
3007 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
3008 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
3009 vmware_sessionfile | **Optional.** Session file name enhancement.
3010 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
3011 vmware_nosession | **Optional.** No auth session - IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
3012 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
3013 vmware_password | **Optional.** The username's password. No value defined as default.
3014 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
3015 vmware_warn | **Optional.** The warning threshold. No value defined as default.
3016 vmware_crit | **Optional.** The critical threshold. No value defined as default.
3019 ## <a id="plugins-contrib-vmware-esx-soap-vm-net-send"></a> vmware-esx-soap-vm-net-send
3021 Check command object for the `check_vmware_esx` plugin. Send in KBps(Kilobytes per Second).
3026 ------------------------|--------------
3027 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. Conflicts with **vmware_host**.
3028 vmware_host | **Optional.** ESX or ESXi hostname. Conflicts with **vmware_datacenter**.
3029 vmware_vmname | **Required.** Virtual machine name.
3030 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
3031 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".
3032 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".
3033 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
3034 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
3035 vmware_sessionfile | **Optional.** Session file name enhancement.
3036 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
3037 vmware_nosession | **Optional.** No auth session - IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
3038 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
3039 vmware_password | **Optional.** The username's password. No value defined as default.
3040 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
3041 vmware_warn | **Optional.** The warning threshold. No value defined as default.
3042 vmware_crit | **Optional.** The critical threshold. No value defined as default.
3045 ## <a id="plugins-contrib-vmware-esx-soap-vm-io"></a> vmware-esx-soap-vm-io
3047 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.
3052 ------------------------|--------------
3053 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. Conflicts with **vmware_host**.
3054 vmware_host | **Optional.** ESX or ESXi hostname. Conflicts with **vmware_datacenter**.
3055 vmware_vmname | **Required.** Virtual machine name.
3056 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
3057 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".
3058 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".
3059 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
3060 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
3061 vmware_sessionfile | **Optional.** Session file name enhancement.
3062 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
3063 vmware_nosession | **Optional.** No auth session - IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
3064 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
3065 vmware_password | **Optional.** The username's password. No value defined as default.
3066 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
3069 ## <a id="plugins-contrib-vmware-esx-soap-vm-io-read"></a> vmware-esx-soap-vm-io-read
3071 Check command object for the `check_vmware_esx` plugin. Average number of kilobytes read from the disk each second.
3076 ------------------------|--------------
3077 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. Conflicts with **vmware_host**.
3078 vmware_host | **Optional.** ESX or ESXi hostname. Conflicts with **vmware_datacenter**.
3079 vmware_vmname | **Required.** Virtual machine name.
3080 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
3081 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".
3082 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".
3083 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
3084 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
3085 vmware_sessionfile | **Optional.** Session file name enhancement.
3086 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
3087 vmware_nosession | **Optional.** No auth session - IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
3088 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
3089 vmware_password | **Optional.** The username's password. No value defined as default.
3090 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
3091 vmware_warn | **Optional.** The warning threshold. No value defined as default.
3092 vmware_crit | **Optional.** The critical threshold. No value defined as default.
3095 ## <a id="plugins-contrib-vmware-esx-soap-vm-io-write"></a> vmware-esx-soap-vm-io-write
3097 Check command object for the `check_vmware_esx` plugin. Average number of kilobytes written to disk each second.
3102 ------------------------|--------------
3103 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. Conflicts with **vmware_host**.
3104 vmware_host | **Optional.** ESX or ESXi hostname. Conflicts with **vmware_datacenter**.
3105 vmware_vmname | **Required.** Virtual machine name.
3106 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
3107 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".
3108 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".
3109 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
3110 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
3111 vmware_sessionfile | **Optional.** Session file name enhancement.
3112 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
3113 vmware_nosession | **Optional.** No auth session - IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
3114 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
3115 vmware_password | **Optional.** The username's password. No value defined as default.
3116 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
3117 vmware_warn | **Optional.** The warning threshold. No value defined as default.
3118 vmware_crit | **Optional.** The critical threshold. No value defined as default.
3121 ## <a id="plugins-contrib-vmware-esx-soap-vm-io-usage"></a> vmware-esx-soap-vm-io-usage
3123 Check command object for the `check_vmware_esx` plugin. Aggregated disk I/O rate.
3128 ------------------------|--------------
3129 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. Conflicts with **vmware_host**.
3130 vmware_host | **Optional.** ESX or ESXi hostname. Conflicts with **vmware_datacenter**.
3131 vmware_vmname | **Required.** Virtual machine name.
3132 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
3133 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".
3134 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".
3135 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
3136 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
3137 vmware_sessionfile | **Optional.** Session file name enhancement.
3138 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
3139 vmware_nosession | **Optional.** No auth session - IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
3140 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
3141 vmware_password | **Optional.** The username's password. No value defined as default.
3142 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
3143 vmware_warn | **Optional.** The warning threshold. No value defined as default.
3144 vmware_crit | **Optional.** The critical threshold. No value defined as default.
3147 ## <a id="plugins-contrib-vmware-esx-soap-vm-runtime"></a> vmware-esx-soap-vm-runtime
3149 Check command object for the `check_vmware_esx` plugin. Shows virtual machine runtime info.
3154 ------------------------|--------------
3155 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. Conflicts with **vmware_host**.
3156 vmware_host | **Optional.** ESX or ESXi hostname. Conflicts with **vmware_datacenter**.
3157 vmware_vmname | **Required.** Virtual machine name.
3158 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
3159 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".
3160 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".
3161 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
3162 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
3163 vmware_sessionfile | **Optional.** Session file name enhancement.
3164 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
3165 vmware_nosession | **Optional.** No auth session - IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
3166 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
3167 vmware_password | **Optional.** The username's password. No value defined as default.
3168 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
3171 ## <a id="plugins-contrib-vmware-esx-soap-vm-runtime-con"></a> vmware-esx-soap-vm-runtime-con
3173 Check command object for the `check_vmware_esx` plugin. Shows the connection state.
3178 ------------------------|--------------
3179 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. Conflicts with **vmware_host**.
3180 vmware_host | **Optional.** ESX or ESXi hostname. Conflicts with **vmware_datacenter**.
3181 vmware_vmname | **Required.** Virtual machine name.
3182 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
3183 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".
3184 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".
3185 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
3186 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
3187 vmware_sessionfile | **Optional.** Session file name enhancement.
3188 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
3189 vmware_nosession | **Optional.** No auth session - IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
3190 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
3191 vmware_password | **Optional.** The username's password. No value defined as default.
3192 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
3195 ## <a id="plugins-contrib-vmware-esx-soap-vm-runtime-powerstate"></a> vmware-esx-soap-vm-runtime-powerstate
3197 Check command object for the `check_vmware_esx` plugin. Shows virtual machine power state: poweredOn, poweredOff or suspended.
3202 ------------------------|--------------
3203 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. Conflicts with **vmware_host**.
3204 vmware_host | **Optional.** ESX or ESXi hostname. Conflicts with **vmware_datacenter**.
3205 vmware_vmname | **Required.** Virtual machine name.
3206 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
3207 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".
3208 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".
3209 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
3210 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
3211 vmware_sessionfile | **Optional.** Session file name enhancement.
3212 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
3213 vmware_nosession | **Optional.** No auth session - IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
3214 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
3215 vmware_password | **Optional.** The username's password. No value defined as default.
3216 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
3219 ## <a id="plugins-contrib-vmware-esx-soap-vm-runtime-status"></a> vmware-esx-soap-vm-runtime-status
3221 Check command object for the `check_vmware_esx` plugin. Overall object status (gray/green/red/yellow).
3226 ------------------------|--------------
3227 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. Conflicts with **vmware_host**.
3228 vmware_host | **Optional.** ESX or ESXi hostname. Conflicts with **vmware_datacenter**.
3229 vmware_vmname | **Required.** Virtual machine name.
3230 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
3231 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".
3232 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".
3233 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
3234 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
3235 vmware_sessionfile | **Optional.** Session file name enhancement.
3236 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
3237 vmware_nosession | **Optional.** No auth session - IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
3238 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
3239 vmware_password | **Optional.** The username's password. No value defined as default.
3240 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
3243 ## <a id="plugins-contrib-vmware-esx-soap-vm-runtime-consoleconnections"></a> vmware-esx-soap-vm-runtime-consoleconnections
3245 Check command object for the `check_vmware_esx` plugin. Console connections to virtual machine.
3250 ------------------------|--------------
3251 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. Conflicts with **vmware_host**.
3252 vmware_host | **Optional.** ESX or ESXi hostname. Conflicts with **vmware_datacenter**.
3253 vmware_vmname | **Required.** Virtual machine name.
3254 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
3255 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".
3256 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".
3257 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
3258 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
3259 vmware_sessionfile | **Optional.** Session file name enhancement.
3260 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
3261 vmware_nosession | **Optional.** No auth session - IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
3262 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
3263 vmware_password | **Optional.** The username's password. No value defined as default.
3264 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
3265 vmware_warn | **Optional.** The warning threshold. No value defined as default.
3266 vmware_crit | **Optional.** The critical threshold. No value defined as default.
3269 ## <a id="plugins-contrib-vmware-esx-soap-vm-runtime-gueststate"></a> vmware-esx-soap-vm-runtime-gueststate
3271 Check command object for the `check_vmware_esx` plugin. Guest OS status. Needs VMware Tools installed and running.
3276 ------------------------|--------------
3277 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. Conflicts with **vmware_host**.
3278 vmware_host | **Optional.** ESX or ESXi hostname. Conflicts with **vmware_datacenter**.
3279 vmware_vmname | **Required.** Virtual machine name.
3280 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
3281 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".
3282 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".
3283 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
3284 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
3285 vmware_sessionfile | **Optional.** Session file name enhancement.
3286 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
3287 vmware_nosession | **Optional.** No auth session - IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
3288 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
3289 vmware_password | **Optional.** The username's password. No value defined as default.
3290 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
3292 ## <a id="plugins-contrib-vmware-esx-soap-vm-runtime-tools"></a> vmware-esx-soap-vm-runtime-tools
3294 Check command object for the `check_vmware_esx` plugin. Guest OS status. VMware tools status.
3299 ------------------------|--------------
3300 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. Conflicts with **vmware_host**.
3301 vmware_host | **Optional.** ESX or ESXi hostname. Conflicts with **vmware_datacenter**.
3302 vmware_vmname | **Required.** Virtual machine name.
3303 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
3304 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".
3305 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".
3306 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
3307 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
3308 vmware_sessionfile | **Optional.** Session file name enhancement.
3309 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
3310 vmware_nosession | **Optional.** No auth session - IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
3311 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
3312 vmware_password | **Optional.** The username's password. No value defined as default.
3313 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
3316 ## <a id="plugins-contrib-vmware-esx-soap-vm-runtime-issues"></a> vmware-esx-soap-vm-runtime-issues
3318 Check command object for the `check_vmware_esx` plugin. All issues for the virtual machine.
3323 ------------------------|--------------
3324 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. Conflicts with **vmware_host**.
3325 vmware_host | **Optional.** ESX or ESXi hostname. Conflicts with **vmware_datacenter**.
3326 vmware_vmname | **Required.** Virtual machine name.
3327 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
3328 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".
3329 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".
3330 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
3331 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
3332 vmware_sessionfile | **Optional.** Session file name enhancement.
3333 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
3334 vmware_nosession | **Optional.** No auth session - IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
3335 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
3336 vmware_password | **Optional.** The username's password. No value defined as default.
3337 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
3338 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.