1 # <a id="icinga-template-library"></a> Icinga Template Library
3 The Icinga Template Library (ITL) implements standard templates and object
4 definitions for commonly used services.
6 By default the ITL is included in the `icinga2.conf` configuration file:
10 ## <a id="itl-generic-templates"></a> Generic Templates
12 These templates are imported by the provided example configuration.
14 ### <a id="itl-plugin-check-command"></a> plugin-check-command
16 Command template for check plugins executed by Icinga 2.
18 The `plugin-check-command` command does not support any vars.
20 ### <a id="itl-plugin-notification-command"></a> plugin-notification-command
22 Command template for notification scripts executed by Icinga 2.
24 The `plugin-notification-command` command does not support any vars.
26 ### <a id="itl-plugin-event-command"></a> plugin-event-command
28 Command template for event handler scripts executed by Icinga 2.
30 The `plugin-event-command` command does not support any vars.
32 ## <a id="itl-check-commands"></a> Check Commands
34 These check commands are embedded into Icinga 2 and do not require any external
37 ### <a id="itl-icinga"></a> icinga
39 Check command for the built-in `icinga` check. This check returns performance
40 data for the current Icinga instance.
42 The `icinga` check command does not support any vars.
44 ### <a id="itl-icinga-cluster"></a> cluster
46 Check command for the built-in `cluster` check. This check returns performance
47 data for the current Icinga instance and connected endpoints.
49 The `cluster` check command does not support any vars.
51 ### <a id="itl-icinga-cluster-zone"></a> cluster-zone
53 Check command for the built-in `cluster-zone` check.
58 -------------|---------------
59 cluster_zone | **Optional.** The zone name. Defaults to "$host.name$".
61 ### <a id="itl-icinga-ido"></a> ido
63 Check command for the built-in `ido` check.
68 -------------|---------------
69 ido_type | **Required.** The type of the IDO connection object. Can be either "IdoMysqlConnection" or "IdoPgsqlConnection".
70 ido_name | **Required.** The name of the IDO connection object.
72 ### <a id="itl-random"></a> random
74 Check command for the built-in `random` check. This check returns random states
75 and adds the check source to the check output.
77 For test and demo purposes only. The `random` check command does not support
80 # <a id="plugin-check-commands"></a> Plugin Check Commands
82 The Plugin Check Commands provides example configuration for plugin check commands
83 provided by the Monitoring Plugins project.
85 By default the Plugin Check Commands are included in the `icinga2.conf` configuration
90 The plugin check commands assume that there's a global constant named `PluginDir`
91 which contains the path of the plugins from the Monitoring Plugins project.
93 ## <a id="plugin-check-command-apt"></a> apt
95 Check command for the `check_apt` plugin.
97 The `apt` check command does not support any vars.
100 ## <a id="plugin-check-command-by-ssh"></a> by_ssh
102 Check command object for the `check_by_ssh` plugin.
107 ----------------|--------------
108 by_ssh_address | **Optional.** The host's address. Defaults to "$address$" if the host's `address` attribute is set, "$address6$" otherwise.
109 by_ssh_port | **Optional.** The SSH port. Defaults to 22.
110 by_ssh_command | **Optional.** The command that should be executed.
111 by_ssh_logname | **Optional.** The SSH username.
112 by_ssh_identity | **Optional.** The SSH identity.
113 by_ssh_quiet | **Optional.** Whether to suppress SSH warnings. Defaults to false.
114 by_ssh_warn | **Optional.** The warning threshold.
115 by_ssh_crit | **Optional.** The critical threshold.
116 by_ssh_timeout | **Optional.** The timeout in seconds.
119 ## <a id="plugin-check-command-dhcp"></a> dhcp
121 Check command object for the `check_dhcp` plugin.
126 ----------------|--------------
127 dhcp_serverip | **Optional.** The IP address of the DHCP server which we should get a response from.
128 dhcp_requestedip| **Optional.** The IP address which we should be offered by a DHCP server.
129 dhcp_timeout | **Optional.** The timeout in seconds.
130 dhcp_interface | **Optional.** The interface to use.
131 dhcp_mac | **Optional.** The MAC address to use in the DHCP request.
132 dhcp_unicast | **Optional.** Whether to use unicast requests. Defaults to false.
135 ## <a id="plugin-check-command-dig"></a> dig
137 Check command object for the `check_dig` plugin.
142 ---------------------|--------------
143 dig_server | **Optional.** The DNS server to query. Defaults to "127.0.0.1".
144 dig_lookup | **Optional.** The address that should be looked up.
147 ## <a id="plugin-check-command-disk"></a> disk
149 Check command object for the `check_disk` plugin.
153 > `disk_wfree` and `disk_cfree` require the percent sign compared to older versions.
154 > If omitted, disk units can be used. This has been changed in **2.3.0**.
159 ------------------------|------------------------
160 disk_wfree | **Optional.** The free space warning threshold. Defaults to "20%". If the percent sign is omitted, units from `disk_units` are used.
161 disk_cfree | **Optional.** The free space critical threshold. Defaults to "10%". If the percent sign is omitted, units from `disk_units` are used.
162 disk_inode_wfree | **Optional.** The free inode warning threshold.
163 disk_inode_cfree | **Optional.** The free inode critical threshold.
164 disk_partition | **Optional.** The partition. **Deprecated in 2.3.**
165 disk_partition_excluded | **Optional.** The excluded partition. **Deprecated in 2.3.**
166 disk_partitions | **Optional.** The partition(s). Multiple partitions must be defined as array.
167 disk_partitions_excluded | **Optional.** The excluded partition(s). Multiple partitions must be defined as array.
168 disk_clear | **Optional.** Clear thresholds.
169 disk_exact_match | **Optional.** For paths or partitions specified with -p, only check for exact paths.
170 disk_errors_only | **Optional.** Display only devices/mountpoints with errors. May be true or false.
171 disk_group | **Optional.** Group paths. Thresholds apply to (free-)space of all partitions together
172 disk_kilobytes | **Optional.** Same as --units kB. May be true or false.
173 disk_local | **Optional.** Only check local filesystems. May be true or false.
174 disk_stat_remote_fs | **Optional.** Only check local filesystems against thresholds. Yet call stat on remote filesystems to test if they are accessible (e.g. to detect Stale NFS Handles). Myy be true or false
175 disk_mountpoint | **Optional.** Display the mountpoint instead of the partition. May be true or false.
176 disk_megabytes | **Optional.** Same as --units MB. May be true or false.
177 disk_all | **Optional.** Explicitly select all paths. This is equivalent to -R '.*'. May be true or false.
178 disk_eregi_path | **Optional.** Case insensitive regular expression for path/partition (may be repeated).
179 disk_ereg_path | **Optional.** Regular expression for path or partition (may be repeated).
180 disk_ignore_eregi_path | **Optional.** Regular expression to ignore selected path/partition (case insensitive) (may be repeated).
181 disk_ignore_ereg_path | **Optional.** Regular expression to ignore selected path or partition (may be repeated).
182 disk_timeout | **Optional.** Seconds before connection times out (default: 10).
183 disk_units | **Optional.** Choose bytes, kB, MB, GB, TB (default: MB).
184 disk_exclude_type | **Optional.** Ignore all filesystems of indicated type (may be repeated).
187 ## <a id="plugin-check-command-dns"></a> dns
189 Check command object for the `check_dns` plugin.
194 ---------------------|--------------
195 dns_lookup | **Optional.** The hostname or IP to query the DNS for. Defaults to "$host_name$".
196 dns_server | **Optional.** The DNS server to query. Defaults to the server configured in the OS.
197 dns_expected_answer | **Optional.** The answer to look for. A hostname must end with a dot. **Deprecated in 2.3.**
198 dns_expected_answers | **Optional.** The answer(s) to look for. A hostname must end with a dot. Multiple answers must be defined as array.
199 dns_authoritative | **Optional.** Expect the server to send an authoritative answer.
200 dns_wtime | **Optional.** Return warning if elapsed time exceeds value.
201 dns_ctime | **Optional.** Return critical if elapsed time exceeds value.
202 dns_timeout | **Optional.** Seconds before connection times out. Defaults to 10.
205 ## <a id="plugin-check-command-dummy"></a> dummy
207 Check command object for the `check_dummy` plugin.
212 ----------------|--------------
213 dummy_state | **Optional.** The state. Can be one of 0 (ok), 1 (warning), 2 (critical) and 3 (unknown). Defaults to 0.
214 dummy_text | **Optional.** Plugin output. Defaults to "Check was successful.".
217 ## <a id="plugin-check-command-fping4"></a> fping4
219 Check command object for the `check_fping` plugin.
224 ----------------|--------------
225 fping_address | **Optional.** The host's IPv4 address. Defaults to "$address$".
226 fping_wrta | **Optional.** The RTA warning threshold in milliseconds. Defaults to 100.
227 fping_wpl | **Optional.** The packet loss warning threshold in %. Defaults to 5.
228 fping_crta | **Optional.** The RTA critical threshold in milliseconds. Defaults to 200.
229 fping_cpl | **Optional.** The packet loss critical threshold in %. Defaults to 15.
230 fping_number | **Optional.** The number of packets to send. Defaults to 5.
231 fping_interval | **Optional.** The interval between packets in milli-seconds. Defaults to 500.
232 fping_bytes | **Optional.** The size of ICMP packet.
233 fping_target_timeout | **Optional.** The target timeout in milli-seconds.
234 fping_source_ip | **Optional.** The name or ip address of the source ip.
235 fping_source_interface | **Optional.** The source interface name.
238 ## <a id="plugin-check-command-fping6"></a> fping6
240 Check command object for the `check_fping` plugin.
245 ----------------|--------------
246 fping_address | **Optional.** The host's IPv6 address. Defaults to "$address6$".
247 fping_wrta | **Optional.** The RTA warning threshold in milliseconds. Defaults to 100.
248 fping_wpl | **Optional.** The packet loss warning threshold in %. Defaults to 5.
249 fping_crta | **Optional.** The RTA critical threshold in milliseconds. Defaults to 200.
250 fping_cpl | **Optional.** The packet loss critical threshold in %. Defaults to 15.
251 fping_number | **Optional.** The number of packets to send. Defaults to 5.
252 fping_interval | **Optional.** The interval between packets in milli-seconds. Defaults to 500.
253 fping_bytes | **Optional.** The size of ICMP packet.
254 fping_target_timeout | **Optional.** The target timeout in milli-seconds.
255 fping_source_ip | **Optional.** The name or ip address of the source ip.
256 fping_source_interface | **Optional.** The source interface name.
259 ## <a id="plugin-check-command-ftp"></a> ftp
261 Check command object for the `check_ftp` plugin.
266 -------------------|--------------
267 ftp_address | **Optional.** The host's address. Defaults to "$address$" if the host's `address` attribute is set, "$address6$" otherwise.
268 ftp_port | **Optional.** The FTP port number.
269 ftp_expect | **Optional.** String to expect in server response (may be repeated).
270 ftp_all | **Optional.** All expect strings need to occur in server response. Defaults to false.
271 ftp_escape_send | **Optional.** Enable usage of \n, \r, \t or \\\\ in send string.
272 ftp_send | **Optional.** String to send to the server.
273 ftp_escape_quit | **Optional.** Enable usage of \n, \r, \t or \\\\ in quit string.
274 ftp_quit | **Optional.** String to send server to initiate a clean close of the connection.
275 ftp_refuse | **Optional.** Accept TCP refusals with states ok, warn, crit. Defaults to crit.
276 ftp_mismatch | **Optional.** Accept expected string mismatches with states ok, warn, crit. Defaults to warn.
277 ftp_jail | **Optional.** Hide output from TCP socket.
278 ftp_maxbytes | **Optional.** Close connection once more than this number of bytes are received.
279 ftp_delay | **Optional.** Seconds to wait between sending string and polling for response.
280 ftp_certificate | **Optional.** Minimum number of days a certificate has to be valid. 1st value is number of days for warning, 2nd is critical (if not specified: 0) - seperated by comma.
281 ftp_ssl | **Optional.** Use SSL for the connection. Defaults to false.
282 ftp_wtime | **Optional.** Response time to result in warning status (seconds).
283 ftp_ctime | **Optional.** Response time to result in critical status (seconds).
284 ftp_timeout | **Optional.** Seconds before connection times out. Defaults to 10.
287 ## <a id="plugin-check-command-hostalive"></a> hostalive
289 Check command object for the `check_ping` plugin with host check default values. This variant
290 uses the host's `address` attribute if available and falls back to using the `address6` attribute
291 if the `address` attribute is not set.
296 ----------------|--------------
297 ping_address | **Optional.** The host's address. Defaults to "$address$" if the host's `address` attribute is set, "$address6$" otherwise.
298 ping_wrta | **Optional.** The RTA warning threshold in milliseconds. Defaults to 3000.
299 ping_wpl | **Optional.** The packet loss warning threshold in %. Defaults to 80.
300 ping_crta | **Optional.** The RTA critical threshold in milliseconds. Defaults to 5000.
301 ping_cpl | **Optional.** The packet loss critical threshold in %. Defaults to 100.
302 ping_packets | **Optional.** The number of packets to send. Defaults to 5.
303 ping_timeout | **Optional.** The plugin timeout in seconds. Defaults to 0 (no timeout).
306 ## <a id="plugin-check-command-hostalive4"></a> hostalive4
308 Check command object for the `check_ping` plugin with host check default values. This variant
309 uses the host's `address` attribute.
314 ----------------|--------------
315 ping_address | **Optional.** The host's IPv4 address. Defaults to "$address$".
316 ping_wrta | **Optional.** The RTA warning threshold in milliseconds. Defaults to 3000.
317 ping_wpl | **Optional.** The packet loss warning threshold in %. Defaults to 80.
318 ping_crta | **Optional.** The RTA critical threshold in milliseconds. Defaults to 5000.
319 ping_cpl | **Optional.** The packet loss critical threshold in %. Defaults to 100.
320 ping_packets | **Optional.** The number of packets to send. Defaults to 5.
321 ping_timeout | **Optional.** The plugin timeout in seconds. Defaults to 0 (no timeout).
324 ## <a id="plugin-check-command-hostalive6"></a> hostalive6
326 Check command object for the `check_ping` plugin with host check default values. This variant
327 uses the host's `address6` attribute.
332 ----------------|--------------
333 ping_address | **Optional.** The host's IPv6 address. Defaults to "$address6$".
334 ping_wrta | **Optional.** The RTA warning threshold in milliseconds. Defaults to 3000.
335 ping_wpl | **Optional.** The packet loss warning threshold in %. Defaults to 80.
336 ping_crta | **Optional.** The RTA critical threshold in milliseconds. Defaults to 5000.
337 ping_cpl | **Optional.** The packet loss critical threshold in %. Defaults to 100.
338 ping_packets | **Optional.** The number of packets to send. Defaults to 5.
339 ping_timeout | **Optional.** The plugin timeout in seconds. Defaults to 0 (no timeout).
342 ## <a id="plugin-check-command-hpjd"></a> hpjd
344 Check command object for the `check_hpjd` plugin.
349 ----------------|--------------
350 hpjd_address | **Optional.** The host's address. Defaults to "$address$" if the host's `address` attribute is set, "$address6$" otherwise.
351 hpjd_port | **Optional.** The host's SNMP port. Defaults to 161.
352 hpjd_community | **Optional.** The SNMP community. Defaults to "public".
355 ## <a id="plugin-check-command-http"></a> http
357 Check command object for the `check_http` plugin.
362 -------------------------|--------------
363 http_address | **Optional.** The host's address. Defaults to "$address$" if the host's `address` attribute is set, "$address6$" otherwise.
364 http_vhost | **Optional.** The virtual host that should be sent in the "Host" header.
365 http_uri | **Optional.** The request URI.
366 http_port | **Optional.** The TCP port. Defaults to 80 when not using SSL, 443 otherwise.
367 http_ssl | **Optional.** Whether to use SSL. Defaults to false.
368 http_sni | **Optional.** Whether to use SNI. Defaults to false.
369 http_auth_pair | **Optional.** Add 'username:password' authorization pair.
370 http_proxy_auth_pair | **Optional.** Add 'username:password' authorization pair for proxy.
371 http_ignore_body | **Optional.** Don't download the body, just the headers.
372 http_linespan | **Optional.** Allow regex to span newline.
373 http_expect_body_regex | **Optional.** A regular expression which the body must match against. Incompatible with http_ignore_body.
374 http_expect_body_eregi | **Optional.** A case-insensitive expression which the body must match against. Incompatible with http_ignore_body.
375 http_invertregex | **Optional.** Changes behaviour of http_expect_body_regex and http_expect_body_eregi to return CRITICAL if found, OK if not.
376 http_warn_time | **Optional.** The warning threshold.
377 http_critical_time | **Optional.** The critical threshold.
378 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.
379 http_certificate | **Optional.** Minimum number of days a certificate has to be valid. Port defaults to 443.
380 http_clientcert | **Optional.** Name of file contains the client certificate (PEM format).
381 http_privatekey | **Optional.** Name of file contains the private key (PEM format).
382 http_headerstring | **Optional.** String to expect in the response headers.
383 http_string | **Optional.** String to expect in the content.
384 http_post | **Optional.** URL encoded http POST data.
385 http_method | **Optional.** Set http method (for example: HEAD, OPTIONS, TRACE, PUT, DELETE).
386 http_maxage | **Optional.** Warn if document is more than seconds old.
387 http_contenttype | **Optional.** Specify Content-Type header when POSTing.
388 http_useragent | **Optional.** String to be sent in http header as User Agent.
389 http_header | **Optional.** Any other tags to be sent in http header.
390 http_extendedperfdata | **Optional.** Print additional perfdata. Defaults to false.
391 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)
392 http_pagesize | **Optional.** Minimum page size required:Maximum page size required.
393 http_timeout | **Optional.** Seconds before connection times out.
396 ## <a id="plugin-check-command-icmp"></a> icmp
398 Check command object for the `check_icmp` plugin.
403 ----------------|--------------
404 icmp_address | **Optional.** The host's address. This can either be a single address or an array of addresses. Defaults to "$address$".
405 icmp_wrta | **Optional.** The RTA warning threshold in milliseconds. Defaults to 100.
406 icmp_wpl | **Optional.** The packet loss warning threshold in %. Defaults to 5.
407 icmp_crta | **Optional.** The RTA critical threshold in milliseconds. Defaults to 200.
408 icmp_cpl | **Optional.** The packet loss critical threshold in %. Defaults to 15.
409 icmp_source | **Optional.** The source IP address to send packets from.
410 icmp_packets | **Optional.** The number of packets to send. Defaults to 5.
411 icmp_packet_interval | **Optional** The maximum packet interval. Defaults to 80 (milliseconds).
412 icmp_target_interval | **Optional.** The maximum target interval.
413 icmp_hosts_alive | **Optional.** The number of hosts which have to be alive for the check to succeed.
414 icmp_data_bytes | **Optional.** Payload size for each ICMP request. Defaults to 8.
415 icmp_timeout | **Optional.** The plugin timeout in seconds. Defaults to 10 (seconds).
418 ## <a id="plugin-check-command-imap"></a> imap
420 Check command object for the `check_imap` plugin.
425 ----------------|--------------
426 imap_address | **Optional.** The host's address. Defaults to "$address$" if the host's `address` attribute is set, "$address6$" otherwise.
427 imap_port | **Optional.** The port that should be checked. Defaults to 143.
430 ## <a id="plugin-check-command-load"></a> load
432 Check command object for the `check_load` plugin.
437 ----------------|--------------
438 load_wload1 | **Optional.** The 1-minute warning threshold. Defaults to 5.
439 load_wload5 | **Optional.** The 5-minute warning threshold. Defaults to 4.
440 load_wload15 | **Optional.** The 15-minute warning threshold. Defaults to 3.
441 load_cload1 | **Optional.** The 1-minute critical threshold. Defaults to 10.
442 load_cload5 | **Optional.** The 5-minute critical threshold. Defaults to 6.
443 load_cload15 | **Optional.** The 15-minute critical threshold. Defaults to 4.
446 ## <a id="plugin-check-command-nrpe"></a> nrpe
448 Check command object for the `check_nrpe` plugin.
453 ----------------|--------------
454 nrpe_address | **Optional.** The host's address. Defaults to "$address$" if the host's `address` attribute is set, "$address6$" otherwise.
455 nrpe_port | **Optional.** The NRPE port. Defaults to 5668.
456 nrpe_command | **Optional.** The command that should be executed.
457 nrpe_no_ssl | **Optional.** Whether to disable SSL or not. Defaults to `false`.
458 nrpe_timeout_unknown | **Optional.** Whether to set timeouts to unknown instead of critical state. Defaults to `false`.
459 nrpe_timeout | **Optional.** The timeout in seconds.
460 nrpe_arguments | **Optional.** Arguments that should be passed to the command. Multiple arguments must be defined as array.
463 ## <a id="plugin-check-command-nscp"></a> nscp
465 Check command object for the `check_nt` plugin.
470 ----------------|--------------
471 nscp_address | **Optional.** The host's address. Defaults to "$address$" if the host's `address` attribute is set, "$address6$" otherwise.
472 nscp_port | **Optional.** The NSClient++ port. Defaults to 12489.
473 nscp_password | **Optional.** The NSClient++ password.
474 nscp_variable | **Required.** The variable that should be checked.
475 nscp_params | **Optional.** Parameters for the query. Multiple parameters must be defined as array.
476 nscp_warn | **Optional.** The warning threshold.
477 nscp_crit | **Optional.** The critical threshold.
478 nscp_timeout | **Optional.** The query timeout in seconds.
479 nscp_showall | **Optional.** Use with SERVICESTATE to see working services or PROCSTATE for running processes. Defaults to false.
482 ## <a id="plugin-check-command-ntp-time"></a> ntp_time
484 Check command object for the `check_ntp_time` plugin.
489 ----------------|--------------
490 ntp_address | **Optional.** The host's address. Defaults to "$address$" if the host's `address` attribute is set, "$address6$" otherwise.
493 ## <a id="plugin-check-command-passive"></a> passive
495 Specialised check command object for passive checks executing the `check_dummy` plugin with appropriate default values.
500 ----------------|--------------
501 dummy_state | **Optional.** The state. Can be one of 0 (ok), 1 (warning), 2 (critical) and 3 (unknown). Defaults to 3.
502 dummy_text | **Optional.** Plugin output. Defaults to "No Passive Check Result Received.".
505 ## <a id="plugin-check-command-ping"></a> ping
507 Check command object for the `check_ping` plugin. This command uses the host's `address` attribute
508 if available and falls back to using the `address6` attribute if the `address` attribute is not set.
514 ----------------|--------------
515 ping_address | **Optional.** The host's address. Defaults to "$address$" if the host's `address` attribute is set, "$address6$" otherwise.
516 ping_wrta | **Optional.** The RTA warning threshold in milliseconds. Defaults to 100.
517 ping_wpl | **Optional.** The packet loss warning threshold in %. Defaults to 5.
518 ping_crta | **Optional.** The RTA critical threshold in milliseconds. Defaults to 200.
519 ping_cpl | **Optional.** The packet loss critical threshold in %. Defaults to 15.
520 ping_packets | **Optional.** The number of packets to send. Defaults to 5.
521 ping_timeout | **Optional.** The plugin timeout in seconds. Defaults to 0 (no timeout).
524 ## <a id="plugin-check-command-ping4"></a> ping4
526 Check command object for the `check_ping` plugin.
531 ----------------|--------------
532 ping_address | **Optional.** The host's IPv4 address. Defaults to "$address$".
533 ping_wrta | **Optional.** The RTA warning threshold in milliseconds. Defaults to 100.
534 ping_wpl | **Optional.** The packet loss warning threshold in %. Defaults to 5.
535 ping_crta | **Optional.** The RTA critical threshold in milliseconds. Defaults to 200.
536 ping_cpl | **Optional.** The packet loss critical threshold in %. Defaults to 15.
537 ping_packets | **Optional.** The number of packets to send. Defaults to 5.
538 ping_timeout | **Optional.** The plugin timeout in seconds. Defaults to 0 (no timeout).
540 ## <a id="plugin-check-command-ping6"></a> ping6
542 Check command object for the `check_ping` plugin.
547 ----------------|--------------
548 ping_address | **Optional.** The host's IPv6 address. Defaults to "$address6$".
549 ping_wrta | **Optional.** The RTA warning threshold in milliseconds. Defaults to 100.
550 ping_wpl | **Optional.** The packet loss warning threshold in %. Defaults to 5.
551 ping_crta | **Optional.** The RTA critical threshold in milliseconds. Defaults to 200.
552 ping_cpl | **Optional.** The packet loss critical threshold in %. Defaults to 15.
553 ping_packets | **Optional.** The number of packets to send. Defaults to 5.
554 ping_timeout | **Optional.** The plugin timeout in seconds. Defaults to 0 (no timeout).
557 ## <a id="plugin-check-command-pop"></a> pop
559 Check command object for the `check_pop` plugin.
564 ----------------|--------------
565 pop_address | **Optional.** The host's address. Defaults to "$address$" if the host's `address` attribute is set, "$address6$" otherwise.
566 pop_port | **Optional.** The port that should be checked. Defaults to 110.
569 ## <a id="plugin-check-command-processes"></a> procs
571 Check command object for the `check_procs` plugin.
576 ---------------------|--------------
577 procs_warning | **Optional.** The process count warning threshold. Defaults to 250.
578 procs_critical | **Optional.** The process count critical threshold. Defaults to 400.
579 procs_metric | **Optional.** Check thresholds against metric.
580 procs_timeout | **Optional.** Seconds before plugin times out.
581 procs_traditional | **Optional.** Filter own process the traditional way by PID instead of /proc/pid/exe. Defaults to false.
582 procs_state | **Optional.** Only scan for processes that have one or more of the status flags you specify.
583 procs_ppid | **Optional.** Only scan for children of the parent process ID indicated.
584 procs_vsz | **Optional.** Only scan for processes with VSZ higher than indicated.
585 procs_rss | **Optional.** Only scan for processes with RSS higher than indicated.
586 procs_pcpu | **Optional.** Only scan for processes with PCPU higher than indicated.
587 procs_user | **Optional.** Only scan for processes with user name or ID indicated.
588 procs_argument | **Optional.** Only scan for processes with args that contain STRING.
589 procs_argument_regex | **Optional.** Only scan for processes with args that contain the regex STRING.
590 procs_command | **Optional.** Only scan for exact matches of COMMAND (without path).
591 procs_nokthreads | **Optional.** Only scan for non kernel threads. Defaults to false.
594 ## <a id="plugin-check-command-running-kernel"></a> running_kernel
596 Check command object for the `check_running_kernel` plugin
597 provided by the `nagios-plugins-contrib` package on Debian.
599 The `running_kernel` check command does not support any vars.
602 ## <a id="plugin-check-command-simap"></a> simap
604 Check command object for the `check_simap` plugin.
609 ----------------|--------------
610 simap_address | **Optional.** The host's address. Defaults to "$address$" if the host's `address` attribute is set, "$address6$" otherwise.
611 simap_port | **Optional.** The host's port.
614 ## <a id="plugin-check-command-smtp"></a> smtp
616 Check command object for the `check_smtp` plugin.
621 ---------------------|--------------
622 smtp_address | **Optional.** The host's address. Defaults to "$address$" if the host's `address` attribute is set, "$address6$" otherwise.
623 smtp_port | **Optional.** The port that should be checked. Defaults to 25.
624 smtp_mail_from | **Optional.** Test a MAIL FROM command with the given email address.
627 ## <a id="plugin-check-command-snmp"></a> snmp
629 Check command object for the `check_snmp` plugin.
634 --------------------|--------------
635 snmp_address | **Optional.** The host's address. Defaults to "$address$" if the host's `address` attribute is set, "$address6$" otherwise.
636 snmp_oid | **Required.** The SNMP OID.
637 snmp_community | **Optional.** The SNMP community. Defaults to "public".
638 snmp_warn | **Optional.** The warning threshold.
639 snmp_crit | **Optional.** The critical threshold.
640 snmp_string | **Optional.** Return OK state if the string matches exactly with the output value
641 snmp_ereg | **Optional.** Return OK state if extended regular expression REGEX matches with the output value
642 snmp_eregi | **Optional.** Return OK state if case-insensitive extended REGEX matches with the output value
643 snmp_label | **Optional.** Prefix label for output value
644 snmp_invert_search | **Optional.** Invert search result and return CRITICAL state if found
645 snmp_units | **Optional.** Units label(s) for output value (e.g., 'sec.').
646 snmp_version | **Optional.** Version to use. E.g. 1, 2, 2c or 3.
647 snmp_miblist | **Optional.** MIB's to use, comma separated. Defaults to "ALL".
648 snmp_rate_multiplier | **Optional.** Converts rate per second. For example, set to 60 to convert to per minute.
649 snmp_rate | **Optional.** Boolean. Enable rate calculation.
650 snmp_getnext | **Optional.** Boolean. Use SNMP GETNEXT. Defaults to false.
651 snmp_timeout | **Optional.** The command timeout in seconds. Defaults to 10 seconds.
653 ## <a id="plugin-check-command-snmpv3"></a> snmpv3
655 Check command object for the `check_snmp` plugin, using SNMPv3 authentication and encryption options.
660 ------------------|--------------
661 snmpv3_address | **Optional.** The host's address. Defaults to "$address$" if the host's `address` attribute is set, "$address6$" otherwise.
662 snmpv3_user | **Required.** The username to log in with.
663 snmpv3_auth_alg | **Optional.** The authentication algorithm. Defaults to SHA.
664 snmpv3_auth_key | **Required.** The authentication key.
665 snmpv3_priv_alg | **Optional.** The encryption algorithm. Defaults to AES.
666 snmpv3_priv_key | **Required.** The encryption key.
667 snmpv3_oid | **Required.** The SNMP OID.
668 snmpv3_warn | **Optional.** The warning threshold.
669 snmpv3_crit | **Optional.** The critical threshold.
670 snmpv3_label | **Optional.** Prefix label for output value.
672 ## <a id="plugin-check-command-snmp-uptime"></a> snmp-uptime
674 Check command object for the `check_snmp` plugin.
679 ----------------|--------------
680 snmp_address | **Optional.** The host's address. Defaults to "$address$" if the host's `address` attribute is set, "$address6$" otherwise.
681 snmp_oid | **Optional.** The SNMP OID. Defaults to "1.3.6.1.2.1.1.3.0".
682 snmp_community | **Optional.** The SNMP community. Defaults to "public".
685 ## <a id="plugin-check-command-spop"></a> spop
687 Check command object for the `check_spop` plugin.
692 ----------------|--------------
693 spop_address | **Optional.** The host's address. Defaults to "$address$" if the host's `address` attribute is set, "$address6$" otherwise.
694 spop_port | **Optional.** The host's port.
697 ## <a id="plugin-check-command-ssh"></a> ssh
699 Check command object for the `check_ssh` plugin.
704 ----------------|--------------
705 ssh_address | **Optional.** The host's address. Defaults to "$address$" if the host's `address` attribute is set, "$address6$" otherwise.
706 ssh_port | **Optional.** The port that should be checked. Defaults to 22.
707 ssh_timeout | **Optional.** Seconds before connection times out. Defaults to 10.
710 ## <a id="plugin-check-command-ssl"></a> ssl
712 Check command object for the `check_tcp` plugin, using ssl-related options.
717 ------------------------------|--------------
718 ssl_address | **Optional.** The host's address. Defaults to "$address$" if the host's `address` attribute is set, "$address6$" otherwise.
719 ssl_port | **Required.** The port that should be checked.
720 ssl_timeout | **Optional.** Timeout in seconds for the connect and handshake. The plugin default is 10 seconds.
721 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.
722 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.
725 ## <a id="plugin-check-command-ssmtp"></a> ssmtp
727 Check command object for the `check_ssmtp` plugin.
732 ----------------|--------------
733 ssmtp_address | **Required.** The host's address. Defaults to "$address$" if the host's `address` attribute is set, "$address6$" otherwise.
734 ssmtp_port | **Optional.** The port that should be checked. Defaults to 465.
737 ## <a id="plugin-check-command-swap"></a> swap
739 Check command object for the `check_swap` plugin.
744 ----------------|--------------
745 swap_wfree | **Optional.** The free swap space warning threshold in %. Defaults to 50.
746 swap_cfree | **Optional.** The free swap space critical threshold in %. Defaults to 25.
749 ## <a id="plugin-check-command-tcp"></a> tcp
751 Check command object for the `check_tcp` plugin.
756 ----------------|--------------
757 tcp_address | **Optional.** The host's address. Defaults to "$address$" if the host's `address` attribute is set, "$address6$" otherwise.
758 tcp_port | **Required.** The port that should be checked.
761 ## <a id="plugin-check-command-udp"></a> udp
763 Check command object for the `check_udp` plugin.
768 ----------------|--------------
769 udp_address | **Optional.** The host's address. Defaults to "$address$" if the host's `address` attribute is set, "$address6$" otherwise.
770 udp_port | **Required.** The port that should be checked.
771 udp_send | **Required.** The payload to send in the UDP datagram.
772 udp_expect | **Required.** The payload to expect in the response datagram.
773 udp_quit | **Optional.** The payload to send to 'close' the session.
776 ## <a id="plugin-check-command-ups"></a> ups
778 Check command object for the `check_ups` plugin.
783 ----------------|--------------
784 ups_address | **Required.** The address of the host running upsd. Defaults to "$address$" if the host's `address` attribute is set, "$address6$" otherwise.
785 ups_name | **Required.** The UPS name. Defaults to `ups`.
786 ups_port | **Optional.** The port to which to connect. Defaults to 3493.
787 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`.
788 ups_warning | **Optional.** The warning threshold for the selected variable.
789 ups_critical | **Optional.** The critical threshold for the selected variable.
790 ups_celsius | **Optional.** Display the temperature in degrees Celsius instead of Fahrenheit. Defaults to `false`.
791 ups_timeout | **Optional.** The number of seconds before the connection times out. Defaults to 10.
794 ## <a id="plugin-check-command-users"></a> users
796 Check command object for the `check_users` plugin.
801 ----------------|--------------
802 users_wgreater | **Optional.** The user count warning threshold. Defaults to 20.
803 users_cgreater | **Optional.** The user count critical threshold. Defaults to 50.
806 # <a id="windows-plugins"></a>Icinga 2 Windows plugins
808 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.
810 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:
812 include <windows-plugins>
814 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.
817 ## <a id"windows-plugins-thresholds"></a>Threshold syntax
819 So not specified differently the thresholds for the plugins all follow the same pattern
822 :------------|:----------
823 "29" | The threshold is 29.
824 "!29" | The threshold is 29, but the negative of the result is returned.
825 "[10-40]" | The threshold is a range from (including) 20 to 40, a value inside means the threshold has been exceeded.
826 "![10-40]" | Same as above, but the result is inverted.
829 ## <a id="windows-plugins-disk-windows"></a>disk-windows
831 Check command object for the `check_disk.exe` plugin.
832 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.).
837 :---------------|:------------
838 disk\_win\_warn | **Optional**. The warning threshold.
839 disk\_win\_crit | **Optional**. The critical threshold.
840 disk\_win\_path | **Optional**. Check only these paths, default checks all.
841 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.
844 ## <a id="windows-plugins-load-windows"></a>load-windows
846 Check command object for the `check_load.exe` plugin.
847 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).
852 :---------------|:------------
853 load\_win\_warn | **Optional**. The warning threshold.
854 load\_win\_crit | **Optional**. The critical threshold.
857 ## <a id="windows-plugins-memory-windows"></a>memory-windows
859 Check command object for the `check_memory.exe` plugin.
860 The memory collection is instant.
865 :-----------------|:------------
866 memory\_win\_warn | **Optional**. The warning threshold.
867 memory\_win\_crit | **Optional**. The critical threshold.
868 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.
871 ## <a id="windows-plugins-network-windows"></a>network-windows
873 Check command object for the `check_network.exe` plugin.
874 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).
879 :------------------|:------------
880 network\_win\_warn | **Optional**. The warning threshold.
881 network\_win\_crit | **Optional**. The critical threshold.
884 ## <a id="windows-plugins-permon-windows"></a>perfmon-windows
886 Check command object for the `check_perfmon.exe` plugin.
887 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`.
889 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"`
894 :---------------------|:------------
895 perfmon\_win\_warn | **Optional**. The warning threshold.
896 perfmon\_win\_crit | **Optional**. The critical threshold.
897 perfmon\_win\_counter | **Required**. The Performance Counter to use. Ex. `\Processor(_Total)\% Idle Time`.
898 perfmon\_win\_wait | **Optional**. Time in milliseconds to wait between data collection (default: 1000).
899 perfmon\_win\_type | **Optional**. Format in which to expect perfomance values. Possible are: long, int64 and double (default).
902 ## <a id="windows-plugins-ping-windows"></a>ping-windows
904 Check command object for the `check_ping.exe` plugin.
905 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.
910 :------------------|:------------
911 ping\_win\_warn | **Optional**. The warning threshold. RTA and package loss seperated by comma.
912 ping\_win\_crit | **Optional**. The critical threshold. RTA and package loss seperated by comma.
913 ping\_win\_address | **Required**. An IPv4 or IPv6 address
914 ping\_win\_packets | **Optional**. Number of packages to send. Default: 5.
915 ping\_win\_timeout | **Optional**. The timeout in milliseconds. Default: 1000
918 ## <a id="windows-plugins-procs-windows"></a>procs-windows
920 Check command object for `check_procs.exe` plugin.
921 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.
926 :----------------|:------------
927 procs\_win\_warn | **Optional**. The warning threshold.
928 procs\_win\_crit | **Optional**. The critical threshold.
929 procs\_win\_user | **Optional**. Count this useres processes.
932 ## <a id="windows-plugins-service-windows"></a>service-windows
934 Check command object for `check_service.exe` plugin.
935 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.
940 :---------------------|:------------
941 service\_win\_warn | **Optional**. Warn when service is not running.
942 service\_win\_service | **Required**. The critical threshold.
945 ## <a id="windows-plugins-swap-windows"></a>swap-windows
947 Check command object for `check_swap.exe` plugin.
948 The data collection is instant.
953 :---------------|:------------
954 swap\_win\_warn | **Optional**. The warning threshold.
955 swap\_win\_crit | **Optional**. The critical threshold.
956 swap\_win\_unit | **Optional**. The unit to display the received value in, thresholds are interpreted in this unit. Defaults to "mb" (megabyte).
959 ## <a id="windows-plugins-update-windows"></a>update-windows
961 Check command object for `check_update.exe` plugin.
962 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.
967 :-------------------|:------------
968 update\_win\_warn | If set returns warning when important updates are available
969 update\_win\_crit | If set return critical when important updates that require a reboot are available.
970 update\_win\_reboot | Set to treat 'may need update' as 'definitely needs update'
973 ## <a id="windows-plugins-uptime-windows"></a>uptime-windows
975 Check command opject for `check_uptime.exe` plugin.
976 Uses GetTickCount64 to get the uptime, so boot time is not included.
981 :-----------------|:------------
982 uptime\_win\_warn | **Optional**. The warning threshold.
983 uptime\_win\_crit | **Optional**. The critical threshold.
984 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).
987 ## <a id="windows-plugins-users-windows"></a>users-windows
989 Check command object for `check_users.exe` plugin.
994 :----------------|:------------
995 users\_win\_warn | **Optional**. The warning threshold.
996 users\_win\_crit | **Optional**. The critical threshold.
999 # <a id="nscp-plugin-check-commands"></a> NSClient++ Check Commands
1001 Icinga 2 can use the `nscp client` command to run arbitrary NSClient++ checks.
1003 You can enable these check commands by adding the following the include directive in your
1004 [icinga2.conf](5-configuring-icinga-2.md#icinga2-conf) configuration file:
1008 You can also optionally specify an alternative installation directory for NSClient++ by adding
1009 the NscpPath constant in your [constants.conf](5-configuring-icinga-2.md#constants-conf) configuration
1012 const NscpPath = "C:\\Program Files (x86)\\NSClient++"
1014 By default the check commands assume that NSClient++ is installed in "C:\Program Files\NSClient++".
1016 Note that it is not necessary to run NSClient++ as a Windows service for these commands to work.
1018 ## <a id="nscp-check-local"></a> nscp-local
1020 Check command object for NSClient++
1025 ----------------|--------------
1026 nscp_path | **Optional.** Can be used to override the NSClient++ on a per-command basis. Defaults to NscpPath.
1027 nscp_boot | **Optional.** Whether to use the --boot option. Defaults to true.
1028 nscp_query | **Required.** The NSClient++ query. Try `nscp client -q x` for a list.
1029 nscp_arguments | **Optional.** An array of query arguments.
1031 ## <a id="nscp-check-local-cpu"></a> nscp-local-cpu
1033 Check command object for the `check_cpu` NSClient++ plugin.
1035 This command has the same custom attributes like the `nscp-local` check command.
1037 ## <a id="nscp-check-local-memory"></a> nscp-local-memory
1039 Check command object for the `check_memory` NSClient++ plugin.
1041 This command has the same custom attributes like the `nscp-local` check command.
1043 ## <a id="nscp-check-local-os-version"></a> nscp-local-os-version
1045 Check command object for the `check_os_version` NSClient++ plugin.
1047 This command has the same custom attributes like the `nscp-local` check command.
1049 ## <a id="nscp-check-local-pagefile"></a> nscp-local-pagefile
1051 Check command object for the `check_pagefile` NSClient++ plugin.
1053 This command has the same custom attributes like the `nscp-local` check command.
1055 ## <a id="nscp-check-local-process"></a> nscp-local-process
1057 Check command object for the `check_process` NSClient++ plugin.
1059 This command has the same custom attributes like the `nscp-local` check command.
1061 ## <a id="nscp-check-local-service"></a> nscp-local-service
1063 Check command object for the `check_service` NSClient++ plugin.
1065 This command has the same custom attributes like the `nscp-local` check command.
1067 ## <a id="nscp-check-local-uptime"></a> nscp-local-uptime
1069 Check command object for the `check_uptime` NSClient++ plugin.
1071 This command has the same custom attributes like the `nscp-local` check command.
1073 ## <a id="nscp-check-local-version"></a> nscp-local-version
1075 Check command object for the `check_version` NSClient++ plugin.
1077 This command has the same custom attributes like the `nscp-local` check command.
1079 ## <a id="nscp-check-local-disk"></a> nscp-local-disk
1081 Check command object for the `check_drivesize` NSClient++ plugin.
1083 This command has the same custom attributes like the `nscp-local` check command.
1085 # <a id="snmp-manubulon-plugin-check-commands"></a> SNMP Manubulon Plugin Check Commands
1087 The `SNMP Manubulon Plugin Check Commands` provide example configuration for plugin check
1088 commands provided by the [SNMP Manubulon project](http://nagios.manubulon.com/index_snmp.html).
1090 The SNMP manubulon plugin check commands assume that the global constant named `ManubulonPluginDir`
1091 is set to the path where the Manubublon SNMP plugins are installed.
1093 You can enable these plugin check commands by adding the following the include directive in your
1094 [icinga2.conf](5-configuring-icinga-2.md#icinga2-conf) configuration file:
1098 ## Checks by Host Type
1100 **N/A** : Not available for this type.
1102 **SNMP** : Available for simple SNMP query.
1106 **Specific** : Script name for platform specific checks.
1109 Host type | Interface | storage | load/cpu | mem | process | env | specific
1110 ------------------------|------------|----------|-----------|-----|----------|-----|-------------------------
1111 Linux | Yes | Yes | Yes | Yes | Yes | No |
1112 Windows | Yes | Yes | Yes | Yes | Yes | No | check_snmp_win.pl
1113 Cisco router/switch | Yes | N/A | Yes | Yes | N/A | Yes |
1114 HP router/switch | Yes | N/A | Yes | Yes | N/A | No |
1115 Bluecoat proxy | Yes | SNMP | Yes | SNMP| No | Yes |
1116 CheckPoint on SPLAT | Yes | Yes | Yes | Yes | Yes | No | check_snmp_cpfw.pl
1117 CheckPoint on Nokia IP | Yes | Yes | Yes | No | ?? | No | check_snmp_vrrp.pl
1118 Boostedge | Yes | Yes | Yes | Yes | ?? | No | check_snmp_boostedge.pl
1119 AS400 | Yes | Yes | Yes | Yes | No | No |
1120 NetsecureOne Netbox | Yes | Yes | Yes | ?? | Yes | No |
1121 Radware Linkproof | Yes | N/A | SNMP | SNMP| No | No | check_snmp_linkproof_nhr <br> check_snmp_vrrp.pl
1122 IronPort | Yes | SNMP | SNMP | SNMP| No | Yes |
1123 Cisco CSS | Yes | ?? | Yes | Yes | No | ?? | check_snmp_css.pl
1126 ## <a id="plugin-check-command-snmp-load"></a> snmp-load
1128 Check command object for the [check_snmp_load.pl](http://nagios.manubulon.com/snmp_load.html) plugin.
1134 ------------------------|--------------
1135 snmp_address | **Optional.** The host's address. Defaults to "$address$" if the host's `address` attribute is set, "$address6$" otherwise.
1136 snmp_nocrypt | **Optional.** Define SNMP encryption. If set **snmp_v3** needs to be set. Defaults to false.
1137 snmp_community | **Optional.** The SNMP community. Defaults to "public".
1138 snmp_port | **Optional.** The SNMP port connection.
1139 snmp_v2 | **Optional.** SNMP version to 2c. Defaults to false.
1140 snmp_v3 | **Optional.** SNMP version to 3. Defaults to false.
1141 snmp_login | **Optional.** SNMP version 3 username. Defaults to "snmpuser".
1142 snmp_password | **Required.** SNMP version 3 password. No value defined as default.
1143 snmp_v3_use_privpass | **Optional.** Define to use SNMP version 3 priv password. Defaults to false.
1144 snmp_authprotocol | **Optional.** SNMP version 3 authentication protocol. Defaults to "md5,des".
1145 snmp_privpass | **Required.** SNMP version 3 priv password. No value defined as default.
1146 snmp_warn | **Optional.** The warning threshold. Change the `snmp_load_type` var to "netsl" for using 3 values.
1147 snmp_crit | **Optional.** The critical threshold. Change the `snmp_load_type` var to "netsl" for using 3 values.
1148 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.
1149 snmp_perf | **Optional.** Enable perfdata values. Defaults to true.
1150 snmp_timeout | **Optional.** The command timeout in seconds. Defaults to 5 seconds.
1152 ## <a id="plugin-check-command-snmp-memory"></a> snmp-memory
1154 Check command object for the [check_snmp_mem.pl](http://nagios.manubulon.com/snmp_mem.html) plugin.
1159 ------------------------|--------------
1160 snmp_address | **Optional.** The host's address. Defaults to "$address$" if the host's `address` attribute is set, "$address6$" otherwise.
1161 snmp_nocrypt | **Optional.** Define SNMP encryption. If set **snmp_v3** needs to be set. Defaults to false.
1162 snmp_community | **Optional.** The SNMP community. Defaults to "public".
1163 snmp_port | **Optional.** The SNMP port connection.
1164 snmp_v2 | **Optional.** SNMP version to 2c. Defaults to false.
1165 snmp_v3 | **Optional.** SNMP version to 3. Defaults to false.
1166 snmp_login | **Optional.** SNMP version 3 username. Defaults to "snmpuser".
1167 snmp_password | **Required.** SNMP version 3 password. No value defined as default.
1168 snmp_v3_use_privpass | **Optional.** Define to use SNMP version 3 priv password. Defaults to false.
1169 snmp_authprotocol | **Optional.** SNMP version 3 authentication protocol. Defaults to "md5,des".
1170 snmp_privpass | **Required.** SNMP version 3 priv password. No value defined as default.
1171 snmp_warn | **Optional.** The warning threshold.
1172 snmp_crit | **Optional.** The critical threshold.
1173 snmp_perf | **Optional.** Enable perfdata values. Defaults to true.
1174 snmp_timeout | **Optional.** The command timeout in seconds. Defaults to 5 seconds.
1176 ## <a id="plugin-check-command-snmp-storage"></a> snmp-storage
1178 Check command object for the [check_snmp_storage.pl](http://nagios.manubulon.com/snmp_storage.html) plugin.
1183 ------------------------|--------------
1184 snmp_address | **Optional.** The host's address. Defaults to "$address$" if the host's `address` attribute is set, "$address6$" otherwise.
1185 snmp_nocrypt | **Optional.** Define SNMP encryption. If set **snmp_v3** needs to be set. Defaults to false.
1186 snmp_community | **Optional.** The SNMP community. Defaults to "public".
1187 snmp_port | **Optional.** The SNMP port connection.
1188 snmp_v2 | **Optional.** SNMP version to 2c. Defaults to false.
1189 snmp_v3 | **Optional.** SNMP version to 3. Defaults to false.
1190 snmp_login | **Optional.** SNMP version 3 username. Defaults to "snmpuser".
1191 snmp_password | **Required.** SNMP version 3 password. No value defined as default.
1192 snmp_v3_use_privpass | **Optional.** Define to use SNMP version 3 priv password. Defaults to false.
1193 snmp_authprotocol | **Optional.** SNMP version 3 authentication protocol. Defaults to "md5,des".
1194 snmp_privpass | **Required.** SNMP version 3 priv password. No value defined as default.
1195 snmp_warn | **Optional.** The warning threshold.
1196 snmp_crit | **Optional.** The critical threshold.
1197 snmp_storage_name | **Optional.** Storage name. Default to regex "^/$$". More options available in the [snmp storage](http://nagios.manubulon.com/snmp_storage.html) documentation.
1198 snmp_perf | **Optional.** Enable perfdata values. Defaults to true.
1199 snmp_timeout | **Optional.** The command timeout in seconds. Defaults to 5 seconds.
1201 ## <a id="plugin-check-command-snmp-interface"></a> snmp-interface
1203 Check command object for the [check_snmp_int.pl](http://nagios.manubulon.com/snmp_int.html) plugin.
1208 ----------------------------|--------------
1209 snmp_address | **Optional.** The host's address. Defaults to "$address$" if the host's `address` attribute is set, "$address6$" otherwise.
1210 snmp_nocrypt | **Optional.** Define SNMP encryption. If set **snmp_v3** needs to be set. Defaults to false.
1211 snmp_community | **Optional.** The SNMP community. Defaults to "public".
1212 snmp_port | **Optional.** The SNMP port connection.
1213 snmp_v2 | **Optional.** SNMP version to 2c. Defaults to false.
1214 snmp_v3 | **Optional.** SNMP version to 3. Defaults to false.
1215 snmp_login | **Optional.** SNMP version 3 username. Defaults to "snmpuser".
1216 snmp_password | **Required.** SNMP version 3 password. No value defined as default.
1217 snmp_v3_use_privpass | **Optional.** Define to use SNMP version 3 priv password. Defaults to false.
1218 snmp_authprotocol | **Optional.** SNMP version 3 authentication protocol. Defaults to "md5,des".
1219 snmp_privpass | **Required.** SNMP version 3 priv password. No value defined as default.
1220 snmp_warn | **Optional.** The warning threshold.
1221 snmp_crit | **Optional.** The critical threshold.
1222 snmp_interface | **Optional.** Network interface name. Default to regex "eth0".
1223 snmp_interface_perf | **Optional.** Check the input/ouput bandwidth of the interface. Defaults to true.
1224 snmp_interface_label | **Optional.** Add label before speed in output: in=, out=, errors-out=, etc...
1225 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.
1226 snmp_interface_percent | **Optional.** Output performance data in % of max speed. Defaults to false.
1227 snmp_interface_kbits | **Optional.** Make the warning and critical levels in KBits/s. Defaults to true.
1228 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.
1229 snmp_interface_64bit | **Optional.** Use 64 bits counters instead of the standard counters when checking bandwidth & performance data for interface >= 1Gbps. Defaults to false.
1230 snmp_interface_errors | **Optional.** Add error & discard to Perfparse output. Defaults to true.
1231 snmp_interface_noregexp | **Optional.** Do not use regexp to match interface name in description OID. Defaults to false.
1232 snmp_interface_delta | **Optional.** Delta time of perfcheck. Defaults to "300" (5 min).
1233 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.
1234 snmp_perf | **Optional.** Enable perfdata values. Defaults to true.
1235 snmp_timeout | **Optional.** The command timeout in seconds. Defaults to 5 seconds.
1237 ## <a id="plugin-check-command-snmp-process"></a> snmp-process
1239 Check command object for the [check_snmp_process.pl](http://nagios.manubulon.com/snmp_process.html) plugin.
1244 ------------------------|--------------
1245 snmp_address | **Optional.** The host's address. Defaults to "$address$" if the host's `address` attribute is set, "$address6$" otherwise.
1246 snmp_nocrypt | **Optional.** Define SNMP encryption. If set **snmp_v3** needs to be set. Defaults to false.
1247 snmp_community | **Optional.** The SNMP community. Defaults to "public".
1248 snmp_port | **Optional.** The SNMP port connection.
1249 snmp_v2 | **Optional.** SNMP version to 2c. Defaults to false.
1250 snmp_v3 | **Optional.** SNMP version to 3. Defaults to false.
1251 snmp_login | **Optional.** SNMP version 3 username. Defaults to "snmpuser".
1252 snmp_password | **Required.** SNMP version 3 password. No value defined as default.
1253 snmp_v3_use_privpass | **Optional.** Define to use SNMP version 3 priv password. Defaults to false.
1254 snmp_authprotocol | **Optional.** SNMP version 3 authentication protocol. Defaults to "md5,des".
1255 snmp_privpass | **Required.** SNMP version 3 priv password. No value defined as default..
1256 snmp_warn | **Optional.** The warning threshold.
1257 snmp_crit | **Optional.** The critical threshold.
1258 snmp_process_name | **Optional.** Name of the process (regexp). No trailing slash!. Defaults to ".*".
1259 snmp_perf | **Optional.** Enable perfdata values. Defaults to true.
1260 snmp_timeout | **Optional.** The command timeout in seconds. Defaults to 5 seconds.
1262 # <a id="plugins-contrib"></a> Plugins Contrib
1264 The Plugins contrib collects various contributed command definitions.
1266 These check commands assume that the global constant named `PluginContribDir`
1267 is set to the path where the user installs custom plugins and can be enabled by uncommenting the corresponding line in icinga2.conf.
1269 ## <a id="plugins-contrib-databases"></a> Databases
1271 All database plugins go in this category.
1273 ### <a id="plugins-contrib-command-mssql_health"></a> mssql_health
1275 The plugin `mssql_health` utilises Perl DBD::Sybase based on FreeTDS to connect to MSSQL databases for monitoring.
1276 For release tarballs, detailed documentation especially on the different modes and scripts for creating a monitoring user see [https://labs.consol.de](https://labs.consol.de/nagios/check_mssql_health/). For development check [https://github.com](https://github.com/lausser/check_mssql_health).
1281 ---------------------------------|------------------------------------------------------------------------------------------------------------------------------
1282 mssql_health_hostname | **Optional.** Specifies the database hostname or address. No default because you typically use "mssql_health_server".
1283 mssql_health_port | **Optional.** Specifies the database port. No default because you typically use "mssql_health_server".
1284 mssql_health_server | **Optional.** The name of a predefined connection (in freetds.conf).
1285 mssql_health_currentdb | **Optional.** The name of a database which is used as the current database for the connection.
1286 mssql_health_username | **Optional.** The username for the database connection.
1287 mssql_health_password | **Optional.** The password for the database connection.
1288 mssql_health_warning | **Optional.** The warning threshold depending on the mode.
1289 mssql_health_critical | **Optional.** The critical threshold depending on the mode.
1290 mssql_health_mode | **Required.** The mode uses predefined keywords for the different checks. For example "connection-time", "database-free" or "sql".
1291 mssql_health_name | **Optional.** Depending on the mode this could be the database name or a SQL statement.
1292 mssql_health_name2 | **Optional.** If "mssql_health_name" is a sql statement, "mssql_health_name2" can be used to appear in the output and the performance data.
1293 mssql_health_regexep | **Optional.** If set to true, "mssql_health_name" will be interpreted as a regular expression. Defaults to false.
1294 mssql_health_units | **Optional.** This is used for a better output of mode=sql and for specifying thresholds for mode=tablespace-free. Possible values are "%", "KB", "MB" and "GB".
1295 mssql_health_offlineok | **Optional.** Set this to true, if offline databases are perfectly ok for you. Defaults to false.
1296 mssql_health_commit | **Optional.** Set this to true to turn on autocommit for the dbd::sybase module. Defaults to false.
1298 ### <a id="plugins-contrib-command-mysql_health"></a> mysql_health
1300 The plugin `mysql_health` utilises Perl DBD::MySQL to connect to MySQL databases for monitoring.
1301 For release tarballs and detailed documentation especially on the different modes and required permissions see [https://labs.consol.de](https://labs.consol.de/nagios/check_mysql_health/). For development check [https://github.com](https://github.com/lausser/check_mysql_health).
1306 ---------------------------------|------------------------------------------------------------------------------------------------------------------------------
1307 mysql_health_hostname | **Required.** Specifies the database hostname or address. Defaults to "$address$" or "$address6$" if the `address` attribute is not set.
1308 mysql_health_port | **Optional.** Specifies the database port. Defaults to 3306 (or 1186 for "mysql_health_mode" cluster).
1309 mysql_health_socket | **Optional.** Specifies the database unix socket. No default.
1310 mysql_health_username | **Optional.** The username for the database connection.
1311 mysql_health_password | **Optional.** The password for the database connection.
1312 mysql_health_database | **Optional.** The database to connect to. Defaults to information_schema.
1313 mysql_health_warning | **Optional.** The warning threshold depending on the mode.
1314 mysql_health_critical | **Optional.** The critical threshold depending on the mode.
1315 mysql_health_mode | **Required.** The mode uses predefined keywords for the different checks. For example "connection-time", "slave-lag" or "sql".
1316 mysql_health_name | **Optional.** The SQL statement to be executed with "mysql_health_mode" sql.
1317 mysql_health_name2 | **Optional.** If "mysql_health_name" is a sql statement, "mysql_health_name2" can be used to appear in the output and the performance data.
1318 mysql_health_units | **Optional.** This is used for a better output of mode=sql and for specifying thresholds for mode=tablespace-free. Possible values are "%", "KB", "MB" and "GB".
1319 mysql_health_labelformat | **Optional.** One of those formats pnp4nagios or groundwork. Defaults to pnp4nagios.
1321 ### <a id="plugins-contrib-command-oracle_health"></a> oracle_health
1323 The plugin `oracle_health` utilises Perl DBD::Oracle based on oracle-instantclient-sdk or sqlplus to connect to Oracle databases for monitoring.
1324 For release tarballs and detailed documentation especially on the different modes and required permissions see [https://labs.consol.de](https://labs.consol.de/nagios/check_oracle_health/). For development check [https://github.com](https://github.com/lausser/check_oracle_health).
1329 ---------------------------------|------------------------------------------------------------------------------------------------------------------------------
1330 oracle_health_connect | **Required.** Specifies the database connection string (from tnsnames.ora).
1331 oracle_health_username | **Optional.** The username for the database connection.
1332 oracle_health_password | **Optional.** The password for the database connection.
1333 oracle_health_warning | **Optional.** The warning threshold depending on the mode.
1334 oracle_health_critical | **Optional.** The critical threshold depending on the mode.
1335 oracle_health_mode | **Required.** The mode uses predefined keywords for the different checks. For example "connection-time", "flash-recovery-area-usage" or "sql".
1336 oracle_health_name | **Optional.** The tablespace, datafile, wait event, latch, enqueue depending on the mode or SQL statement to be executed with "oracle_health_mode" sql.
1337 oracle_health_name2 | **Optional.** If "oracle_health_name" is a sql statement, "oracle_health_name2" can be used to appear in the output and the performance data.
1338 oracle_health_units | **Optional.** This is used for a better output of mode=sql and for specifying thresholds for mode=tablespace-free. Possible values are "%", "KB", "MB" and "GB".
1339 oracle_health_ident | **Optional.** If set to true outputs instance and database names. Defaults to false.
1340 oracle_health_commit | **Optional.** Set this to true to turn on autocommit for the dbd::oracle module. Defaults to false.
1341 oracle_health_noperfdata | **Optional.** Set this to true if you want to disable perfdata. Defaults to false.
1346 --------------------|------------------------------------------------------------------------------------------------------------------------------------------
1347 ORACLE_HOME | **Required.** Specifies the location of the oracle instant client libraries. Defaults to "/usr/lib/oracle/11.2/client64/lib". Can be overridden by setting "oracle_home".
1348 TNS_ADMIN | **Required.** Specifies the location of the tnsnames.ora including the database connection strings. Defaults to "/etc/icinga2/plugin-configs". Can be overridden by setting "oracle_tns_admin".
1350 ### <a id="plugins-contrib-command-postgres"></a> postgres
1352 The plugin `postgres` utilises the psql binary to connect to PostgreSQL databases for monitoring.
1353 For release tarballs and detailed documentation especially the different actions and required persmissions see [https://bucardo.org/wiki/Check_postgres](https://bucardo.org/wiki/Check_postgres). For development check [https://github.com](https://github.com/bucardo/check_postgres).
1358 ---------------------------------|------------------------------------------------------------------------------------------------------------------------------
1359 postgres_host | **Optional.** Specifies the database hostname or address. Defaults to "$address$" or "$address6$" if the `address` attribute is not set. If "postgres_unixsocket" is set to true falls back to unix socket.
1360 postgres_port | **Optional.** Specifies the database port. Defaults to 5432.
1361 postgres_dbname | **Optional.** Specifies the database name to connect to. Defaults to "postgres" or "template1".
1362 postgres_dbuser | **Optional.** The username for the database connection. Defaults to "postgres".
1363 postgres_dbpass | **Optional.** The password for the database connection. You can use a .pgpass file instead.
1364 postgres_dbservice | **Optional.** Specifies the service name to use inside of pg_service.conf.
1365 postgres_warning | **Optional.** Specifies the warning threshold, range depends on the action.
1366 postgres_critical | **Optional.** Specifies the critical threshold, range depends on the action.
1367 postgres_include | **Optional.** Specifies name(s) items to specifically include (e.g. tables), depends on the action.
1368 postgres_exclude | **Optional.** Specifies name(s) items to specifically exclude (e.g. tables), depends on the action.
1369 postgres_includeuser | **Optional.** Include objects owned by certain users.
1370 postgres_excludeuser | **Optional.** Exclude objects owned by certain users.
1371 postgres_standby | **Optional.** Assume that the server is in continious WAL recovery mode if set to true. Defaults to false.
1372 postgres_production | **Optional.** Assume that the server is in production mode if set to true. Defaults to false.
1373 postgres_action | **Required.** Determines the test executed.
1374 postgres_unixsocket | **Optional.** If "postgres_unixsocket" is set to true the unix socket is used instead of an address. Defaults to false.
1376 ## <a id="plugins-contrib-ipmi"></a> IPMI Devices
1378 This category includes all plugins for IPMI devices.
1380 ### <a id="plugins-contrib-command-ipmi-sensor"></a> ipmi-sensor
1382 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.
1387 ---------------------------------|-----------------------------------------------------------------------------------------------------
1388 ipmi_address | **Required.** Specifies the remote host (IPMI device) to check. Defaults to "$address$".
1389 ipmi_config_file | **Optional.** Path to the FreeIPMI configuration file. It should contain IPMI username, IPMI password, and IPMI privilege-level.
1390 ipmi_username | **Optional.** The IPMI username.
1391 ipmi_password | **Optional.** The IPMI password.
1392 ipmi_privilege_level | **Optional.** The IPMI privilege level of the IPMI user.
1393 ipmi_backward_compatibility_mode | **Optional.** Enable backward compatibility mode, useful for FreeIPMI 0.5.* (this omits FreeIPMI options "--quiet-cache" and "--sdr-cache-recreate").
1394 ipmi_sensor_type | **Optional.** Limit sensors to query based on IPMI sensor type. Examples for IPMI sensor types are 'Fan', 'Temperature' and 'Voltage'.
1395 ipmi_exclude_sensor_id | **Optional.** Exclude sensor matching ipmi_sensor_id.
1396 ipmi_sensor_id | **Optional.** Include sensor matching ipmi_sensor_id.
1397 ipmi_protocal_lan_version | **Optional.** Change the protocol LAN version. Defaults to "LAN_2_0".
1398 ipmi_number_of_active_fans | **Optional.** Number of fans that should be active. Otherwise a WARNING state is returned.
1399 ipmi_show_fru | **Optional.** Print the product serial number if it is available in the IPMI FRU data.
1400 ipmi_no_sel_checking | **Optional.** Turn off system event log checking via ipmi-sel.
1402 ## <a id="plugins-contrib-network-components"></a> Network Components
1404 This category includes all plugins for various network components like routers, switches and firewalls.
1406 ### <a id="plugins-contrib-command-interfacetable"></a> interfacetable
1408 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).
1413 ------------------------------------|-----------------------------------------------------------------------------------------------------
1414 interfacetable_hostquery | **Required.** Specifies the remote host to poll. Defaults to "$address$".
1415 interfacetable_hostdisplay | **Optional.** Specifies the hostname to display in the HTML link. Defaults to "$host.display_name$".
1416 interfacetable_regex | **Optional.** Interface names and property names for some other options will be interpreted as regular expressions. Defaults to false.
1417 interfacetable_outputshort | **Optional.** Reduce the verbosity of the plugin output. Defaults to false.
1418 interfacetable_exclude | **Optional.** Comma separated list of interfaces globally excluded from the monitoring.
1419 interfacetable_include | **Optional.** Comma separated list of interfaces globally included in the monitoring.
1420 interfacetable_aliasmatching | **Optional.** Allow you to specify alias in addition to interface names. Defaults to false.
1421 interfacetable_excludetraffic | **Optional.** Comma separated list of interfaces excluded from traffic checks.
1422 interfacetable_includetraffic | **Optional.** Comma separated list of interfaces included for traffic checks.
1423 interfacetable_warningtraffic | **Optional.** Interface traffic load percentage leading to a warning alert.
1424 interfacetable_criticaltraffic | **Optional.** Interface traffic load percentage leading to a critical alert.
1425 interfacetable_pkt | **Optional.** Add unicast/non-unicast pkt stats for each interface.
1426 interfacetable_trackproperty | **Optional.** List of tracked properties.
1427 interfacetable_excludeproperty | **Optional.** Comma separated list of interfaces excluded from the property tracking.
1428 interfacetable_includeproperty | **Optional.** Comma separated list of interfaces included in the property tracking.
1429 interfacetable_community | **Optional.** Specifies the snmp v1/v2c community string. Defaults to "public" if using snmp v1/v2c, ignored using v3.
1430 interfacetable_snmpv2 | **Optional.** Use snmp v2c. Defaults to false.
1431 interfacetable_login | **Optional.** Login for snmpv3 authentication.
1432 interfacetable_passwd | **Optional.** Auth password for snmpv3 authentication.
1433 interfacetable_privpass | **Optional.** Priv password for snmpv3 authentication.
1434 interfacetable_protocols | **Optional.** Authentication protocol,Priv protocol for snmpv3 authentication.
1435 interfacetable_domain | **Optional.** SNMP transport domain.
1436 interfacetable_contextname | **Optional.** Context name for the snmp requests.
1437 interfacetable_port | **Optional.** SNMP port. Defaults to standard port.
1438 interfacetable_64bits | **Optional.** Use SNMP 64-bits counters. Defaults to false.
1439 interfacetable_maxrepetitions | **Optional.** Increasing this value may enhance snmp query performances by gathering more results at one time.
1440 interfacetable_snmptimeout | **Optional.** Define the Transport Layer timeout for the snmp queries.
1441 interfacetable_snmpretries | **Optional.** Define the number of times to retry sending a SNMP message.
1442 interfacetable_unixsnmp | **Optional.** Use unix snmp utilities for snmp requests. Defaults to false, which means use the perl bindings.
1443 interfacetable_enableperfdata | **Optional.** Enable port performance data. Defaults to false.
1444 interfacetable_perfdataformat | **Optional.** Define which performance data will be generated. Possible values are "full" (default), "loadonly", "globalonly".
1445 interfacetable_perfdatathreshold | **Optional.** Define which thresholds are printed in the generated performance data. Possible values are "full" (default), "loadonly", "globalonly".
1446 interfacetable_perfdatadir | **Optional.** When specified, the performance data are also written directly to a file, in the specified location.
1447 interfacetable_perfdataservicedesc | **Optional.** Specify additional parameters for output performance data to PNP. Defaults to "$service.name$", only affects **interfacetable_perfdatadir**.
1448 interfacetable_grapher | **Optional.** Specify the used graphing solution. Possible values are "pnp4nagios" (default), "nagiosgrapher", "netwaysgrapherv2" and "ingraph".
1449 interfacetable_grapherurl | **Optional.** Graphing system url. Default depends on **interfacetable_grapher**.
1450 interfacetable_portperfunit | **Optional.** Traffic could be reported in bits (counters) or in bps (calculated value).
1451 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".
1452 interfacetable_duplex | **Optional.** Add the duplex mode property for each interface in the interface table. Defaults to false.
1453 interfacetable_stp | **Optional.** Add the stp state property for each interface in the interface table. Defaults to false.
1454 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"
1455 interfacetable_noipinfo | **Optional.** Remove the ip information for each interface from the interface table. Defaults to false.
1456 interfacetable_alias | **Optional.** Add the alias information for each interface in the interface table. Defaults to false.
1457 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.
1458 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.
1459 interfacetable_delta | **Optional.** Set the delta used for interface throuput calculation in seconds.
1460 interfacetable_ifs | **Optional.** Input field separator. Defaults to ",".
1461 interfacetable_cache | **Optional.** Define the retention time of the cached data in seconds.
1462 interfacetable_noifloadgradient | **Optional.** Disable color gradient from green over yellow to red for the load percentage. Defaults to false.
1463 interfacetable_nohuman | **Optional.** Do not translate bandwidth usage in human readable format. Defaults to false.
1464 interfacetable_snapshot | **Optional.** Force the plugin to run like if it was the first launch. Defaults to false.
1465 interfacetable_timeout | **Optional.** Define the global timeout limit of the plugin in seconds. Defaults to "15s".
1466 interfacetable_css | **Optional.** Define the css stylesheet used by the generated html files. Possible values are "classic", "icinga", "icinga-alternate1" or "nagiosxi".
1467 interfacetable_config | **Optional.** Specify a config file to load.
1468 interfacetable_noconfigtable | **Optional.** Disable configuration table on the generated HTML page. Defaults to false.
1469 interfacetable_notips | **Optional.** Disable the tips in the generated html tables. Defaults to false.
1470 interfacetable_defaulttablesorting | **Optional.** Default table sorting can be "index" (default) or "name".
1471 interfacetable_tablesplit | **Optional.** Generate multiple interface tables, one per interface type. Defaults to false.
1472 interfacetable_notype | **Optional.** Remove the interface type for each interface. Defaults to false.
1474 ## <a id="plugins-contrib-web"></a> Web
1476 This category includes all plugins for web-based checks.
1478 ## <a id="plugin-check-command-webinject"></a> webinject
1480 Check command object for the [check_webinject](http://http://www.webinject.org/manual.html) plugin.
1485 ------------------------|--------------
1486 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.
1487 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.
1488 webinject_no_output | **Optional.** Suppresses all output to STDOUT except the results summary.
1489 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.
1490 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.
1491 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.
1493 ## <a id="plugins-contrib-operating-system"></a> Operating System
1495 In this category you can find plugins for gathering information about your operating system or the system beneath like memory usage.
1497 ### <a id="plugins-contrib-command-mem"></a> mem
1499 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).
1504 -------------|-----------------------------------------------------------------------------------------------------------------------
1505 mem_used | **Optional.** Tell the plugin to check for used memory in opposite of **mem_free**. Must specify one of these as true.
1506 mem_free | **Optional.** Tell the plugin to check for free memory in opposite of **mem_used**. Must specify one of these as true.
1507 mem_cache | **Optional.** If set to true plugin will count cache as free memory. Defaults to false.
1508 mem_warning | **Required.** Specifiy the warning threshold as number interpreted as percent.
1509 mem_critical | **Required.** Specifiy the critical threshold as number interpreted as percent.
1511 ## <a id="plugins-contrib-virtualization"></a> Virtualization
1513 This category includes all plugins for various virtualization technologies.
1515 ### <a id="plugins-contrib-command-esxi-hardware"></a> esxi_hardware
1517 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.
1522 ------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
1523 esxi_hardware_host | **Required.** Specifies the host to monitor. Defaults to "$address$".
1524 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.
1525 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.
1526 esxi_hardware_vendor | **Optional.** Defines the vendor of the server: "auto", "dell", "hp", "ibm", "intel", "unknown" (default).
1527 esxi_hardware_html | **Optional.** Add web-links to hardware manuals for Dell servers (use your country extension). Only useful with **esxi_hardware_vendor** = dell.
1528 esxi_hardware_ignore | **Optional.** Comma separated list of elements to ignore.
1529 esxi_hardware_perfdata | **Optional.** Add performcedata for graphers like PNP4Nagios to the output. Defaults to false.
1530 esxi_hardware_nopower | **Optional.** Do not collect power performance data, when **esxi_hardware_perfdata** is set to true. Defaults to false.
1531 esxi_hardware_novolts | **Optional.** Do not collect voltage performance data, when **esxi_hardware_perfdata** is set to true. Defaults to false.
1532 esxi_hardware_nocurrent | **Optional.** Do not collect current performance data, when **esxi_hardware_perfdata** is set to true. Defaults to false.
1533 esxi_hardware_notemp | **Optional.** Do not collect temperature performance data, when **esxi_hardware_perfdata** is set to true. Defaults to false.
1534 esxi_hardware_nofan | **Optional.** Do not collect fan performance data, when **esxi_hardware_perfdata** is set to true. Defaults to false.
1536 # <a id="plugins-contrib-vmware"></a> VMware
1538 Check commands for the [check_vmware_esx](https://github.com/BaldMansMojo/check_vmware_esx) plugin.
1540 ## <a id="plugins-contrib-vmware-esx-dc-volumes"></a> vmware-esx-dc-volumes
1542 Check command object for the `check_vmware_esx` plugin. Shows all datastore volumes info.
1547 ------------------------|--------------
1548 vmware_datacenter | **Required.** Datacenter/vCenter hostname.
1549 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
1550 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".
1551 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".
1552 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
1553 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
1554 vmware_sessionfile | **Optional.** Session file name enhancement.
1555 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
1556 vmware_nosession | **Optional.** No auth session - IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
1557 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
1558 vmware_password | **Optional.** The username's password. No value defined as default.
1559 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
1560 vmware_subselect | **Optional.** Volume name to be checked the free space.
1561 vmware_gigabyte | **Optional.** Output in GB instead of MB.
1562 vmware_usedspace | **Optional.** Output used space instead of free. Defaults to "false".
1563 vmware_alertonly | **Optional.** List only alerting volumes. Defaults to "false".
1564 vmware_exclude | **Optional.** Blacklist volumes name. No value defined as default.
1565 vmware_include | **Optional.** Whitelist volumes name. No value defined as default.
1566 vmware_isregexp | **Optional.** Treat blacklist and whitelist expressions as regexp.
1567 vmware_dc_volume_used | **Optional.** Output used space instead of free. Defaults to "true".
1568 vmware_warn | **Optional.** The warning threshold for volumes. Defaults to "80%".
1569 vmware_crit | **Optional.** The critical threshold for volumes. Defaults to "90%".
1572 ## <a id="plugins-contrib-vmware-esx-dc-runtime-info"></a> vmware-esx-dc-runtime-info
1574 Check command object for the `check_vmware_esx` plugin. Shows all runtime info for the datacenter/Vcenter.
1579 ------------------------|--------------
1580 vmware_datacenter | **Required.** Datacenter/vCenter hostname.
1581 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
1582 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".
1583 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".
1584 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
1585 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
1586 vmware_sessionfile | **Optional.** Session file name enhancement.
1587 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
1588 vmware_nosession | **Optional.** No auth session - IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
1589 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
1590 vmware_password | **Optional.** The username's password. No value defined as default.
1591 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
1594 ## <a id="plugins-contrib-vmware-esx-dc-runtime-listvms"></a> vmware-esx-dc-runtime-listvms
1596 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.
1601 ------------------------|--------------
1602 vmware_datacenter | **Required.** Datacenter/vCenter hostname.
1603 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
1604 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".
1605 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".
1606 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
1607 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
1608 vmware_sessionfile | **Optional.** Session file name enhancement.
1609 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
1610 vmware_nosession | **Optional.** No auth session - IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
1611 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
1612 vmware_password | **Optional.** The username's password. No value defined as default.
1613 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
1614 vmware_alertonly | **Optional.** List only alerting VMs. Important here to avoid masses of data.
1615 vmware_exclude | **Optional.** Blacklist VMs name. No value defined as default.
1616 vmware_include | **Optional.** Whitelist VMs name. No value defined as default.
1617 vmware_isregexp | **Optional.** Treat blacklist and whitelist expressions as regexp.
1618 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.
1621 ## <a id="plugins-contrib-vmware-esx-dc-runtime-listhost"></a> vmware-esx-dc-runtime-listhost
1623 Check command object for the `check_vmware_esx` plugin. List of VMware ESX hosts and their power state.
1628 ------------------------|--------------
1629 vmware_datacenter | **Required.** Datacenter/vCenter hostname.
1630 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
1631 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".
1632 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".
1633 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
1634 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
1635 vmware_sessionfile | **Optional.** Session file name enhancement.
1636 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
1637 vmware_nosession | **Optional.** No auth session - IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
1638 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
1639 vmware_password | **Optional.** The username's password. No value defined as default.
1640 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
1641 vmware_alertonly | **Optional.** List only alerting hosts. Important here to avoid masses of data.
1642 vmware_exclude | **Optional.** Blacklist VMware ESX hosts. No value defined as default.
1643 vmware_include | **Optional.** Whitelist VMware ESX hosts. No value defined as default.
1644 vmware_isregexp | **Optional.** Treat blacklist and whitelist expressions as regexp.
1645 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.
1648 ## <a id="plugins-contrib-vmware-esx-dc-runtime-listcluster"></a> vmware-esx-dc-runtime-listcluster
1650 Check command object for the `check_vmware_esx` plugin. List of VMware clusters and their states.
1655 ------------------------|--------------
1656 vmware_datacenter | **Required.** Datacenter/vCenter hostname.
1657 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
1658 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".
1659 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".
1660 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
1661 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
1662 vmware_sessionfile | **Optional.** Session file name enhancement.
1663 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
1664 vmware_nosession | **Optional.** No auth session - IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
1665 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
1666 vmware_password | **Optional.** The username's password. No value defined as default.
1667 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
1668 vmware_alertonly | **Optional.** List only alerting hosts. Important here to avoid masses of data.
1669 vmware_exclude | **Optional.** Blacklist VMware cluster. No value defined as default.
1670 vmware_include | **Optional.** Whitelist VMware cluster. No value defined as default.
1671 vmware_isregexp | **Optional.** Treat blacklist and whitelist expressions as regexp.
1672 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.
1675 ## <a id="plugins-contrib-vmware-esx-dc-runtime-issues"></a> vmware-esx-dc-runtime-issues
1677 Check command object for the `check_vmware_esx` plugin. All issues for the host.
1682 ------------------------|--------------
1683 vmware_datacenter | **Required.** Datacenter/vCenter hostname.
1684 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
1685 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".
1686 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".
1687 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
1688 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
1689 vmware_sessionfile | **Optional.** Session file name enhancement.
1690 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
1691 vmware_nosession | **Optional.** No auth session - IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
1692 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
1693 vmware_password | **Optional.** The username's password. No value defined as default.
1694 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
1695 vmware_exclude | **Optional.** Blacklist issues. No value defined as default.
1696 vmware_include | **Optional.** Whitelist issues. No value defined as default.
1697 vmware_isregexp | **Optional.** Treat blacklist and whitelist expressions as regexp.
1698 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.
1701 ## <a id="plugins-contrib-vmware-esx-dc-runtime-status"></a> vmware-esx-dc-runtime-status
1703 Check command object for the `check_vmware_esx` plugin. Overall object status (gray/green/red/yellow).
1708 ------------------------|--------------
1709 vmware_datacenter | **Required.** Datacenter/vCenter hostname.
1710 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
1711 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".
1712 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".
1713 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
1714 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
1715 vmware_sessionfile | **Optional.** Session file name enhancement.
1716 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
1717 vmware_nosession | **Optional.** No auth session - IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
1718 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
1719 vmware_password | **Optional.** The username's password. No value defined as default.
1720 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
1723 ## <a id="plugins-contrib-vmware-esx-dc-runtime-tools"></a> vmware-esx-dc-runtime-tools
1725 Check command object for the `check_vmware_esx` plugin. Vmware Tools status.
1730 ------------------------|--------------
1731 vmware_datacenter | **Required.** Datacenter/vCenter hostname.
1732 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
1733 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".
1734 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".
1735 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
1736 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
1737 vmware_sessionfile | **Optional.** Session file name enhancement.
1738 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
1739 vmware_nosession | **Optional.** No auth session - IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
1740 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
1741 vmware_password | **Optional.** The username's password. No value defined as default.
1742 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
1743 vmware_poweredonly | **Optional.** List only VMs which are powered on. No value defined as default.
1744 vmware_alertonly | **Optional.** List only alerting VMs. Important here to avoid masses of data.
1745 vmware_exclude | **Optional.** Blacklist VMs. No value defined as default.
1746 vmware_include | **Optional.** Whitelist VMs. No value defined as default.
1747 vmware_isregexp | **Optional.** Treat blacklist and whitelist expressions as regexp.
1748 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.
1751 ## <a id="plugins-contrib-vmware-esx-soap-host-check"></a> vmware-esx-soap-host-check
1753 Check command object for the `check_vmware_esx` plugin. Simple check to verify a successfull connection to VMware SOAP API.
1758 ------------------------|--------------
1759 vmware_host | **Required.** ESX or ESXi hostname.
1760 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
1761 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".
1762 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".
1763 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
1764 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
1765 vmware_sessionfile | **Optional.** Session file name enhancement.
1766 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
1767 vmware_nosession | **Optional.** No auth session - IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
1768 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
1769 vmware_password | **Optional.** The username's password. No value defined as default.
1770 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
1773 ## <a id="plugins-contrib-vmware-esx-soap-host-uptime"></a> vmware-esx-soap-host-uptime
1775 Check command object for the `check_vmware_esx` plugin. Displays uptime of the VMware host.
1780 ------------------------|--------------
1781 vmware_host | **Required.** ESX or ESXi hostname.
1782 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
1783 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".
1784 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".
1785 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
1786 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
1787 vmware_sessionfile | **Optional.** Session file name enhancement.
1788 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
1789 vmware_nosession | **Optional.** No auth session - IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
1790 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
1791 vmware_password | **Optional.** The username's password. No value defined as default.
1792 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 ## <a id="plugins-contrib-vmware-esx-soap-host-cpu"></a> vmware-esx-soap-host-cpu
1797 Check command object for the `check_vmware_esx` plugin. CPU usage in percentage.
1802 ------------------------|--------------
1803 vmware_host | **Required.** ESX or ESXi hostname.
1804 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
1805 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".
1806 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".
1807 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
1808 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
1809 vmware_sessionfile | **Optional.** Session file name enhancement.
1810 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
1811 vmware_nosession | **Optional.** No auth session - IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
1812 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
1813 vmware_password | **Optional.** The username's password. No value defined as default.
1814 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
1815 vmware_warn | **Optional.** The warning threshold in percent. Defaults to "80%".
1816 vmware_crit | **Optional.** The critical threshold in percent. Defaults to "90%".
1819 ## <a id="plugins-contrib-vmware-esx-soap-host-cpu-ready"></a> vmware-esx-soap-host-cpu-ready
1821 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.
1826 ------------------------|--------------
1827 vmware_host | **Required.** ESX or ESXi hostname.
1828 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
1829 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".
1830 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".
1831 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
1832 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
1833 vmware_sessionfile | **Optional.** Session file name enhancement.
1834 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
1835 vmware_nosession | **Optional.** No auth session - IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
1836 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
1837 vmware_password | **Optional.** The username's password. No value defined as default.
1838 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
1841 ## <a id="plugins-contrib-vmware-esx-soap-host-cpu-wait"></a> vmware-esx-soap-host-cpu-wait
1843 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.
1848 ------------------------|--------------
1849 vmware_host | **Required.** ESX or ESXi hostname.
1850 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
1851 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".
1852 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".
1853 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
1854 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
1855 vmware_sessionfile | **Optional.** Session file name enhancement.
1856 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
1857 vmware_nosession | **Optional.** No auth session - IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
1858 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
1859 vmware_password | **Optional.** The username's password. No value defined as default.
1860 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
1863 ## <a id="plugins-contrib-vmware-esx-soap-host-cpu-usage"></a> vmware-esx-soap-host-cpu-usage
1865 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.
1870 ------------------------|--------------
1871 vmware_host | **Required.** ESX or ESXi hostname.
1872 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
1873 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".
1874 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".
1875 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
1876 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
1877 vmware_sessionfile | **Optional.** Session file name enhancement.
1878 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
1879 vmware_nosession | **Optional.** No auth session - IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
1880 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
1881 vmware_password | **Optional.** The username's password. No value defined as default.
1882 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
1883 vmware_warn | **Optional.** The warning threshold in percent. Defaults to "80%".
1884 vmware_crit | **Optional.** The critical threshold in percent. Defaults to "90%".
1887 ## <a id="plugins-contrib-vmware-esx-soap-host-mem"></a> vmware-esx-soap-host-mem
1889 Check command object for the `check_vmware_esx` plugin. All mem info(except overall and no thresholds).
1894 ------------------------|--------------
1895 vmware_host | **Required.** ESX or ESXi hostname.
1896 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
1897 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".
1898 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".
1899 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
1900 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
1901 vmware_sessionfile | **Optional.** Session file name enhancement.
1902 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
1903 vmware_nosession | **Optional.** No auth session - IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
1904 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
1905 vmware_password | **Optional.** The username's password. No value defined as default.
1906 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
1909 ## <a id="plugins-contrib-vmware-esx-soap-host-mem-usage"></a> vmware-esx-soap-host-mem-usage
1911 Check command object for the `check_vmware_esx` plugin. Average mem usage in percentage.
1916 ------------------------|--------------
1917 vmware_host | **Required.** ESX or ESXi hostname.
1918 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
1919 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".
1920 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".
1921 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
1922 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
1923 vmware_sessionfile | **Optional.** Session file name enhancement.
1924 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
1925 vmware_nosession | **Optional.** No auth session - IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
1926 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
1927 vmware_password | **Optional.** The username's password. No value defined as default.
1928 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
1929 vmware_warn | **Optional.** The warning threshold in percent. Defaults to "80%".
1930 vmware_crit | **Optional.** The critical threshold in percent. Defaults to "90%".
1933 ## <a id="plugins-contrib-vmware-esx-soap-host-mem-consumed"></a> vmware-esx-soap-host-mem-consumed
1935 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.
1940 ------------------------|--------------
1941 vmware_host | **Required.** ESX or ESXi hostname.
1942 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
1943 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".
1944 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".
1945 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
1946 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
1947 vmware_sessionfile | **Optional.** Session file name enhancement.
1948 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
1949 vmware_nosession | **Optional.** No auth session - IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
1950 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
1951 vmware_password | **Optional.** The username's password. No value defined as default.
1952 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
1953 vmware_warn | **Optional.** The warning threshold in percent. No value defined as default.
1954 vmware_crit | **Optional.** The critical threshold in percent. No value defined as default.
1957 ## <a id="plugins-contrib-vmware-esx-soap-host-mem-swapused"></a> vmware-esx-soap-host-mem-swapused
1959 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.
1964 ------------------------|--------------
1965 vmware_host | **Required.** ESX or ESXi hostname.
1966 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
1967 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".
1968 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".
1969 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
1970 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
1971 vmware_sessionfile | **Optional.** Session file name enhancement.
1972 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
1973 vmware_nosession | **Optional.** No auth session - IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
1974 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
1975 vmware_password | **Optional.** The username's password. No value defined as default.
1976 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
1977 vmware_warn | **Optional.** The warning threshold in percent. No value defined as default.
1978 vmware_crit | **Optional.** The critical threshold in percent. No value defined as default.
1979 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.
1982 ## <a id="plugins-contrib-vmware-esx-soap-host-mem-overhead"></a> vmware-esx-soap-host-mem-overhead
1984 Check command object for the `check_vmware_esx` plugin. Additional mem used by VM Server in MB.
1989 ------------------------|--------------
1990 vmware_host | **Required.** ESX or ESXi hostname.
1991 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
1992 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".
1993 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".
1994 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
1995 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
1996 vmware_sessionfile | **Optional.** Session file name enhancement.
1997 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
1998 vmware_nosession | **Optional.** No auth session - IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
1999 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
2000 vmware_password | **Optional.** The username's password. No value defined as default.
2001 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
2002 vmware_warn | **Optional.** The warning threshold in percent. No value defined as default.
2003 vmware_crit | **Optional.** The critical threshold in percent. No value defined as default.
2006 ## <a id="plugins-contrib-vmware-esx-soap-host-mem-memctl"></a> vmware-esx-soap-host-mem-memctl
2008 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.
2013 ------------------------|--------------
2014 vmware_host | **Required.** ESX or ESXi hostname.
2015 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
2016 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".
2017 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".
2018 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
2019 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
2020 vmware_sessionfile | **Optional.** Session file name enhancement.
2021 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
2022 vmware_nosession | **Optional.** No auth session - IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
2023 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
2024 vmware_password | **Optional.** The username's password. No value defined as default.
2025 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
2026 vmware_warn | **Optional.** The warning threshold in percent. No value defined as default.
2027 vmware_crit | **Optional.** The critical threshold in percent. No value defined as default.
2028 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.
2031 ## <a id="plugins-contrib-vmware-esx-soap-host-net"></a> vmware-esx-soap-host-net
2033 Check command object for the `check_vmware_esx` plugin. Shows net info.
2038 ------------------------|--------------
2039 vmware_host | **Required.** ESX or ESXi hostname.
2040 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
2041 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".
2042 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".
2043 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
2044 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
2045 vmware_sessionfile | **Optional.** Session file name enhancement.
2046 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
2047 vmware_nosession | **Optional.** No auth session - IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
2048 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
2049 vmware_password | **Optional.** The username's password. No value defined as default.
2050 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
2051 vmware_exclude | **Optional.** Blacklist NICs. No value defined as default.
2052 vmware_isregexp | **Optional.** Treat blacklist expression as regexp.
2055 ## <a id="plugins-contrib-vmware-esx-soap-host-net-usage"></a> vmware-esx-soap-host-net-usage
2057 Check command object for the `check_vmware_esx` plugin. Overall network usage in KBps(Kilobytes per Second).
2062 ------------------------|--------------
2063 vmware_host | **Required.** ESX or ESXi hostname.
2064 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
2065 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".
2066 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".
2067 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
2068 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
2069 vmware_sessionfile | **Optional.** Session file name enhancement.
2070 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
2071 vmware_nosession | **Optional.** No auth session - IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
2072 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
2073 vmware_password | **Optional.** The username's password. No value defined as default.
2074 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
2075 vmware_warn | **Optional.** The warning threshold in KBps(Kilobytes per Second). No value defined as default.
2076 vmware_crit | **Optional.** The critical threshold in KBps(Kilobytes per Second). No value defined as default.
2079 ## <a id="plugins-contrib-vmware-esx-soap-host-net-receive"></a> vmware-esx-soap-host-net-receive
2081 Check command object for the `check_vmware_esx` plugin. Data receive in KBps(Kilobytes per Second).
2086 ------------------------|--------------
2087 vmware_host | **Required.** ESX or ESXi hostname.
2088 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
2089 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".
2090 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".
2091 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
2092 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
2093 vmware_sessionfile | **Optional.** Session file name enhancement.
2094 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
2095 vmware_nosession | **Optional.** No auth session - IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
2096 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
2097 vmware_password | **Optional.** The username's password. No value defined as default.
2098 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
2099 vmware_warn | **Optional.** The warning threshold in KBps(Kilobytes per Second). No value defined as default.
2100 vmware_crit | **Optional.** The critical threshold in KBps(Kilobytes per Second). No value defined as default.
2103 ## <a id="plugins-contrib-vmware-esx-soap-host-net-send"></a> vmware-esx-soap-host-net-send
2105 Check command object for the `check_vmware_esx` plugin. Data send in KBps(Kilobytes per Second).
2110 ------------------------|--------------
2111 vmware_host | **Required.** ESX or ESXi hostname.
2112 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
2113 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".
2114 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".
2115 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
2116 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
2117 vmware_sessionfile | **Optional.** Session file name enhancement.
2118 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
2119 vmware_nosession | **Optional.** No auth session - IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
2120 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
2121 vmware_password | **Optional.** The username's password. No value defined as default.
2122 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
2123 vmware_warn | **Optional.** The warning threshold in KBps(Kilobytes per Second). No value defined as default.
2124 vmware_crit | **Optional.** The critical threshold in KBps(Kilobytes per Second). No value defined as default.
2127 ## <a id="plugins-contrib-vmware-esx-soap-host-net-nic"></a> vmware-esx-soap-host-net-nic
2129 Check command object for the `check_vmware_esx` plugin. Check all active NICs.
2134 ------------------------|--------------
2135 vmware_host | **Required.** ESX or ESXi hostname.
2136 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
2137 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".
2138 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".
2139 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
2140 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
2141 vmware_sessionfile | **Optional.** Session file name enhancement.
2142 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
2143 vmware_nosession | **Optional.** No auth session - IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
2144 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
2145 vmware_password | **Optional.** The username's password. No value defined as default.
2146 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
2147 vmware_exclude | **Optional.** Blacklist NICs. No value defined as default.
2148 vmware_isregexp | **Optional.** Treat blacklist expression as regexp.
2151 ## <a id="plugins-contrib-vmware-esx-soap-host-volumes"></a> vmware-esx-soap-host-volumes
2153 Check command object for the `check_vmware_esx` plugin. Shows all datastore volumes info.
2158 ------------------------|--------------
2159 vmware_host | **Required.** ESX or ESXi hostname.
2160 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
2161 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".
2162 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".
2163 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
2164 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
2165 vmware_sessionfile | **Optional.** Session file name enhancement.
2166 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
2167 vmware_nosession | **Optional.** No auth session - IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
2168 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
2169 vmware_password | **Optional.** The username's password. No value defined as default.
2170 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
2171 vmware_subselect | **Optional.** Volume name to be checked the free space.
2172 vmware_gigabyte | **Optional.** Output in GB instead of MB.
2173 vmware_usedspace | **Optional.** Output used space instead of free. Defaults to "false".
2174 vmware_alertonly | **Optional.** List only alerting volumes. Defaults to "false".
2175 vmware_exclude | **Optional.** Blacklist volumes name. No value defined as default.
2176 vmware_include | **Optional.** Whitelist volumes name. No value defined as default.
2177 vmware_isregexp | **Optional.** Treat blacklist and whitelist expressions as regexp.
2178 vmware_warn | **Optional.** The warning threshold for volumes. Defaults to "80%".
2179 vmware_crit | **Optional.** The critical threshold for volumes. Defaults to "90%".
2180 vmware_spaceleft | **Optional.** This has to be used in conjunction with thresholds as mentioned above.
2183 ## <a id="plugins-contrib-vmware-esx-soap-host-io"></a> vmware-esx-soap-host-io
2185 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.
2190 ------------------------|--------------
2191 vmware_host | **Required.** ESX or ESXi hostname.
2192 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
2193 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".
2194 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".
2195 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
2196 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
2197 vmware_sessionfile | **Optional.** Session file name enhancement.
2198 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
2199 vmware_nosession | **Optional.** No auth session - IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
2200 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
2201 vmware_password | **Optional.** The username's password. No value defined as default.
2202 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
2205 ## <a id="plugins-contrib-vmware-esx-soap-host-io-aborted"></a> vmware-esx-soap-host-io-aborted
2207 Check command object for the `check_vmware_esx` plugin. Number of aborted SCSI commands.
2212 ------------------------|--------------
2213 vmware_host | **Required.** ESX or ESXi hostname.
2214 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
2215 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".
2216 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".
2217 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
2218 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
2219 vmware_sessionfile | **Optional.** Session file name enhancement.
2220 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
2221 vmware_nosession | **Optional.** No auth session - IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
2222 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
2223 vmware_password | **Optional.** The username's password. No value defined as default.
2224 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
2225 vmware_warn | **Optional.** The warning threshold. No value defined as default.
2226 vmware_crit | **Optional.** The critical threshold. No value defined as default.
2229 ## <a id="plugins-contrib-vmware-esx-soap-host-io-resets"></a> vmware-esx-soap-host-io-resets
2231 Check command object for the `check_vmware_esx` plugin. Number of SCSI bus resets.
2236 ------------------------|--------------
2237 vmware_host | **Required.** ESX or ESXi hostname.
2238 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
2239 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".
2240 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".
2241 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
2242 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
2243 vmware_sessionfile | **Optional.** Session file name enhancement.
2244 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
2245 vmware_nosession | **Optional.** No auth session - IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
2246 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
2247 vmware_password | **Optional.** The username's password. No value defined as default.
2248 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
2249 vmware_warn | **Optional.** The warning threshold. No value defined as default.
2250 vmware_crit | **Optional.** The critical threshold. No value defined as default.
2253 ## <a id="plugins-contrib-vmware-esx-soap-host-io-read"></a> vmware-esx-soap-host-io-read
2255 Check command object for the `check_vmware_esx` plugin. Average number of kilobytes read from the disk each second.
2260 ------------------------|--------------
2261 vmware_host | **Required.** ESX or ESXi hostname.
2262 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
2263 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".
2264 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".
2265 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
2266 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
2267 vmware_sessionfile | **Optional.** Session file name enhancement.
2268 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
2269 vmware_nosession | **Optional.** No auth session - IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
2270 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
2271 vmware_password | **Optional.** The username's password. No value defined as default.
2272 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
2273 vmware_warn | **Optional.** The warning threshold. No value defined as default.
2274 vmware_crit | **Optional.** The critical threshold. No value defined as default.
2277 ## <a id="plugins-contrib-vmware-esx-soap-host-io-read-latency"></a> vmware-esx-soap-host-io-read-latency
2279 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.
2284 ------------------------|--------------
2285 vmware_host | **Required.** ESX or ESXi hostname.
2286 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
2287 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".
2288 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".
2289 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
2290 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
2291 vmware_sessionfile | **Optional.** Session file name enhancement.
2292 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
2293 vmware_nosession | **Optional.** No auth session - IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
2294 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
2295 vmware_password | **Optional.** The username's password. No value defined as default.
2296 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
2297 vmware_warn | **Optional.** The warning threshold. No value defined as default.
2298 vmware_crit | **Optional.** The critical threshold. No value defined as default.
2301 ## <a id="plugins-contrib-vmware-esx-soap-host-io-write"></a> vmware-esx-soap-host-io-write
2303 Check command object for the `check_vmware_esx` plugin. Average number of kilobytes written to disk each second.
2308 ------------------------|--------------
2309 vmware_host | **Required.** ESX or ESXi hostname.
2310 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
2311 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".
2312 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".
2313 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
2314 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
2315 vmware_sessionfile | **Optional.** Session file name enhancement.
2316 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
2317 vmware_nosession | **Optional.** No auth session - IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
2318 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
2319 vmware_password | **Optional.** The username's password. No value defined as default.
2320 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
2321 vmware_warn | **Optional.** The warning threshold. No value defined as default.
2322 vmware_crit | **Optional.** The critical threshold. No value defined as default.
2325 ## <a id="plugins-contrib-vmware-esx-soap-host-io-write-latency"></a> vmware-esx-soap-host-io-write-latency
2327 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.
2332 ------------------------|--------------
2333 vmware_host | **Required.** ESX or ESXi hostname.
2334 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
2335 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".
2336 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".
2337 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
2338 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
2339 vmware_sessionfile | **Optional.** Session file name enhancement.
2340 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
2341 vmware_nosession | **Optional.** No auth session - IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
2342 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
2343 vmware_password | **Optional.** The username's password. No value defined as default.
2344 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
2345 vmware_warn | **Optional.** The warning threshold. No value defined as default.
2346 vmware_crit | **Optional.** The critical threshold. No value defined as default.
2349 ## <a id="plugins-contrib-vmware-esx-soap-host-io-usage"></a> vmware-esx-soap-host-io-usage
2351 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.
2356 ------------------------|--------------
2357 vmware_host | **Required.** ESX or ESXi hostname.
2358 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
2359 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".
2360 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".
2361 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
2362 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
2363 vmware_sessionfile | **Optional.** Session file name enhancement.
2364 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
2365 vmware_nosession | **Optional.** No auth session - IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
2366 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
2367 vmware_password | **Optional.** The username's password. No value defined as default.
2368 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
2369 vmware_warn | **Optional.** The warning threshold. No value defined as default.
2370 vmware_crit | **Optional.** The critical threshold. No value defined as default.
2373 ## <a id="plugins-contrib-vmware-esx-soap-host-io-kernel-latency"></a> vmware-esx-soap-host-io-kernel-latency
2375 Check command object for the `check_vmware_esx` plugin. Average amount of time (ms) spent by VMkernel processing each SCSI command.
2380 ------------------------|--------------
2381 vmware_host | **Required.** ESX or ESXi hostname.
2382 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
2383 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".
2384 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".
2385 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
2386 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
2387 vmware_sessionfile | **Optional.** Session file name enhancement.
2388 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
2389 vmware_nosession | **Optional.** No auth session - IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
2390 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
2391 vmware_password | **Optional.** The username's password. No value defined as default.
2392 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
2393 vmware_warn | **Optional.** The warning threshold. No value defined as default.
2394 vmware_crit | **Optional.** The critical threshold. No value defined as default.
2397 ## <a id="plugins-contrib-vmware-esx-soap-host-io-device-latency"></a> vmware-esx-soap-host-io-device-latency
2399 Check command object for the `check_vmware_esx` plugin. Average amount of time (ms) to complete a SCSI command from the physical device.
2404 ------------------------|--------------
2405 vmware_host | **Required.** ESX or ESXi hostname.
2406 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
2407 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".
2408 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".
2409 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
2410 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
2411 vmware_sessionfile | **Optional.** Session file name enhancement.
2412 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
2413 vmware_nosession | **Optional.** No auth session - IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
2414 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
2415 vmware_password | **Optional.** The username's password. No value defined as default.
2416 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
2417 vmware_warn | **Optional.** The warning threshold. No value defined as default.
2418 vmware_crit | **Optional.** The critical threshold. No value defined as default.
2421 ## <a id="plugins-contrib-vmware-esx-soap-host-io-queue-latency"></a> vmware-esx-soap-host-io-queue-latency
2423 Check command object for the `check_vmware_esx` plugin. Average amount of time (ms) spent in the VMkernel queue.
2428 ------------------------|--------------
2429 vmware_host | **Required.** ESX or ESXi hostname.
2430 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
2431 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".
2432 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".
2433 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
2434 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
2435 vmware_sessionfile | **Optional.** Session file name enhancement.
2436 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
2437 vmware_nosession | **Optional.** No auth session - IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
2438 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
2439 vmware_password | **Optional.** The username's password. No value defined as default.
2440 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
2441 vmware_warn | **Optional.** The warning threshold. No value defined as default.
2442 vmware_crit | **Optional.** The critical threshold. No value defined as default.
2445 ## <a id="plugins-contrib-vmware-esx-soap-host-io-total-latency"></a> vmware-esx-soap-host-io-total-latency
2447 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.
2452 ------------------------|--------------
2453 vmware_host | **Required.** ESX or ESXi hostname.
2454 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
2455 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".
2456 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".
2457 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
2458 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
2459 vmware_sessionfile | **Optional.** Session file name enhancement.
2460 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
2461 vmware_nosession | **Optional.** No auth session - IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
2462 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
2463 vmware_password | **Optional.** The username's password. No value defined as default.
2464 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
2465 vmware_warn | **Optional.** The warning threshold. No value defined as default.
2466 vmware_crit | **Optional.** The critical threshold. No value defined as default.
2469 ## <a id="plugins-contrib-vmware-esx-soap-host-media"></a> vmware-esx-soap-host-media
2471 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.
2476 ------------------------|--------------
2477 vmware_host | **Required.** ESX or ESXi hostname.
2478 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
2479 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".
2480 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".
2481 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
2482 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
2483 vmware_sessionfile | **Optional.** Session file name enhancement.
2484 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
2485 vmware_nosession | **Optional.** No auth session - IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
2486 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
2487 vmware_password | **Optional.** The username's password. No value defined as default.
2488 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
2489 vmware_exclude | **Optional.** Blacklist VMs name. No value defined as default.
2490 vmware_include | **Optional.** Whitelist VMs name. No value defined as default.
2491 vmware_isregexp | **Optional.** Treat blacklist and whitelist expressions as regexp.
2492 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.
2495 ## <a id="plugins-contrib-vmware-esx-soap-host-service"></a> vmware-esx-soap-host-service
2497 Check command object for the `check_vmware_esx` plugin. Shows host service info.
2502 ------------------------|--------------
2503 vmware_host | **Required.** ESX or ESXi hostname.
2504 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
2505 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".
2506 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".
2507 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
2508 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
2509 vmware_sessionfile | **Optional.** Session file name enhancement.
2510 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
2511 vmware_nosession | **Optional.** No auth session - IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
2512 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
2513 vmware_password | **Optional.** The username's password. No value defined as default.
2514 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
2515 vmware_exclude | **Optional.** Blacklist services name. No value defined as default.
2516 vmware_include | **Optional.** Whitelist services name. No value defined as default.
2517 vmware_isregexp | **Optional.** Treat blacklist and whitelist expressions as regexp.
2518 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.
2521 ## <a id="plugins-contrib-vmware-esx-soap-host-runtime"></a> vmware-esx-soap-host-runtime
2523 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.
2528 ------------------------|--------------
2529 vmware_host | **Required.** ESX or ESXi hostname.
2530 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
2531 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".
2532 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".
2533 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
2534 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
2535 vmware_sessionfile | **Optional.** Session file name enhancement.
2536 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
2537 vmware_nosession | **Optional.** No auth session - IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
2538 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
2539 vmware_password | **Optional.** The username's password. No value defined as default.
2540 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
2543 ## <a id="plugins-contrib-vmware-esx-soap-host-runtime-con"></a> vmware-esx-soap-host-runtime-con
2545 Check command object for the `check_vmware_esx` plugin. Shows connection state.
2550 ------------------------|--------------
2551 vmware_host | **Required.** ESX or ESXi hostname.
2552 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
2553 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".
2554 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".
2555 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
2556 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
2557 vmware_sessionfile | **Optional.** Session file name enhancement.
2558 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
2559 vmware_nosession | **Optional.** No auth session - IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
2560 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
2561 vmware_password | **Optional.** The username's password. No value defined as default.
2562 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
2565 ## <a id="plugins-contrib-vmware-esx-soap-host-runtime-listvms"></a> vmware-esx-soap-host-runtime-listvms
2567 Check command object for the `check_vmware_esx` plugin. List of VMware machines and their status.
2572 ------------------------|--------------
2573 vmware_host | **Required.** ESX or ESXi hostname.
2574 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
2575 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".
2576 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".
2577 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
2578 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
2579 vmware_sessionfile | **Optional.** Session file name enhancement.
2580 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
2581 vmware_nosession | **Optional.** No auth session - IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
2582 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
2583 vmware_password | **Optional.** The username's password. No value defined as default.
2584 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
2585 vmware_exclude | **Optional.** Blacklist VMs name. No value defined as default.
2586 vmware_include | **Optional.** Whitelist VMs name. No value defined as default.
2587 vmware_isregexp | **Optional.** Treat blacklist and whitelist expressions as regexp.
2588 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.
2591 ## <a id="plugins-contrib-vmware-esx-soap-host-runtime-status"></a> vmware-esx-soap-host-runtime-status
2593 Check command object for the `check_vmware_esx` plugin. Overall object status (gray/green/red/yellow).
2598 ------------------------|--------------
2599 vmware_host | **Required.** ESX or ESXi hostname.
2600 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
2601 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".
2602 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".
2603 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
2604 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
2605 vmware_sessionfile | **Optional.** Session file name enhancement.
2606 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
2607 vmware_nosession | **Optional.** No auth session - IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
2608 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
2609 vmware_password | **Optional.** The username's password. No value defined as default.
2610 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
2613 ## <a id="plugins-contrib-vmware-esx-soap-host-runtime-health"></a> vmware-esx-soap-host-runtime-health
2615 Check command object for the `check_vmware_esx` plugin. Checks cpu/storage/memory/sensor status.
2620 ------------------------|--------------
2621 vmware_host | **Required.** ESX or ESXi hostname.
2622 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
2623 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".
2624 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".
2625 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
2626 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
2627 vmware_sessionfile | **Optional.** Session file name enhancement.
2628 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
2629 vmware_nosession | **Optional.** No auth session - IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
2630 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
2631 vmware_password | **Optional.** The username's password. No value defined as default.
2632 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
2633 vmware_exclude | **Optional.** Blacklist status name. No value defined as default.
2634 vmware_include | **Optional.** Whitelist status name. No value defined as default.
2635 vmware_isregexp | **Optional.** Treat blacklist and whitelist expressions as regexp.
2638 ## <a id="plugins-contrib-vmware-esx-soap-host-runtime-health-listsensors"></a> vmware-esx-soap-host-runtime-health-listsensors
2640 Check command object for the `check_vmware_esx` plugin. List all available sensors(use for listing purpose only).
2645 ------------------------|--------------
2646 vmware_host | **Required.** ESX or ESXi hostname.
2647 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
2648 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".
2649 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".
2650 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
2651 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
2652 vmware_sessionfile | **Optional.** Session file name enhancement.
2653 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
2654 vmware_nosession | **Optional.** No auth session - IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
2655 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
2656 vmware_password | **Optional.** The username's password. No value defined as default.
2657 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
2658 vmware_exclude | **Optional.** Blacklist status name. No value defined as default.
2659 vmware_include | **Optional.** Whitelist status name. No value defined as default.
2660 vmware_isregexp | **Optional.** Treat blacklist and whitelist expressions as regexp.
2663 ## <a id="plugins-contrib-vmware-esx-soap-host-runtime-health-nostoragestatus"></a> vmware-esx-soap-host-runtime-health-nostoragestatus
2665 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**.
2670 ------------------------|--------------
2671 vmware_host | **Required.** ESX or ESXi hostname.
2672 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
2673 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".
2674 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".
2675 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
2676 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
2677 vmware_sessionfile | **Optional.** Session file name enhancement.
2678 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
2679 vmware_nosession | **Optional.** No auth session - IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
2680 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
2681 vmware_password | **Optional.** The username's password. No value defined as default.
2682 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
2683 vmware_exclude | **Optional.** Blacklist status name. No value defined as default.
2684 vmware_include | **Optional.** Whitelist status name. No value defined as default.
2685 vmware_isregexp | **Optional.** Treat blacklist and whitelist expressions as regexp.
2688 ## <a id="plugins-contrib-vmware-esx-soap-host-runtime-storagehealth"></a> vmware-esx-soap-host-runtime-storagehealth
2690 Check command object for the `check_vmware_esx` plugin. Local storage status check.
2695 ------------------------|--------------
2696 vmware_host | **Required.** ESX or ESXi hostname.
2697 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
2698 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".
2699 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".
2700 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
2701 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
2702 vmware_sessionfile | **Optional.** Session file name enhancement.
2703 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
2704 vmware_nosession | **Optional.** No auth session - IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
2705 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
2706 vmware_password | **Optional.** The username's password. No value defined as default.
2707 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
2708 vmware_exclude | **Optional.** Blacklist storage name. No value defined as default.
2709 vmware_include | **Optional.** Whitelist storage name. No value defined as default.
2710 vmware_isregexp | **Optional.** Treat blacklist and whitelist expressions as regexp.
2711 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.
2714 ## <a id="plugins-contrib-vmware-esx-soap-host-runtime-temp"></a> vmware-esx-soap-host-runtime-temp
2716 Check command object for the `check_vmware_esx` plugin. Lists all temperature sensors.
2721 ------------------------|--------------
2722 vmware_host | **Required.** ESX or ESXi hostname.
2723 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
2724 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".
2725 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".
2726 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
2727 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
2728 vmware_sessionfile | **Optional.** Session file name enhancement.
2729 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
2730 vmware_nosession | **Optional.** No auth session - IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
2731 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
2732 vmware_password | **Optional.** The username's password. No value defined as default.
2733 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
2734 vmware_exclude | **Optional.** Blacklist sensor name. No value defined as default.
2735 vmware_include | **Optional.** Whitelist sensor name. No value defined as default.
2736 vmware_isregexp | **Optional.** Treat blacklist and whitelist expressions as regexp.
2737 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.
2740 ## <a id="plugins-contrib-vmware-esx-soap-host-runtime-issues"></a> vmware-esx-soap-host-runtime-issues
2742 Check command object for the `check_vmware_esx` plugin. Lists all configuration issues for the host.
2747 ------------------------|--------------
2748 vmware_host | **Required.** ESX or ESXi hostname.
2749 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
2750 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".
2751 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".
2752 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
2753 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
2754 vmware_sessionfile | **Optional.** Session file name enhancement.
2755 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
2756 vmware_nosession | **Optional.** No auth session - IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
2757 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
2758 vmware_password | **Optional.** The username's password. No value defined as default.
2759 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
2760 vmware_exclude | **Optional.** Blacklist configuration issues. No value defined as default.
2761 vmware_include | **Optional.** Whitelist configuration issues. No value defined as default.
2762 vmware_isregexp | **Optional.** Treat blacklist and whitelist expressions as regexp.
2763 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.
2766 ## <a id="plugins-contrib-vmware-esx-soap-host-storage"></a> vmware-esx-soap-host-storage
2768 Check command object for the `check_vmware_esx` plugin. Shows Host storage info.
2773 ------------------------|--------------
2774 vmware_host | **Required.** ESX or ESXi hostname.
2775 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
2776 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".
2777 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".
2778 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
2779 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
2780 vmware_sessionfile | **Optional.** Session file name enhancement.
2781 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
2782 vmware_nosession | **Optional.** No auth session - IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
2783 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
2784 vmware_password | **Optional.** The username's password. No value defined as default.
2785 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
2786 vmware_exclude | **Optional.** Blacklist adapters, luns and paths. No value defined as default.
2787 vmware_include | **Optional.** Whitelist adapters, luns and paths. No value defined as default.
2788 vmware_isregexp | **Optional.** Treat blacklist and whitelist expressions as regexp.
2791 ## <a id="plugins-contrib-vmware-esx-soap-host-storage-adapter"></a> vmware-esx-soap-host-storage-adapter
2793 Check command object for the `check_vmware_esx` plugin. List host bus adapters.
2798 ------------------------|--------------
2799 vmware_host | **Required.** ESX or ESXi hostname.
2800 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
2801 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".
2802 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".
2803 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
2804 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
2805 vmware_sessionfile | **Optional.** Session file name enhancement.
2806 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
2807 vmware_nosession | **Optional.** No auth session - IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
2808 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
2809 vmware_password | **Optional.** The username's password. No value defined as default.
2810 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
2811 vmware_exclude | **Optional.** Blacklist adapters. No value defined as default.
2812 vmware_include | **Optional.** Whitelist adapters. No value defined as default.
2813 vmware_isregexp | **Optional.** Treat blacklist and whitelist expressions as regexp.
2814 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.
2817 ## <a id="plugins-contrib-vmware-esx-soap-host-storage-lun"></a> vmware-esx-soap-host-storage-lun
2819 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.
2824 ------------------------|--------------
2825 vmware_host | **Required.** ESX or ESXi hostname.
2826 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
2827 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".
2828 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".
2829 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
2830 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
2831 vmware_sessionfile | **Optional.** Session file name enhancement.
2832 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
2833 vmware_nosession | **Optional.** No auth session - IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
2834 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
2835 vmware_password | **Optional.** The username's password. No value defined as default.
2836 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
2837 vmware_exclude | **Optional.** Blacklist luns. No value defined as default.
2838 vmware_include | **Optional.** Whitelist luns. No value defined as default.
2839 vmware_isregexp | **Optional.** Treat blacklist and whitelist expressions as regexp.
2840 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.
2843 ## <a id="plugins-contrib-vmware-esx-soap-host-storage-path"></a> vmware-esx-soap-host-storage-path
2845 Check command object for the `check_vmware_esx` plugin. List multipaths and the associated paths.
2850 ------------------------|--------------
2851 vmware_host | **Required.** ESX or ESXi hostname.
2852 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
2853 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".
2854 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".
2855 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
2856 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
2857 vmware_sessionfile | **Optional.** Session file name enhancement.
2858 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
2859 vmware_nosession | **Optional.** No auth session - IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
2860 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
2861 vmware_password | **Optional.** The username's password. No value defined as default.
2862 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 vmware_alertonly | **Optional.** List only alerting units. Important here to avoid masses of data. Defaults to "false".
2864 vmware_exclude | **Optional.** Blacklist paths. No value defined as default.
2865 vmware_include | **Optional.** Whitelist paths. No value defined as default.
2866 vmware_isregexp | **Optional.** Treat blacklist and whitelist expressions as regexp.
2867 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.
2870 ## <a id="plugins-contrib-vmware-esx-soap-vm-cpu"></a> vmware-esx-soap-vm-cpu
2872 Check command object for the `check_vmware_esx` plugin. Shows all CPU usage info.
2877 ------------------------|--------------
2878 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. Conflicts with **vmware_host**.
2879 vmware_host | **Optional.** ESX or ESXi hostname. Conflicts with **vmware_datacenter**.
2880 vmware_vmname | **Required.** Virtual machine name.
2881 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
2882 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".
2883 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".
2884 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
2885 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
2886 vmware_sessionfile | **Optional.** Session file name enhancement.
2887 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
2888 vmware_nosession | **Optional.** No auth session - IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
2889 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
2890 vmware_password | **Optional.** The username's password. No value defined as default.
2891 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
2895 ## <a id="plugins-contrib-vmware-esx-soap-vm-cpu-ready"></a> vmware-esx-soap-vm-cpu-ready
2897 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.
2902 ------------------------|--------------
2903 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. Conflicts with **vmware_host**.
2904 vmware_host | **Optional.** ESX or ESXi hostname. Conflicts with **vmware_datacenter**.
2905 vmware_vmname | **Required.** Virtual machine name.
2906 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
2907 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".
2908 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".
2909 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
2910 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
2911 vmware_sessionfile | **Optional.** Session file name enhancement.
2912 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
2913 vmware_nosession | **Optional.** No auth session - IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
2914 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
2915 vmware_password | **Optional.** The username's password. No value defined as default.
2916 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
2917 vmware_warn | **Optional.** The warning threshold. No value defined as default.
2918 vmware_crit | **Optional.** The critical threshold. No value defined as default.
2921 ## <a id="plugins-contrib-vmware-esx-soap-vm-cpu-wait"></a> vmware-esx-soap-vm-cpu-wait
2923 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.
2928 ------------------------|--------------
2929 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. Conflicts with **vmware_host**.
2930 vmware_host | **Optional.** ESX or ESXi hostname. Conflicts with **vmware_datacenter**.
2931 vmware_vmname | **Required.** Virtual machine name.
2932 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
2933 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".
2934 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".
2935 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
2936 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
2937 vmware_sessionfile | **Optional.** Session file name enhancement.
2938 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
2939 vmware_nosession | **Optional.** No auth session - IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
2940 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
2941 vmware_password | **Optional.** The username's password. No value defined as default.
2942 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
2943 vmware_warn | **Optional.** The warning threshold. No value defined as default.
2944 vmware_crit | **Optional.** The critical threshold. No value defined as default.
2947 ## <a id="plugins-contrib-vmware-esx-soap-vm-cpu-usage"></a> vmware-esx-soap-vm-cpu-usage
2949 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.
2954 ------------------------|--------------
2955 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. Conflicts with **vmware_host**.
2956 vmware_host | **Optional.** ESX or ESXi hostname. Conflicts with **vmware_datacenter**.
2957 vmware_vmname | **Required.** Virtual machine name.
2958 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
2959 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".
2960 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".
2961 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
2962 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
2963 vmware_sessionfile | **Optional.** Session file name enhancement.
2964 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
2965 vmware_nosession | **Optional.** No auth session - IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
2966 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
2967 vmware_password | **Optional.** The username's password. No value defined as default.
2968 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
2969 vmware_warn | **Optional.** Warning threshold in percent. Defaults to "80%".
2970 vmware_crit | **Optional.** Critical threshold in percent. Defaults to "90%".
2973 ## <a id="plugins-contrib-vmware-esx-soap-vm-mem"></a> vmware-esx-soap-vm-mem
2975 Check command object for the `check_vmware_esx` plugin. Shows all memory info, except overall.
2980 ------------------------|--------------
2981 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. Conflicts with **vmware_host**.
2982 vmware_host | **Optional.** ESX or ESXi hostname. Conflicts with **vmware_datacenter**.
2983 vmware_vmname | **Required.** Virtual machine name.
2984 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
2985 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".
2986 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".
2987 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
2988 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
2989 vmware_sessionfile | **Optional.** Session file name enhancement.
2990 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
2991 vmware_nosession | **Optional.** No auth session - IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
2992 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
2993 vmware_password | **Optional.** The username's password. No value defined as default.
2994 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
2997 ## <a id="plugins-contrib-vmware-esx-soap-vm-mem-usage"></a> vmware-esx-soap-vm-mem-usage
2999 Check command object for the `check_vmware_esx` plugin. Average mem usage in percentage of configured virtual machine "physical" memory.
3004 ------------------------|--------------
3005 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. Conflicts with **vmware_host**.
3006 vmware_host | **Optional.** ESX or ESXi hostname. Conflicts with **vmware_datacenter**.
3007 vmware_vmname | **Required.** Virtual machine name.
3008 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
3009 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".
3010 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".
3011 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
3012 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
3013 vmware_sessionfile | **Optional.** Session file name enhancement.
3014 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
3015 vmware_nosession | **Optional.** No auth session - IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
3016 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
3017 vmware_password | **Optional.** The username's password. No value defined as default.
3018 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
3019 vmware_warn | **Optional.** Warning threshold in percent. Defaults to "80%".
3020 vmware_crit | **Optional.** Critical threshold in percent. Defaults to "90%".
3023 ## <a id="plugins-contrib-vmware-esx-soap-vm-mem-consumed"></a> vmware-esx-soap-vm-mem-consumed
3025 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>
3026 **vm consumed memory = memory granted - memory saved**
3031 ------------------------|--------------
3032 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. Conflicts with **vmware_host**.
3033 vmware_host | **Optional.** ESX or ESXi hostname. Conflicts with **vmware_datacenter**.
3034 vmware_vmname | **Required.** Virtual machine name.
3035 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
3036 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".
3037 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".
3038 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
3039 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
3040 vmware_sessionfile | **Optional.** Session file name enhancement.
3041 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
3042 vmware_nosession | **Optional.** No auth session - IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
3043 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
3044 vmware_password | **Optional.** The username's password. No value defined as default.
3045 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
3046 vmware_warn | **Optional.** The warning threshold. No value defined as default.
3047 vmware_crit | **Optional.** The critical threshold. No value defined as default.
3050 ## <a id="plugins-contrib-vmware-esx-soap-vm-mem-memctl"></a> vmware-esx-soap-vm-mem-memctl
3052 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.
3057 ------------------------|--------------
3058 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. Conflicts with **vmware_host**.
3059 vmware_host | **Optional.** ESX or ESXi hostname. Conflicts with **vmware_datacenter**.
3060 vmware_vmname | **Required.** Virtual machine name.
3061 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
3062 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".
3063 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".
3064 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
3065 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
3066 vmware_sessionfile | **Optional.** Session file name enhancement.
3067 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
3068 vmware_nosession | **Optional.** No auth session - IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
3069 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
3070 vmware_password | **Optional.** The username's password. No value defined as default.
3071 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
3072 vmware_warn | **Optional.** The warning threshold. No value defined as default.
3073 vmware_crit | **Optional.** The critical threshold. No value defined as default.
3077 ## <a id="plugins-contrib-vmware-esx-soap-vm-net"></a> vmware-esx-soap-vm-net
3079 Check command object for the `check_vmware_esx` plugin. Shows net info.
3084 ------------------------|--------------
3085 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. Conflicts with **vmware_host**.
3086 vmware_host | **Optional.** ESX or ESXi hostname. Conflicts with **vmware_datacenter**.
3087 vmware_vmname | **Required.** Virtual machine name.
3088 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
3089 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".
3090 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".
3091 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
3092 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
3093 vmware_sessionfile | **Optional.** Session file name enhancement.
3094 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
3095 vmware_nosession | **Optional.** No auth session - IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
3096 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
3097 vmware_password | **Optional.** The username's password. No value defined as default.
3098 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
3101 ## <a id="plugins-contrib-vmware-esx-soap-vm-net-usage"></a> vmware-esx-soap-vm-net-usage
3103 Check command object for the `check_vmware_esx` plugin. Overall network usage in KBps(Kilobytes per Second).
3108 ------------------------|--------------
3109 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. Conflicts with **vmware_host**.
3110 vmware_host | **Optional.** ESX or ESXi hostname. Conflicts with **vmware_datacenter**.
3111 vmware_vmname | **Required.** Virtual machine name.
3112 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
3113 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".
3114 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".
3115 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
3116 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
3117 vmware_sessionfile | **Optional.** Session file name enhancement.
3118 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
3119 vmware_nosession | **Optional.** No auth session - IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
3120 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
3121 vmware_password | **Optional.** The username's password. No value defined as default.
3122 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
3123 vmware_warn | **Optional.** The warning threshold. No value defined as default.
3124 vmware_crit | **Optional.** The critical threshold. No value defined as default.
3127 ## <a id="plugins-contrib-vmware-esx-soap-vm-net-receive"></a> vmware-esx-soap-vm-net-receive
3129 Check command object for the `check_vmware_esx` plugin. Receive in KBps(Kilobytes per Second).
3134 ------------------------|--------------
3135 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. Conflicts with **vmware_host**.
3136 vmware_host | **Optional.** ESX or ESXi hostname. Conflicts with **vmware_datacenter**.
3137 vmware_vmname | **Required.** Virtual machine name.
3138 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
3139 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".
3140 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".
3141 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
3142 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
3143 vmware_sessionfile | **Optional.** Session file name enhancement.
3144 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
3145 vmware_nosession | **Optional.** No auth session - IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
3146 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
3147 vmware_password | **Optional.** The username's password. No value defined as default.
3148 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
3149 vmware_warn | **Optional.** The warning threshold. No value defined as default.
3150 vmware_crit | **Optional.** The critical threshold. No value defined as default.
3153 ## <a id="plugins-contrib-vmware-esx-soap-vm-net-send"></a> vmware-esx-soap-vm-net-send
3155 Check command object for the `check_vmware_esx` plugin. Send in KBps(Kilobytes per Second).
3160 ------------------------|--------------
3161 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. Conflicts with **vmware_host**.
3162 vmware_host | **Optional.** ESX or ESXi hostname. Conflicts with **vmware_datacenter**.
3163 vmware_vmname | **Required.** Virtual machine name.
3164 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
3165 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".
3166 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".
3167 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
3168 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
3169 vmware_sessionfile | **Optional.** Session file name enhancement.
3170 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
3171 vmware_nosession | **Optional.** No auth session - IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
3172 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
3173 vmware_password | **Optional.** The username's password. No value defined as default.
3174 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
3175 vmware_warn | **Optional.** The warning threshold. No value defined as default.
3176 vmware_crit | **Optional.** The critical threshold. No value defined as default.
3179 ## <a id="plugins-contrib-vmware-esx-soap-vm-io"></a> vmware-esx-soap-vm-io
3181 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.
3186 ------------------------|--------------
3187 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. Conflicts with **vmware_host**.
3188 vmware_host | **Optional.** ESX or ESXi hostname. Conflicts with **vmware_datacenter**.
3189 vmware_vmname | **Required.** Virtual machine name.
3190 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
3191 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".
3192 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".
3193 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
3194 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
3195 vmware_sessionfile | **Optional.** Session file name enhancement.
3196 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
3197 vmware_nosession | **Optional.** No auth session - IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
3198 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
3199 vmware_password | **Optional.** The username's password. No value defined as default.
3200 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
3203 ## <a id="plugins-contrib-vmware-esx-soap-vm-io-read"></a> vmware-esx-soap-vm-io-read
3205 Check command object for the `check_vmware_esx` plugin. Average number of kilobytes read from the disk each second.
3210 ------------------------|--------------
3211 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. Conflicts with **vmware_host**.
3212 vmware_host | **Optional.** ESX or ESXi hostname. Conflicts with **vmware_datacenter**.
3213 vmware_vmname | **Required.** Virtual machine name.
3214 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
3215 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".
3216 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".
3217 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
3218 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
3219 vmware_sessionfile | **Optional.** Session file name enhancement.
3220 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
3221 vmware_nosession | **Optional.** No auth session - IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
3222 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
3223 vmware_password | **Optional.** The username's password. No value defined as default.
3224 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
3225 vmware_warn | **Optional.** The warning threshold. No value defined as default.
3226 vmware_crit | **Optional.** The critical threshold. No value defined as default.
3229 ## <a id="plugins-contrib-vmware-esx-soap-vm-io-write"></a> vmware-esx-soap-vm-io-write
3231 Check command object for the `check_vmware_esx` plugin. Average number of kilobytes written to disk each second.
3236 ------------------------|--------------
3237 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. Conflicts with **vmware_host**.
3238 vmware_host | **Optional.** ESX or ESXi hostname. Conflicts with **vmware_datacenter**.
3239 vmware_vmname | **Required.** Virtual machine name.
3240 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
3241 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".
3242 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".
3243 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
3244 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
3245 vmware_sessionfile | **Optional.** Session file name enhancement.
3246 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
3247 vmware_nosession | **Optional.** No auth session - IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
3248 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
3249 vmware_password | **Optional.** The username's password. No value defined as default.
3250 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
3251 vmware_warn | **Optional.** The warning threshold. No value defined as default.
3252 vmware_crit | **Optional.** The critical threshold. No value defined as default.
3255 ## <a id="plugins-contrib-vmware-esx-soap-vm-io-usage"></a> vmware-esx-soap-vm-io-usage
3257 Check command object for the `check_vmware_esx` plugin. Aggregated disk I/O rate.
3262 ------------------------|--------------
3263 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. Conflicts with **vmware_host**.
3264 vmware_host | **Optional.** ESX or ESXi hostname. Conflicts with **vmware_datacenter**.
3265 vmware_vmname | **Required.** Virtual machine name.
3266 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
3267 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".
3268 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".
3269 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
3270 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
3271 vmware_sessionfile | **Optional.** Session file name enhancement.
3272 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
3273 vmware_nosession | **Optional.** No auth session - IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
3274 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
3275 vmware_password | **Optional.** The username's password. No value defined as default.
3276 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
3277 vmware_warn | **Optional.** The warning threshold. No value defined as default.
3278 vmware_crit | **Optional.** The critical threshold. No value defined as default.
3281 ## <a id="plugins-contrib-vmware-esx-soap-vm-runtime"></a> vmware-esx-soap-vm-runtime
3283 Check command object for the `check_vmware_esx` plugin. Shows virtual machine runtime info.
3288 ------------------------|--------------
3289 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. Conflicts with **vmware_host**.
3290 vmware_host | **Optional.** ESX or ESXi hostname. Conflicts with **vmware_datacenter**.
3291 vmware_vmname | **Required.** Virtual machine name.
3292 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
3293 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".
3294 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".
3295 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
3296 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
3297 vmware_sessionfile | **Optional.** Session file name enhancement.
3298 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
3299 vmware_nosession | **Optional.** No auth session - IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
3300 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
3301 vmware_password | **Optional.** The username's password. No value defined as default.
3302 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
3305 ## <a id="plugins-contrib-vmware-esx-soap-vm-runtime-con"></a> vmware-esx-soap-vm-runtime-con
3307 Check command object for the `check_vmware_esx` plugin. Shows the connection state.
3312 ------------------------|--------------
3313 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. Conflicts with **vmware_host**.
3314 vmware_host | **Optional.** ESX or ESXi hostname. Conflicts with **vmware_datacenter**.
3315 vmware_vmname | **Required.** Virtual machine name.
3316 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
3317 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".
3318 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".
3319 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
3320 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
3321 vmware_sessionfile | **Optional.** Session file name enhancement.
3322 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
3323 vmware_nosession | **Optional.** No auth session - IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
3324 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
3325 vmware_password | **Optional.** The username's password. No value defined as default.
3326 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
3329 ## <a id="plugins-contrib-vmware-esx-soap-vm-runtime-powerstate"></a> vmware-esx-soap-vm-runtime-powerstate
3331 Check command object for the `check_vmware_esx` plugin. Shows virtual machine power state: poweredOn, poweredOff or suspended.
3336 ------------------------|--------------
3337 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. Conflicts with **vmware_host**.
3338 vmware_host | **Optional.** ESX or ESXi hostname. Conflicts with **vmware_datacenter**.
3339 vmware_vmname | **Required.** Virtual machine name.
3340 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
3341 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".
3342 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".
3343 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
3344 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
3345 vmware_sessionfile | **Optional.** Session file name enhancement.
3346 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
3347 vmware_nosession | **Optional.** No auth session - IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
3348 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
3349 vmware_password | **Optional.** The username's password. No value defined as default.
3350 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
3353 ## <a id="plugins-contrib-vmware-esx-soap-vm-runtime-status"></a> vmware-esx-soap-vm-runtime-status
3355 Check command object for the `check_vmware_esx` plugin. Overall object status (gray/green/red/yellow).
3360 ------------------------|--------------
3361 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. Conflicts with **vmware_host**.
3362 vmware_host | **Optional.** ESX or ESXi hostname. Conflicts with **vmware_datacenter**.
3363 vmware_vmname | **Required.** Virtual machine name.
3364 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
3365 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".
3366 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".
3367 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
3368 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
3369 vmware_sessionfile | **Optional.** Session file name enhancement.
3370 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
3371 vmware_nosession | **Optional.** No auth session - IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
3372 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
3373 vmware_password | **Optional.** The username's password. No value defined as default.
3374 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
3377 ## <a id="plugins-contrib-vmware-esx-soap-vm-runtime-consoleconnections"></a> vmware-esx-soap-vm-runtime-consoleconnections
3379 Check command object for the `check_vmware_esx` plugin. Console connections to virtual machine.
3384 ------------------------|--------------
3385 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. Conflicts with **vmware_host**.
3386 vmware_host | **Optional.** ESX or ESXi hostname. Conflicts with **vmware_datacenter**.
3387 vmware_vmname | **Required.** Virtual machine name.
3388 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
3389 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".
3390 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".
3391 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
3392 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
3393 vmware_sessionfile | **Optional.** Session file name enhancement.
3394 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
3395 vmware_nosession | **Optional.** No auth session - IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
3396 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
3397 vmware_password | **Optional.** The username's password. No value defined as default.
3398 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
3399 vmware_warn | **Optional.** The warning threshold. No value defined as default.
3400 vmware_crit | **Optional.** The critical threshold. No value defined as default.
3403 ## <a id="plugins-contrib-vmware-esx-soap-vm-runtime-gueststate"></a> vmware-esx-soap-vm-runtime-gueststate
3405 Check command object for the `check_vmware_esx` plugin. Guest OS status. Needs VMware Tools installed and running.
3410 ------------------------|--------------
3411 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. Conflicts with **vmware_host**.
3412 vmware_host | **Optional.** ESX or ESXi hostname. Conflicts with **vmware_datacenter**.
3413 vmware_vmname | **Required.** Virtual machine name.
3414 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
3415 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".
3416 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".
3417 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
3418 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
3419 vmware_sessionfile | **Optional.** Session file name enhancement.
3420 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
3421 vmware_nosession | **Optional.** No auth session - IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
3422 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
3423 vmware_password | **Optional.** The username's password. No value defined as default.
3424 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
3426 ## <a id="plugins-contrib-vmware-esx-soap-vm-runtime-tools"></a> vmware-esx-soap-vm-runtime-tools
3428 Check command object for the `check_vmware_esx` plugin. Guest OS status. VMware tools status.
3433 ------------------------|--------------
3434 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. Conflicts with **vmware_host**.
3435 vmware_host | **Optional.** ESX or ESXi hostname. Conflicts with **vmware_datacenter**.
3436 vmware_vmname | **Required.** Virtual machine name.
3437 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
3438 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".
3439 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".
3440 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
3441 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
3442 vmware_sessionfile | **Optional.** Session file name enhancement.
3443 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
3444 vmware_nosession | **Optional.** No auth session - IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
3445 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
3446 vmware_password | **Optional.** The username's password. No value defined as default.
3447 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
3450 ## <a id="plugins-contrib-vmware-esx-soap-vm-runtime-issues"></a> vmware-esx-soap-vm-runtime-issues
3452 Check command object for the `check_vmware_esx` plugin. All issues for the virtual machine.
3457 ------------------------|--------------
3458 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. Conflicts with **vmware_host**.
3459 vmware_host | **Optional.** ESX or ESXi hostname. Conflicts with **vmware_datacenter**.
3460 vmware_vmname | **Required.** Virtual machine name.
3461 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
3462 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".
3463 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".
3464 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
3465 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
3466 vmware_sessionfile | **Optional.** Session file name enhancement.
3467 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
3468 vmware_nosession | **Optional.** No auth session - IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
3469 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
3470 vmware_password | **Optional.** The username's password. No value defined as default.
3471 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
3472 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.