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.
55 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
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.
65 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
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.
104 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
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.
123 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
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.
139 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
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**.
156 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
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).
186 ## <a id="plugin-check-command-disk-smb"></a> disk_smb
188 Check command object for the `check_disk_smb` plugin.
192 > `disk_smb_wused` and `disk_smb_cused` require the percent sign. If omitted, disk units can be used.
194 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
197 ------------------------|------------------------
198 disk_smb_hostname | **Required.** NetBIOS name of the server.
199 disk_smb_share | **Required.** Share name being queried.
200 disk_smb_workgroup | **Optional.** Workgroup or Domain used (defaults to 'WORKGROUP' if omitted).
201 disk_smb_address | **Optional.** IP address of the host (only necessary if host belongs to another network).
202 disk_smb_username | **Optional.** Username for server log-in (defaults to 'guest' if omitted).
203 disk_smb_password | **Optional.** Password for server log-in (defaults to an empty password if omitted).
204 disk_smb_wused | **Optional.** The used space warning threshold. Defaults to "85%". If the percent sign is omitted, use optional disk units.
205 disk_smb_cused | **Optional.** The used space critical threshold. Defaults to "95%". If the percent sign is omitted, use optional disk units.
206 disk_smb_port | **Optional.** Connection port, e.g. `139` or `445`. Defaults to `smbclient` default if omitted.
208 ## <a id="plugin-check-command-dns"></a> dns
210 Check command object for the `check_dns` plugin.
212 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
215 ---------------------|--------------
216 dns_lookup | **Optional.** The hostname or IP to query the DNS for. Defaults to "$host_name$".
217 dns_server | **Optional.** The DNS server to query. Defaults to the server configured in the OS.
218 dns_expected_answer | **Optional.** The answer to look for. A hostname must end with a dot. **Deprecated in 2.3.**
219 dns_expected_answers | **Optional.** The answer(s) to look for. A hostname must end with a dot. Multiple answers must be defined as array.
220 dns_authoritative | **Optional.** Expect the server to send an authoritative answer.
221 dns_wtime | **Optional.** Return warning if elapsed time exceeds value.
222 dns_ctime | **Optional.** Return critical if elapsed time exceeds value.
223 dns_timeout | **Optional.** Seconds before connection times out. Defaults to 10.
226 ## <a id="plugin-check-command-dummy"></a> dummy
228 Check command object for the `check_dummy` plugin.
230 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
233 ----------------|--------------
234 dummy_state | **Optional.** The state. Can be one of 0 (ok), 1 (warning), 2 (critical) and 3 (unknown). Defaults to 0.
235 dummy_text | **Optional.** Plugin output. Defaults to "Check was successful.".
238 ## <a id="plugin-check-command-fping4"></a> fping4
240 Check command object for the `check_fping` plugin.
242 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
245 ----------------|--------------
246 fping_address | **Optional.** The host's IPv4 address. Defaults to "$address$".
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-fping6"></a> fping6
261 Check command object for the `check_fping` plugin.
263 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
266 ----------------|--------------
267 fping_address | **Optional.** The host's IPv6 address. Defaults to "$address6$".
268 fping_wrta | **Optional.** The RTA warning threshold in milliseconds. Defaults to 100.
269 fping_wpl | **Optional.** The packet loss warning threshold in %. Defaults to 5.
270 fping_crta | **Optional.** The RTA critical threshold in milliseconds. Defaults to 200.
271 fping_cpl | **Optional.** The packet loss critical threshold in %. Defaults to 15.
272 fping_number | **Optional.** The number of packets to send. Defaults to 5.
273 fping_interval | **Optional.** The interval between packets in milli-seconds. Defaults to 500.
274 fping_bytes | **Optional.** The size of ICMP packet.
275 fping_target_timeout | **Optional.** The target timeout in milli-seconds.
276 fping_source_ip | **Optional.** The name or ip address of the source ip.
277 fping_source_interface | **Optional.** The source interface name.
280 ## <a id="plugin-check-command-ftp"></a> ftp
282 Check command object for the `check_ftp` plugin.
284 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
287 -------------------|--------------
288 ftp_address | **Optional.** The host's address. Defaults to "$address$" if the host's `address` attribute is set, "$address6$" otherwise.
289 ftp_port | **Optional.** The FTP port number.
290 ftp_expect | **Optional.** String to expect in server response (may be repeated).
291 ftp_all | **Optional.** All expect strings need to occur in server response. Defaults to false.
292 ftp_escape_send | **Optional.** Enable usage of \n, \r, \t or \\\\ in send string.
293 ftp_send | **Optional.** String to send to the server.
294 ftp_escape_quit | **Optional.** Enable usage of \n, \r, \t or \\\\ in quit string.
295 ftp_quit | **Optional.** String to send server to initiate a clean close of the connection.
296 ftp_refuse | **Optional.** Accept TCP refusals with states ok, warn, crit. Defaults to crit.
297 ftp_mismatch | **Optional.** Accept expected string mismatches with states ok, warn, crit. Defaults to warn.
298 ftp_jail | **Optional.** Hide output from TCP socket.
299 ftp_maxbytes | **Optional.** Close connection once more than this number of bytes are received.
300 ftp_delay | **Optional.** Seconds to wait between sending string and polling for response.
301 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.
302 ftp_ssl | **Optional.** Use SSL for the connection. Defaults to false.
303 ftp_wtime | **Optional.** Response time to result in warning status (seconds).
304 ftp_ctime | **Optional.** Response time to result in critical status (seconds).
305 ftp_timeout | **Optional.** Seconds before connection times out. Defaults to 10.
308 ## <a id="plugin-check-command-hostalive"></a> hostalive
310 Check command object for the `check_ping` plugin with host check default values. This variant
311 uses the host's `address` attribute if available and falls back to using the `address6` attribute
312 if the `address` attribute is not set.
314 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
317 ----------------|--------------
318 ping_address | **Optional.** The host's address. Defaults to "$address$" if the host's `address` attribute is set, "$address6$" otherwise.
319 ping_wrta | **Optional.** The RTA warning threshold in milliseconds. Defaults to 3000.
320 ping_wpl | **Optional.** The packet loss warning threshold in %. Defaults to 80.
321 ping_crta | **Optional.** The RTA critical threshold in milliseconds. Defaults to 5000.
322 ping_cpl | **Optional.** The packet loss critical threshold in %. Defaults to 100.
323 ping_packets | **Optional.** The number of packets to send. Defaults to 5.
324 ping_timeout | **Optional.** The plugin timeout in seconds. Defaults to 0 (no timeout).
327 ## <a id="plugin-check-command-hostalive4"></a> hostalive4
329 Check command object for the `check_ping` plugin with host check default values. This variant
330 uses the host's `address` attribute.
332 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
335 ----------------|--------------
336 ping_address | **Optional.** The host's IPv4 address. Defaults to "$address$".
337 ping_wrta | **Optional.** The RTA warning threshold in milliseconds. Defaults to 3000.
338 ping_wpl | **Optional.** The packet loss warning threshold in %. Defaults to 80.
339 ping_crta | **Optional.** The RTA critical threshold in milliseconds. Defaults to 5000.
340 ping_cpl | **Optional.** The packet loss critical threshold in %. Defaults to 100.
341 ping_packets | **Optional.** The number of packets to send. Defaults to 5.
342 ping_timeout | **Optional.** The plugin timeout in seconds. Defaults to 0 (no timeout).
345 ## <a id="plugin-check-command-hostalive6"></a> hostalive6
347 Check command object for the `check_ping` plugin with host check default values. This variant
348 uses the host's `address6` attribute.
350 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
353 ----------------|--------------
354 ping_address | **Optional.** The host's IPv6 address. Defaults to "$address6$".
355 ping_wrta | **Optional.** The RTA warning threshold in milliseconds. Defaults to 3000.
356 ping_wpl | **Optional.** The packet loss warning threshold in %. Defaults to 80.
357 ping_crta | **Optional.** The RTA critical threshold in milliseconds. Defaults to 5000.
358 ping_cpl | **Optional.** The packet loss critical threshold in %. Defaults to 100.
359 ping_packets | **Optional.** The number of packets to send. Defaults to 5.
360 ping_timeout | **Optional.** The plugin timeout in seconds. Defaults to 0 (no timeout).
363 ## <a id="plugin-check-command-hpjd"></a> hpjd
365 Check command object for the `check_hpjd` plugin.
367 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
370 ----------------|--------------
371 hpjd_address | **Optional.** The host's address. Defaults to "$address$" if the host's `address` attribute is set, "$address6$" otherwise.
372 hpjd_port | **Optional.** The host's SNMP port. Defaults to 161.
373 hpjd_community | **Optional.** The SNMP community. Defaults to "public".
376 ## <a id="plugin-check-command-http"></a> http
378 Check command object for the `check_http` plugin.
380 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
383 -------------------------|--------------
384 http_address | **Optional.** The host's address. Defaults to "$address$" if the host's `address` attribute is set, "$address6$" otherwise.
385 http_vhost | **Optional.** The virtual host that should be sent in the "Host" header.
386 http_uri | **Optional.** The request URI.
387 http_port | **Optional.** The TCP port. Defaults to 80 when not using SSL, 443 otherwise.
388 http_ssl | **Optional.** Whether to use SSL. Defaults to false.
389 http_sni | **Optional.** Whether to use SNI. Defaults to false.
390 http_auth_pair | **Optional.** Add 'username:password' authorization pair.
391 http_proxy_auth_pair | **Optional.** Add 'username:password' authorization pair for proxy.
392 http_ignore_body | **Optional.** Don't download the body, just the headers.
393 http_linespan | **Optional.** Allow regex to span newline.
394 http_expect_body_regex | **Optional.** A regular expression which the body must match against. Incompatible with http_ignore_body.
395 http_expect_body_eregi | **Optional.** A case-insensitive expression which the body must match against. Incompatible with http_ignore_body.
396 http_invertregex | **Optional.** Changes behaviour of http_expect_body_regex and http_expect_body_eregi to return CRITICAL if found, OK if not.
397 http_warn_time | **Optional.** The warning threshold.
398 http_critical_time | **Optional.** The critical threshold.
399 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.
400 http_certificate | **Optional.** Minimum number of days a certificate has to be valid. Port defaults to 443.
401 http_clientcert | **Optional.** Name of file contains the client certificate (PEM format).
402 http_privatekey | **Optional.** Name of file contains the private key (PEM format).
403 http_headerstring | **Optional.** String to expect in the response headers.
404 http_string | **Optional.** String to expect in the content.
405 http_post | **Optional.** URL encoded http POST data.
406 http_method | **Optional.** Set http method (for example: HEAD, OPTIONS, TRACE, PUT, DELETE).
407 http_maxage | **Optional.** Warn if document is more than seconds old.
408 http_contenttype | **Optional.** Specify Content-Type header when POSTing.
409 http_useragent | **Optional.** String to be sent in http header as User Agent.
410 http_header | **Optional.** Any other tags to be sent in http header.
411 http_extendedperfdata | **Optional.** Print additional perfdata. Defaults to false.
412 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)
413 http_pagesize | **Optional.** Minimum page size required:Maximum page size required.
414 http_timeout | **Optional.** Seconds before connection times out.
417 ## <a id="plugin-check-command-icmp"></a> icmp
419 Check command object for the `check_icmp` plugin.
421 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
424 ----------------|--------------
425 icmp_address | **Optional.** The host's address. This can either be a single address or an array of addresses. Defaults to "$address$".
426 icmp_wrta | **Optional.** The RTA warning threshold in milliseconds. Defaults to 100.
427 icmp_wpl | **Optional.** The packet loss warning threshold in %. Defaults to 5.
428 icmp_crta | **Optional.** The RTA critical threshold in milliseconds. Defaults to 200.
429 icmp_cpl | **Optional.** The packet loss critical threshold in %. Defaults to 15.
430 icmp_source | **Optional.** The source IP address to send packets from.
431 icmp_packets | **Optional.** The number of packets to send. Defaults to 5.
432 icmp_packet_interval | **Optional** The maximum packet interval. Defaults to 80 (milliseconds).
433 icmp_target_interval | **Optional.** The maximum target interval.
434 icmp_hosts_alive | **Optional.** The number of hosts which have to be alive for the check to succeed.
435 icmp_data_bytes | **Optional.** Payload size for each ICMP request. Defaults to 8.
436 icmp_timeout | **Optional.** The plugin timeout in seconds. Defaults to 10 (seconds).
439 ## <a id="plugin-check-command-imap"></a> imap
441 Check command object for the `check_imap` plugin.
443 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
446 ----------------|--------------
447 imap_address | **Optional.** The host's address. Defaults to "$address$" if the host's `address` attribute is set, "$address6$" otherwise.
448 imap_port | **Optional.** The port that should be checked. Defaults to 143.
451 ## <a id="plugin-check-command-ldap"></a> ldap
453 Check command object for the `check_ldap` plugin.
455 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
458 ----------------|--------------
459 ldap_address | **Optional.** Host name, IP Address, or unix socket (must be an absolute path). Defaults to "$address$" if the host's `address` attribute is set, "$address6$" otherwise.
460 ldap_port | **Optional.** Port number. Defaults to 389.
461 ldap_attr | **Optional.** LDAP attribute to search for (default: "(objectclass=*)"
462 ldap_base | **Required.** LDAP base (eg. ou=myunit,o=myorg,c=at).
463 ldap_bind | **Optional.** LDAP bind DN (if required).
464 ldap_pass | **Optional.** LDAP password (if required).
465 ldap_starttls | **Optional.** Use STARTSSL mechanism introduced in protocol version 3.
466 ldap_ssl | **Optional.** Use LDAPS (LDAP v2 SSL method). This also sets the default port to 636.
467 ldap_v2 | **Optional.** Use LDAP protocol version 2 (enabled by default).
468 ldap_v3 | **Optional.** Use LDAP protocol version 3 (disabled by default)
469 ldap_warning | **Optional.** Response time to result in warning status (seconds).
470 ldap_critical | **Optional.** Response time to result in critical status (seconds).
471 ldap_timeout | **Optional.** Seconds before connection times out (default: 10).
472 ldap_verbose | **Optional.** Show details for command-line debugging (disabled by default)
474 ## <a id="plugin-check-command-load"></a> load
476 Check command object for the `check_load` plugin.
478 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
481 ----------------|--------------
482 load_wload1 | **Optional.** The 1-minute warning threshold. Defaults to 5.
483 load_wload5 | **Optional.** The 5-minute warning threshold. Defaults to 4.
484 load_wload15 | **Optional.** The 15-minute warning threshold. Defaults to 3.
485 load_cload1 | **Optional.** The 1-minute critical threshold. Defaults to 10.
486 load_cload5 | **Optional.** The 5-minute critical threshold. Defaults to 6.
487 load_cload15 | **Optional.** The 15-minute critical threshold. Defaults to 4.
490 ## <a id="plugin-check-command-nrpe"></a> nrpe
492 Check command object for the `check_nrpe` plugin.
494 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
497 ----------------|--------------
498 nrpe_address | **Optional.** The host's address. Defaults to "$address$" if the host's `address` attribute is set, "$address6$" otherwise.
499 nrpe_port | **Optional.** The NRPE port. Defaults to 5666.
500 nrpe_command | **Optional.** The command that should be executed.
501 nrpe_no_ssl | **Optional.** Whether to disable SSL or not. Defaults to `false`.
502 nrpe_timeout_unknown | **Optional.** Whether to set timeouts to unknown instead of critical state. Defaults to `false`.
503 nrpe_timeout | **Optional.** The timeout in seconds.
504 nrpe_arguments | **Optional.** Arguments that should be passed to the command. Multiple arguments must be defined as array.
507 ## <a id="plugin-check-command-nscp"></a> nscp
509 Check command object for the `check_nt` plugin.
511 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
514 ----------------|--------------
515 nscp_address | **Optional.** The host's address. Defaults to "$address$" if the host's `address` attribute is set, "$address6$" otherwise.
516 nscp_port | **Optional.** The NSClient++ port. Defaults to 12489.
517 nscp_password | **Optional.** The NSClient++ password.
518 nscp_variable | **Required.** The variable that should be checked.
519 nscp_params | **Optional.** Parameters for the query. Multiple parameters must be defined as array.
520 nscp_warn | **Optional.** The warning threshold.
521 nscp_crit | **Optional.** The critical threshold.
522 nscp_timeout | **Optional.** The query timeout in seconds.
523 nscp_showall | **Optional.** Use with SERVICESTATE to see working services or PROCSTATE for running processes. Defaults to false.
526 ## <a id="plugin-check-command-ntp-time"></a> ntp_time
528 Check command object for the `check_ntp_time` plugin.
530 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
533 ----------------|--------------
534 ntp_address | **Optional.** The host's address. Defaults to "$address$" if the host's `address` attribute is set, "$address6$" otherwise.
537 ## <a id="plugin-check-command-ntp-peer"></a> ntp_peer
539 Check command object for the `check_ntp_peer` plugin.
541 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
544 ----------------|--------------
545 ntp_address | **Optional.** The host's address. Defaults to "$address$" if the host's `address` attribute is set, "$address6$" otherwise.
546 ntp_port | **Optional.** The port to use. Default to 123.
547 ntp_warning | **Optional.** Offset to result in warning status (seconds).
548 ntp_critical | **Optional.** Offset to result in critical status (seconds).
549 ntp_wstratum | **Optional.** Warning threshold for stratum of server's synchronization peer.
550 ntp_cstratum | **Optional.** Critical threshold for stratum of server's synchronization peer.
551 ntp_wjitter | **Optional.** Warning threshold for jitter.
552 ntp_cjitter | **Optional.** Critical threshold for jitter.
553 ntp_wsource | **Optional.** Warning threshold for number of usable time sources.
554 ntp_csource | **Optional.** Critical threshold for number of usable time sources.
555 ntp_timeout | **Optional.** Seconds before connection times out (default: 10).
558 ## <a id="plugin-check-command-passive"></a> passive
560 Specialised check command object for passive checks executing the `check_dummy` plugin with appropriate default values.
562 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
565 ----------------|--------------
566 dummy_state | **Optional.** The state. Can be one of 0 (ok), 1 (warning), 2 (critical) and 3 (unknown). Defaults to 3.
567 dummy_text | **Optional.** Plugin output. Defaults to "No Passive Check Result Received.".
570 ## <a id="plugin-check-command-ping"></a> ping
572 Check command object for the `check_ping` plugin. This command uses the host's `address` attribute
573 if available and falls back to using the `address6` attribute if the `address` attribute is not set.
576 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
579 ----------------|--------------
580 ping_address | **Optional.** The host's address. Defaults to "$address$" if the host's `address` attribute is set, "$address6$" otherwise.
581 ping_wrta | **Optional.** The RTA warning threshold in milliseconds. Defaults to 100.
582 ping_wpl | **Optional.** The packet loss warning threshold in %. Defaults to 5.
583 ping_crta | **Optional.** The RTA critical threshold in milliseconds. Defaults to 200.
584 ping_cpl | **Optional.** The packet loss critical threshold in %. Defaults to 15.
585 ping_packets | **Optional.** The number of packets to send. Defaults to 5.
586 ping_timeout | **Optional.** The plugin timeout in seconds. Defaults to 0 (no timeout).
589 ## <a id="plugin-check-command-ping4"></a> ping4
591 Check command object for the `check_ping` plugin.
593 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
596 ----------------|--------------
597 ping_address | **Optional.** The host's IPv4 address. Defaults to "$address$".
598 ping_wrta | **Optional.** The RTA warning threshold in milliseconds. Defaults to 100.
599 ping_wpl | **Optional.** The packet loss warning threshold in %. Defaults to 5.
600 ping_crta | **Optional.** The RTA critical threshold in milliseconds. Defaults to 200.
601 ping_cpl | **Optional.** The packet loss critical threshold in %. Defaults to 15.
602 ping_packets | **Optional.** The number of packets to send. Defaults to 5.
603 ping_timeout | **Optional.** The plugin timeout in seconds. Defaults to 0 (no timeout).
605 ## <a id="plugin-check-command-ping6"></a> ping6
607 Check command object for the `check_ping` plugin.
609 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
612 ----------------|--------------
613 ping_address | **Optional.** The host's IPv6 address. Defaults to "$address6$".
614 ping_wrta | **Optional.** The RTA warning threshold in milliseconds. Defaults to 100.
615 ping_wpl | **Optional.** The packet loss warning threshold in %. Defaults to 5.
616 ping_crta | **Optional.** The RTA critical threshold in milliseconds. Defaults to 200.
617 ping_cpl | **Optional.** The packet loss critical threshold in %. Defaults to 15.
618 ping_packets | **Optional.** The number of packets to send. Defaults to 5.
619 ping_timeout | **Optional.** The plugin timeout in seconds. Defaults to 0 (no timeout).
622 ## <a id="plugin-check-command-pop"></a> pop
624 Check command object for the `check_pop` plugin.
626 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
629 ----------------|--------------
630 pop_address | **Optional.** The host's address. Defaults to "$address$" if the host's `address` attribute is set, "$address6$" otherwise.
631 pop_port | **Optional.** The port that should be checked. Defaults to 110.
634 ## <a id="plugin-check-command-processes"></a> procs
636 Check command object for the `check_procs` plugin.
638 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
641 ---------------------|--------------
642 procs_warning | **Optional.** The process count warning threshold. Defaults to 250.
643 procs_critical | **Optional.** The process count critical threshold. Defaults to 400.
644 procs_metric | **Optional.** Check thresholds against metric.
645 procs_timeout | **Optional.** Seconds before plugin times out.
646 procs_traditional | **Optional.** Filter own process the traditional way by PID instead of /proc/pid/exe. Defaults to false.
647 procs_state | **Optional.** Only scan for processes that have one or more of the status flags you specify.
648 procs_ppid | **Optional.** Only scan for children of the parent process ID indicated.
649 procs_vsz | **Optional.** Only scan for processes with VSZ higher than indicated.
650 procs_rss | **Optional.** Only scan for processes with RSS higher than indicated.
651 procs_pcpu | **Optional.** Only scan for processes with PCPU higher than indicated.
652 procs_user | **Optional.** Only scan for processes with user name or ID indicated.
653 procs_argument | **Optional.** Only scan for processes with args that contain STRING.
654 procs_argument_regex | **Optional.** Only scan for processes with args that contain the regex STRING.
655 procs_command | **Optional.** Only scan for exact matches of COMMAND (without path).
656 procs_nokthreads | **Optional.** Only scan for non kernel threads. Defaults to false.
659 ## <a id="plugin-check-command-simap"></a> simap
661 Check command object for the `check_simap` plugin.
663 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
666 ----------------|--------------
667 simap_address | **Optional.** The host's address. Defaults to "$address$" if the host's `address` attribute is set, "$address6$" otherwise.
668 simap_port | **Optional.** The host's port.
671 ## <a id="plugin-check-command-smtp"></a> smtp
673 Check command object for the `check_smtp` plugin.
675 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
678 ---------------------|--------------
679 smtp_address | **Optional.** The host's address. Defaults to "$address$" if the host's `address` attribute is set, "$address6$" otherwise.
680 smtp_port | **Optional.** The port that should be checked. Defaults to 25.
681 smtp_mail_from | **Optional.** Test a MAIL FROM command with the given email address.
684 ## <a id="plugin-check-command-snmp"></a> snmp
686 Check command object for the `check_snmp` plugin.
688 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
691 --------------------|--------------
692 snmp_address | **Optional.** The host's address. Defaults to "$address$" if the host's `address` attribute is set, "$address6$" otherwise.
693 snmp_oid | **Required.** The SNMP OID.
694 snmp_community | **Optional.** The SNMP community. Defaults to "public".
695 snmp_warn | **Optional.** The warning threshold.
696 snmp_crit | **Optional.** The critical threshold.
697 snmp_string | **Optional.** Return OK state if the string matches exactly with the output value
698 snmp_ereg | **Optional.** Return OK state if extended regular expression REGEX matches with the output value
699 snmp_eregi | **Optional.** Return OK state if case-insensitive extended REGEX matches with the output value
700 snmp_label | **Optional.** Prefix label for output value
701 snmp_invert_search | **Optional.** Invert search result and return CRITICAL state if found
702 snmp_units | **Optional.** Units label(s) for output value (e.g., 'sec.').
703 snmp_version | **Optional.** Version to use. E.g. 1, 2, 2c or 3.
704 snmp_miblist | **Optional.** MIB's to use, comma separated. Defaults to "ALL".
705 snmp_rate_multiplier | **Optional.** Converts rate per second. For example, set to 60 to convert to per minute.
706 snmp_rate | **Optional.** Boolean. Enable rate calculation.
707 snmp_getnext | **Optional.** Boolean. Use SNMP GETNEXT. Defaults to false.
708 snmp_timeout | **Optional.** The command timeout in seconds. Defaults to 10 seconds.
710 ## <a id="plugin-check-command-snmpv3"></a> snmpv3
712 Check command object for the `check_snmp` plugin, using SNMPv3 authentication and encryption options.
714 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
717 ------------------|--------------
718 snmpv3_address | **Optional.** The host's address. Defaults to "$address$" if the host's `address` attribute is set, "$address6$" otherwise.
719 snmpv3_user | **Required.** The username to log in with.
720 snmpv3_auth_alg | **Optional.** The authentication algorithm. Defaults to SHA.
721 snmpv3_seclevel | **Optional.** The security level. Defaults to authPriv.
722 snmpv3_auth_key | **Required,** The authentication key. Required if `snmpv3_seclevel` is set to `authPriv` otherwise optional.
723 snmpv3_priv_alg | **Optional.** The encryption algorithm. Defaults to AES.
724 snmpv3_priv_key | **Required.** The encryption key.
725 snmpv3_oid | **Required.** The SNMP OID.
726 snmpv3_warn | **Optional.** The warning threshold.
727 snmpv3_crit | **Optional.** The critical threshold.
728 snmpv3_label | **Optional.** Prefix label for output value.
730 ## <a id="plugin-check-command-snmp-uptime"></a> snmp-uptime
732 Check command object for the `check_snmp` plugin.
734 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
737 ----------------|--------------
738 snmp_address | **Optional.** The host's address. Defaults to "$address$" if the host's `address` attribute is set, "$address6$" otherwise.
739 snmp_oid | **Optional.** The SNMP OID. Defaults to "1.3.6.1.2.1.1.3.0".
740 snmp_community | **Optional.** The SNMP community. Defaults to "public".
743 ## <a id="plugin-check-command-spop"></a> spop
745 Check command object for the `check_spop` plugin.
747 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
750 ----------------|--------------
751 spop_address | **Optional.** The host's address. Defaults to "$address$" if the host's `address` attribute is set, "$address6$" otherwise.
752 spop_port | **Optional.** The host's port.
755 ## <a id="plugin-check-command-ssh"></a> ssh
757 Check command object for the `check_ssh` plugin.
759 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
762 ----------------|--------------
763 ssh_address | **Optional.** The host's address. Defaults to "$address$" if the host's `address` attribute is set, "$address6$" otherwise.
764 ssh_port | **Optional.** The port that should be checked. Defaults to 22.
765 ssh_timeout | **Optional.** Seconds before connection times out. Defaults to 10.
768 ## <a id="plugin-check-command-ssl"></a> ssl
770 Check command object for the `check_tcp` plugin, using ssl-related options.
772 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
775 ------------------------------|--------------
776 ssl_address | **Optional.** The host's address. Defaults to "$address$" if the host's `address` attribute is set, "$address6$" otherwise.
777 ssl_port | **Required.** The port that should be checked.
778 ssl_timeout | **Optional.** Timeout in seconds for the connect and handshake. The plugin default is 10 seconds.
779 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.
780 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.
783 ## <a id="plugin-check-command-ssmtp"></a> ssmtp
785 Check command object for the `check_ssmtp` plugin.
787 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
790 ----------------|--------------
791 ssmtp_address | **Required.** The host's address. Defaults to "$address$" if the host's `address` attribute is set, "$address6$" otherwise.
792 ssmtp_port | **Optional.** The port that should be checked. Defaults to 465.
795 ## <a id="plugin-check-command-swap"></a> swap
797 Check command object for the `check_swap` plugin.
799 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
802 ----------------|--------------
803 swap_wfree | **Optional.** The free swap space warning threshold in %. Defaults to 50.
804 swap_cfree | **Optional.** The free swap space critical threshold in %. Defaults to 25.
807 ## <a id="plugin-check-command-tcp"></a> tcp
809 Check command object for the `check_tcp` plugin.
811 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
814 ----------------|--------------
815 tcp_address | **Optional.** The host's address. Defaults to "$address$" if the host's `address` attribute is set, "$address6$" otherwise.
816 tcp_port | **Required.** The port that should be checked.
817 tcp_expect | **Optional.** String to expect in server response (may be repeated).
818 tcp_all | **Optional.** All expect strings need to occur in server response. Defaults to false.
819 tcp_escape_send | **Optional.** Enable usage of \n, \r, \t or \\\\ in send string.
820 tcp_send | **Optional.** String to send to the server.
821 tcp_escape_quit | **Optional.** Enable usage of \n, \r, \t or \\\\ in quit string.
822 tcp_quit | **Optional.** String to send server to initiate a clean close of the connection.
823 tcp_refuse | **Optional.** Accept TCP refusals with states ok, warn, crit. Defaults to crit.
824 tcp_mismatch | **Optional.** Accept expected string mismatches with states ok, warn, crit. Defaults to warn.
825 tcp_jail | **Optional.** Hide output from TCP socket.
826 tcp_maxbytes | **Optional.** Close connection once more than this number of bytes are received.
827 tcp_delay | **Optional.** Seconds to wait between sending string and polling for response.
828 tcp_certificate | **Optional.** Minimum number of days a certificate has to be valid. 1st value is number of days for warning, 2nd is critical (if not specified: 0) - seperated by comma.
829 tcp_ssl | **Optional.** Use SSL for the connection. Defaults to false.
830 tcp_wtime | **Optional.** Response time to result in warning status (seconds).
831 tcp_ctime | **Optional.** Response time to result in critical status (seconds).
832 tcp_timeout | **Optional.** Seconds before connection times out. Defaults to 10.
835 ## <a id="plugin-check-command-udp"></a> udp
837 Check command object for the `check_udp` plugin.
839 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
842 ----------------|--------------
843 udp_address | **Optional.** The host's address. Defaults to "$address$" if the host's `address` attribute is set, "$address6$" otherwise.
844 udp_port | **Required.** The port that should be checked.
845 udp_send | **Required.** The payload to send in the UDP datagram.
846 udp_expect | **Required.** The payload to expect in the response datagram.
847 udp_quit | **Optional.** The payload to send to 'close' the session.
850 ## <a id="plugin-check-command-ups"></a> ups
852 Check command object for the `check_ups` plugin.
854 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
857 ----------------|--------------
858 ups_address | **Required.** The address of the host running upsd. Defaults to "$address$" if the host's `address` attribute is set, "$address6$" otherwise.
859 ups_name | **Required.** The UPS name. Defaults to `ups`.
860 ups_port | **Optional.** The port to which to connect. Defaults to 3493.
861 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`.
862 ups_warning | **Optional.** The warning threshold for the selected variable.
863 ups_critical | **Optional.** The critical threshold for the selected variable.
864 ups_celsius | **Optional.** Display the temperature in degrees Celsius instead of Fahrenheit. Defaults to `false`.
865 ups_timeout | **Optional.** The number of seconds before the connection times out. Defaults to 10.
868 ## <a id="plugin-check-command-users"></a> users
870 Check command object for the `check_users` plugin.
872 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
875 ----------------|--------------
876 users_wgreater | **Optional.** The user count warning threshold. Defaults to 20.
877 users_cgreater | **Optional.** The user count critical threshold. Defaults to 50.
880 # <a id="windows-plugins"></a>Icinga 2 Windows plugins
882 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.
884 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:
886 include <windows-plugins>
888 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.
891 ## <a id="windows-plugins-thresholds"></a>Threshold syntax
893 So not specified differently the thresholds for the plugins all follow the same pattern
896 :------------|:----------
897 "29" | The threshold is 29.
898 "!29" | The threshold is 29, but the negative of the result is returned.
899 "[10-40]" | The threshold is a range from (including) 20 to 40, a value inside means the threshold has been exceeded.
900 "![10-40]" | Same as above, but the result is inverted.
903 ## <a id="windows-plugins-disk-windows"></a>disk-windows
905 Check command object for the `check_disk.exe` plugin.
906 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.).
911 :---------------|:------------
912 disk\_win\_warn | **Optional**. The warning threshold.
913 disk\_win\_crit | **Optional**. The critical threshold.
914 disk\_win\_path | **Optional**. Check only these paths, default checks all.
915 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.
918 ## <a id="windows-plugins-load-windows"></a>load-windows
920 Check command object for the `check_load.exe` plugin.
921 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).
926 :---------------|:------------
927 load\_win\_warn | **Optional**. The warning threshold.
928 load\_win\_crit | **Optional**. The critical threshold.
931 ## <a id="windows-plugins-memory-windows"></a>memory-windows
933 Check command object for the `check_memory.exe` plugin.
934 The memory collection is instant.
939 :-----------------|:------------
940 memory\_win\_warn | **Optional**. The warning threshold.
941 memory\_win\_crit | **Optional**. The critical threshold.
942 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.
945 ## <a id="windows-plugins-network-windows"></a>network-windows
947 Check command object for the `check_network.exe` plugin.
948 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).
953 :------------------|:------------
954 network\_win\_warn | **Optional**. The warning threshold.
955 network\_win\_crit | **Optional**. The critical threshold.
958 ## <a id="windows-plugins-permon-windows"></a>perfmon-windows
960 Check command object for the `check_perfmon.exe` plugin.
961 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`.
963 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"`
968 :---------------------|:------------
969 perfmon\_win\_warn | **Optional**. The warning threshold.
970 perfmon\_win\_crit | **Optional**. The critical threshold.
971 perfmon\_win\_counter | **Required**. The Performance Counter to use. Ex. `\Processor(_Total)\% Idle Time`.
972 perfmon\_win\_wait | **Optional**. Time in milliseconds to wait between data collection (default: 1000).
973 perfmon\_win\_type | **Optional**. Format in which to expect perfomance values. Possible are: long, int64 and double (default).
976 ## <a id="windows-plugins-ping-windows"></a>ping-windows
978 Check command object for the `check_ping.exe` plugin.
979 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.
984 :------------------|:------------
985 ping\_win\_warn | **Optional**. The warning threshold. RTA and package loss seperated by comma.
986 ping\_win\_crit | **Optional**. The critical threshold. RTA and package loss seperated by comma.
987 ping\_win\_address | **Required**. An IPv4 or IPv6 address
988 ping\_win\_packets | **Optional**. Number of packages to send. Default: 5.
989 ping\_win\_timeout | **Optional**. The timeout in milliseconds. Default: 1000
992 ## <a id="windows-plugins-procs-windows"></a>procs-windows
994 Check command object for `check_procs.exe` plugin.
995 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.
1000 :----------------|:------------
1001 procs\_win\_warn | **Optional**. The warning threshold.
1002 procs\_win\_crit | **Optional**. The critical threshold.
1003 procs\_win\_user | **Optional**. Count this useres processes.
1006 ## <a id="windows-plugins-service-windows"></a>service-windows
1008 Check command object for `check_service.exe` plugin.
1009 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.
1014 :---------------------|:------------
1015 service\_win\_warn | **Optional**. Warn when service is not running.
1016 service\_win\_service | **Required**. The critical threshold.
1019 ## <a id="windows-plugins-swap-windows"></a>swap-windows
1021 Check command object for `check_swap.exe` plugin.
1022 The data collection is instant.
1027 :---------------|:------------
1028 swap\_win\_warn | **Optional**. The warning threshold.
1029 swap\_win\_crit | **Optional**. The critical threshold.
1030 swap\_win\_unit | **Optional**. The unit to display the received value in, thresholds are interpreted in this unit. Defaults to "mb" (megabyte).
1033 ## <a id="windows-plugins-update-windows"></a>update-windows
1035 Check command object for `check_update.exe` plugin.
1036 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.
1041 :-------------------|:------------
1042 update\_win\_warn | If set returns warning when important updates are available
1043 update\_win\_crit | If set return critical when important updates that require a reboot are available.
1044 update\_win\_reboot | Set to treat 'may need update' as 'definitely needs update'
1047 ## <a id="windows-plugins-uptime-windows"></a>uptime-windows
1049 Check command opject for `check_uptime.exe` plugin.
1050 Uses GetTickCount64 to get the uptime, so boot time is not included.
1055 :-----------------|:------------
1056 uptime\_win\_warn | **Optional**. The warning threshold.
1057 uptime\_win\_crit | **Optional**. The critical threshold.
1058 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).
1061 ## <a id="windows-plugins-users-windows"></a>users-windows
1063 Check command object for `check_users.exe` plugin.
1068 :----------------|:------------
1069 users\_win\_warn | **Optional**. The warning threshold.
1070 users\_win\_crit | **Optional**. The critical threshold.
1073 # <a id="nscp-plugin-check-commands"></a> NSClient++ Check Commands
1075 Icinga 2 can use the `nscp client` command to run arbitrary NSClient++ checks.
1077 You can enable these check commands by adding the following the include directive in your
1078 [icinga2.conf](4-configuring-icinga-2.md#icinga2-conf) configuration file:
1082 You can also optionally specify an alternative installation directory for NSClient++ by adding
1083 the NscpPath constant in your [constants.conf](4-configuring-icinga-2.md#constants-conf) configuration
1086 const NscpPath = "C:\\Program Files (x86)\\NSClient++"
1088 By default Icinga 2 uses the Microsoft Installer API to determine where NSClient++ is installed. It should
1089 not be necessary to manually set this constant.
1091 Note that it is not necessary to run NSClient++ as a Windows service for these commands to work.
1093 ## <a id="nscp-check-local"></a> nscp-local
1095 Check command object for NSClient++
1097 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
1100 ----------------|--------------
1101 nscp_log_level | **Optional.** The log level. Defaults to "critical".
1102 nscp_load_all | **Optional.** Whether to load all modules. Defaults to true.
1103 nscp_boot | **Optional.** Whether to use the --boot option. Defaults to true.
1104 nscp_query | **Required.** The NSClient++ query. Try `nscp client -q x` for a list.
1105 nscp_arguments | **Optional.** An array of query arguments.
1107 ## <a id="nscp-check-local-cpu"></a> nscp-local-cpu
1109 Check command object for the `check_cpu` NSClient++ plugin.
1111 This command has the same custom attributes like the `nscp-local` check command.
1113 ## <a id="nscp-check-local-memory"></a> nscp-local-memory
1115 Check command object for the `check_memory` NSClient++ plugin.
1117 This command has the same custom attributes like the `nscp-local` check command.
1119 ## <a id="nscp-check-local-os-version"></a> nscp-local-os-version
1121 Check command object for the `check_os_version` NSClient++ plugin.
1123 This command has the same custom attributes like the `nscp-local` check command.
1125 ## <a id="nscp-check-local-pagefile"></a> nscp-local-pagefile
1127 Check command object for the `check_pagefile` NSClient++ plugin.
1129 This command has the same custom attributes like the `nscp-local` check command.
1131 ## <a id="nscp-check-local-process"></a> nscp-local-process
1133 Check command object for the `check_process` NSClient++ plugin.
1135 This command has the same custom attributes like the `nscp-local` check command.
1137 ## <a id="nscp-check-local-service"></a> nscp-local-service
1139 Check command object for the `check_service` NSClient++ plugin.
1141 This command has the same custom attributes like the `nscp-local` check command.
1143 ## <a id="nscp-check-local-uptime"></a> nscp-local-uptime
1145 Check command object for the `check_uptime` NSClient++ plugin.
1147 This command has the same custom attributes like the `nscp-local` check command.
1149 ## <a id="nscp-check-local-version"></a> nscp-local-version
1151 Check command object for the `check_version` NSClient++ plugin.
1153 This command has the same custom attributes like the `nscp-local` check command.
1155 ## <a id="nscp-check-local-disk"></a> nscp-local-disk
1157 Check command object for the `check_drivesize` NSClient++ plugin.
1159 This command has the same custom attributes like the `nscp-local` check command.
1161 # <a id="snmp-manubulon-plugin-check-commands"></a> SNMP Manubulon Plugin Check Commands
1163 The `SNMP Manubulon Plugin Check Commands` provide example configuration for plugin check
1164 commands provided by the [SNMP Manubulon project](http://nagios.manubulon.com/index_snmp.html).
1166 The SNMP manubulon plugin check commands assume that the global constant named `ManubulonPluginDir`
1167 is set to the path where the Manubublon SNMP plugins are installed.
1169 You can enable these plugin check commands by adding the following the include directive in your
1170 [icinga2.conf](4-configuring-icinga-2.md#icinga2-conf) configuration file:
1174 ## Checks by Host Type
1176 **N/A** : Not available for this type.
1178 **SNMP** : Available for simple SNMP query.
1182 **Specific** : Script name for platform specific checks.
1185 Host type | Interface | storage | load/cpu | mem | process | env | specific
1186 ------------------------|------------|----------|-----------|-----|----------|-----|-------------------------
1187 Linux | Yes | Yes | Yes | Yes | Yes | No |
1188 Windows | Yes | Yes | Yes | Yes | Yes | No | check_snmp_win.pl
1189 Cisco router/switch | Yes | N/A | Yes | Yes | N/A | Yes |
1190 HP router/switch | Yes | N/A | Yes | Yes | N/A | No |
1191 Bluecoat proxy | Yes | SNMP | Yes | SNMP| No | Yes |
1192 CheckPoint on SPLAT | Yes | Yes | Yes | Yes | Yes | No | check_snmp_cpfw.pl
1193 CheckPoint on Nokia IP | Yes | Yes | Yes | No | ?? | No | check_snmp_vrrp.pl
1194 Boostedge | Yes | Yes | Yes | Yes | ?? | No | check_snmp_boostedge.pl
1195 AS400 | Yes | Yes | Yes | Yes | No | No |
1196 NetsecureOne Netbox | Yes | Yes | Yes | ?? | Yes | No |
1197 Radware Linkproof | Yes | N/A | SNMP | SNMP| No | No | check_snmp_linkproof_nhr <br> check_snmp_vrrp.pl
1198 IronPort | Yes | SNMP | SNMP | SNMP| No | Yes |
1199 Cisco CSS | Yes | ?? | Yes | Yes | No | ?? | check_snmp_css.pl
1202 ## <a id="plugin-check-command-snmp-load"></a> snmp-load
1204 Check command object for the [check_snmp_load.pl](http://nagios.manubulon.com/snmp_load.html) plugin.
1206 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
1210 ------------------------|--------------
1211 snmp_address | **Optional.** The host's address. Defaults to "$address$" if the host's `address` attribute is set, "$address6$" otherwise.
1212 snmp_nocrypt | **Optional.** Define SNMP encryption. If set **snmp_v3** needs to be set. Defaults to false.
1213 snmp_community | **Optional.** The SNMP community. Defaults to "public".
1214 snmp_port | **Optional.** The SNMP port connection.
1215 snmp_v2 | **Optional.** SNMP version to 2c. Defaults to false.
1216 snmp_v3 | **Optional.** SNMP version to 3. Defaults to false.
1217 snmp_login | **Optional.** SNMP version 3 username. Defaults to "snmpuser".
1218 snmp_password | **Required.** SNMP version 3 password. No value defined as default.
1219 snmp_v3_use_privpass | **Optional.** Define to use SNMP version 3 priv password. Defaults to false.
1220 snmp_authprotocol | **Optional.** SNMP version 3 authentication protocol. Defaults to "md5,des".
1221 snmp_privpass | **Required.** SNMP version 3 priv password. No value defined as default.
1222 snmp_warn | **Optional.** The warning threshold. Change the `snmp_load_type` var to "netsl" for using 3 values.
1223 snmp_crit | **Optional.** The critical threshold. Change the `snmp_load_type` var to "netsl" for using 3 values.
1224 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.
1225 snmp_perf | **Optional.** Enable perfdata values. Defaults to true.
1226 snmp_timeout | **Optional.** The command timeout in seconds. Defaults to 5 seconds.
1228 ## <a id="plugin-check-command-snmp-memory"></a> snmp-memory
1230 Check command object for the [check_snmp_mem.pl](http://nagios.manubulon.com/snmp_mem.html) plugin.
1232 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
1235 ------------------------|--------------
1236 snmp_address | **Optional.** The host's address. Defaults to "$address$" if the host's `address` attribute is set, "$address6$" otherwise.
1237 snmp_nocrypt | **Optional.** Define SNMP encryption. If set **snmp_v3** needs to be set. Defaults to false.
1238 snmp_community | **Optional.** The SNMP community. Defaults to "public".
1239 snmp_port | **Optional.** The SNMP port connection.
1240 snmp_v2 | **Optional.** SNMP version to 2c. Defaults to false.
1241 snmp_v3 | **Optional.** SNMP version to 3. Defaults to false.
1242 snmp_login | **Optional.** SNMP version 3 username. Defaults to "snmpuser".
1243 snmp_password | **Required.** SNMP version 3 password. No value defined as default.
1244 snmp_v3_use_privpass | **Optional.** Define to use SNMP version 3 priv password. Defaults to false.
1245 snmp_authprotocol | **Optional.** SNMP version 3 authentication protocol. Defaults to "md5,des".
1246 snmp_privpass | **Required.** SNMP version 3 priv password. No value defined as default.
1247 snmp_warn | **Optional.** The warning threshold.
1248 snmp_crit | **Optional.** The critical threshold.
1249 snmp_is_cisco | **Optional.** Change OIDs for Cisco switches. Defaults to false.
1250 snmp_perf | **Optional.** Enable perfdata values. Defaults to true.
1251 snmp_timeout | **Optional.** The command timeout in seconds. Defaults to 5 seconds.
1253 ## <a id="plugin-check-command-snmp-storage"></a> snmp-storage
1255 Check command object for the [check_snmp_storage.pl](http://nagios.manubulon.com/snmp_storage.html) plugin.
1257 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
1260 ------------------------|--------------
1261 snmp_address | **Optional.** The host's address. Defaults to "$address$" if the host's `address` attribute is set, "$address6$" otherwise.
1262 snmp_nocrypt | **Optional.** Define SNMP encryption. If set **snmp_v3** needs to be set. Defaults to false.
1263 snmp_community | **Optional.** The SNMP community. Defaults to "public".
1264 snmp_port | **Optional.** The SNMP port connection.
1265 snmp_v2 | **Optional.** SNMP version to 2c. Defaults to false.
1266 snmp_v3 | **Optional.** SNMP version to 3. Defaults to false.
1267 snmp_login | **Optional.** SNMP version 3 username. Defaults to "snmpuser".
1268 snmp_password | **Required.** SNMP version 3 password. No value defined as default.
1269 snmp_v3_use_privpass | **Optional.** Define to use SNMP version 3 priv password. Defaults to false.
1270 snmp_authprotocol | **Optional.** SNMP version 3 authentication protocol. Defaults to "md5,des".
1271 snmp_privpass | **Required.** SNMP version 3 priv password. No value defined as default.
1272 snmp_warn | **Optional.** The warning threshold.
1273 snmp_crit | **Optional.** The critical threshold.
1274 snmp_storage_name | **Optional.** Storage name. Default to regex "^/$$". More options available in the [snmp storage](http://nagios.manubulon.com/snmp_storage.html) documentation.
1275 snmp_perf | **Optional.** Enable perfdata values. Defaults to true.
1276 snmp_timeout | **Optional.** The command timeout in seconds. Defaults to 5 seconds.
1278 ## <a id="plugin-check-command-snmp-interface"></a> snmp-interface
1280 Check command object for the [check_snmp_int.pl](http://nagios.manubulon.com/snmp_int.html) plugin.
1282 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
1285 ----------------------------|--------------
1286 snmp_address | **Optional.** The host's address. Defaults to "$address$" if the host's `address` attribute is set, "$address6$" otherwise.
1287 snmp_nocrypt | **Optional.** Define SNMP encryption. If set **snmp_v3** needs to be set. Defaults to false.
1288 snmp_community | **Optional.** The SNMP community. Defaults to "public".
1289 snmp_port | **Optional.** The SNMP port connection.
1290 snmp_v2 | **Optional.** SNMP version to 2c. Defaults to false.
1291 snmp_v3 | **Optional.** SNMP version to 3. Defaults to false.
1292 snmp_login | **Optional.** SNMP version 3 username. Defaults to "snmpuser".
1293 snmp_password | **Required.** SNMP version 3 password. No value defined as default.
1294 snmp_v3_use_privpass | **Optional.** Define to use SNMP version 3 priv password. Defaults to false.
1295 snmp_authprotocol | **Optional.** SNMP version 3 authentication protocol. Defaults to "md5,des".
1296 snmp_privpass | **Required.** SNMP version 3 priv password. No value defined as default.
1297 snmp_warn | **Optional.** The warning threshold.
1298 snmp_crit | **Optional.** The critical threshold.
1299 snmp_interface | **Optional.** Network interface name. Default to regex "eth0".
1300 snmp_interface_perf | **Optional.** Check the input/ouput bandwidth of the interface. Defaults to true.
1301 snmp_interface_label | **Optional.** Add label before speed in output: in=, out=, errors-out=, etc...
1302 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.
1303 snmp_interface_percent | **Optional.** Output performance data in % of max speed. Defaults to false.
1304 snmp_interface_kbits | **Optional.** Make the warning and critical levels in KBits/s. Defaults to true.
1305 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.
1306 snmp_interface_64bit | **Optional.** Use 64 bits counters instead of the standard counters when checking bandwidth & performance data for interface >= 1Gbps. Defaults to false.
1307 snmp_interface_errors | **Optional.** Add error & discard to Perfparse output. Defaults to true.
1308 snmp_interface_noregexp | **Optional.** Do not use regexp to match interface name in description OID. Defaults to false.
1309 snmp_interface_delta | **Optional.** Delta time of perfcheck. Defaults to "300" (5 min).
1310 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.
1311 snmp_perf | **Optional.** Enable perfdata values. Defaults to true.
1312 snmp_timeout | **Optional.** The command timeout in seconds. Defaults to 5 seconds.
1314 ## <a id="plugin-check-command-snmp-process"></a> snmp-process
1316 Check command object for the [check_snmp_process.pl](http://nagios.manubulon.com/snmp_process.html) plugin.
1318 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
1321 ------------------------|--------------
1322 snmp_address | **Optional.** The host's address. Defaults to "$address$" if the host's `address` attribute is set, "$address6$" otherwise.
1323 snmp_nocrypt | **Optional.** Define SNMP encryption. If set **snmp_v3** needs to be set. Defaults to false.
1324 snmp_community | **Optional.** The SNMP community. Defaults to "public".
1325 snmp_port | **Optional.** The SNMP port connection.
1326 snmp_v2 | **Optional.** SNMP version to 2c. Defaults to false.
1327 snmp_v3 | **Optional.** SNMP version to 3. Defaults to false.
1328 snmp_login | **Optional.** SNMP version 3 username. Defaults to "snmpuser".
1329 snmp_password | **Required.** SNMP version 3 password. No value defined as default.
1330 snmp_v3_use_privpass | **Optional.** Define to use SNMP version 3 priv password. Defaults to false.
1331 snmp_authprotocol | **Optional.** SNMP version 3 authentication protocol. Defaults to "md5,des".
1332 snmp_privpass | **Required.** SNMP version 3 priv password. No value defined as default..
1333 snmp_warn | **Optional.** The warning threshold.
1334 snmp_crit | **Optional.** The critical threshold.
1335 snmp_process_name | **Optional.** Name of the process (regexp). No trailing slash!. Defaults to ".*".
1336 snmp_perf | **Optional.** Enable perfdata values. Defaults to true.
1337 snmp_timeout | **Optional.** The command timeout in seconds. Defaults to 5 seconds.
1339 # <a id="plugins-contrib"></a> Plugins Contrib
1341 The Plugins contrib collects various contributed command definitions.
1343 These check commands assume that the global constant named `PluginContribDir`
1344 is set to the path where the user installs custom plugins and can be enabled by uncommenting the corresponding line in icinga2.conf.
1346 ## <a id="plugins-contrib-databases"></a> Databases
1348 All database plugins go in this category.
1350 ### <a id="plugins-contrib-command-mssql_health"></a> mssql_health
1352 The plugin `mssql_health` utilises Perl DBD::Sybase based on FreeTDS to connect to MSSQL databases for monitoring.
1353 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).
1355 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
1358 ---------------------------------|------------------------------------------------------------------------------------------------------------------------------
1359 mssql_health_hostname | **Optional.** Specifies the database hostname or address. No default because you typically use "mssql_health_server".
1360 mssql_health_port | **Optional.** Specifies the database port. No default because you typically use "mssql_health_server".
1361 mssql_health_server | **Optional.** The name of a predefined connection (in freetds.conf).
1362 mssql_health_currentdb | **Optional.** The name of a database which is used as the current database for the connection.
1363 mssql_health_username | **Optional.** The username for the database connection.
1364 mssql_health_password | **Optional.** The password for the database connection.
1365 mssql_health_warning | **Optional.** The warning threshold depending on the mode.
1366 mssql_health_critical | **Optional.** The critical threshold depending on the mode.
1367 mssql_health_mode | **Required.** The mode uses predefined keywords for the different checks. For example "connection-time", "database-free" or "sql".
1368 mssql_health_name | **Optional.** Depending on the mode this could be the database name or a SQL statement.
1369 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.
1370 mssql_health_regexp | **Optional.** If set to true, "mssql_health_name" will be interpreted as a regular expression. Defaults to false.
1371 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".
1372 mssql_health_offlineok | **Optional.** Set this to true, if offline databases are perfectly ok for you. Defaults to false.
1373 mssql_health_commit | **Optional.** Set this to true to turn on autocommit for the dbd::sybase module. Defaults to false.
1375 ### <a id="plugins-contrib-command-mysql_health"></a> mysql_health
1377 The plugin `mysql_health` utilises Perl DBD::MySQL to connect to MySQL databases for monitoring.
1378 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).
1380 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
1383 ---------------------------------|------------------------------------------------------------------------------------------------------------------------------
1384 mysql_health_hostname | **Required.** Specifies the database hostname or address. Defaults to "$address$" or "$address6$" if the `address` attribute is not set.
1385 mysql_health_port | **Optional.** Specifies the database port. Defaults to 3306 (or 1186 for "mysql_health_mode" cluster).
1386 mysql_health_socket | **Optional.** Specifies the database unix socket. No default.
1387 mysql_health_username | **Optional.** The username for the database connection.
1388 mysql_health_password | **Optional.** The password for the database connection.
1389 mysql_health_database | **Optional.** The database to connect to. Defaults to information_schema.
1390 mysql_health_warning | **Optional.** The warning threshold depending on the mode.
1391 mysql_health_critical | **Optional.** The critical threshold depending on the mode.
1392 mysql_health_mode | **Required.** The mode uses predefined keywords for the different checks. For example "connection-time", "slave-lag" or "sql".
1393 mysql_health_name | **Optional.** The SQL statement to be executed with "mysql_health_mode" sql.
1394 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.
1395 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".
1396 mysql_health_labelformat | **Optional.** One of those formats pnp4nagios or groundwork. Defaults to pnp4nagios.
1398 ### <a id="plugins-contrib-command-oracle_health"></a> oracle_health
1400 The plugin `oracle_health` utilises Perl DBD::Oracle based on oracle-instantclient-sdk or sqlplus to connect to Oracle databases for monitoring.
1401 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).
1403 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
1406 ---------------------------------|------------------------------------------------------------------------------------------------------------------------------
1407 oracle_health_connect | **Required.** Specifies the database connection string (from tnsnames.ora).
1408 oracle_health_username | **Optional.** The username for the database connection.
1409 oracle_health_password | **Optional.** The password for the database connection.
1410 oracle_health_warning | **Optional.** The warning threshold depending on the mode.
1411 oracle_health_critical | **Optional.** The critical threshold depending on the mode.
1412 oracle_health_mode | **Required.** The mode uses predefined keywords for the different checks. For example "connection-time", "flash-recovery-area-usage" or "sql".
1413 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.
1414 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.
1415 oracle_health_regexp | **Optional.** If set to true, "oracle_health_name" will be interpreted as a regular expression. Defaults to false.
1416 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".
1417 oracle_health_ident | **Optional.** If set to true outputs instance and database names. Defaults to false.
1418 oracle_health_commit | **Optional.** Set this to true to turn on autocommit for the dbd::oracle module. Defaults to false.
1419 oracle_health_noperfdata | **Optional.** Set this to true if you want to disable perfdata. Defaults to false.
1424 --------------------|------------------------------------------------------------------------------------------------------------------------------------------
1425 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".
1426 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".
1428 ### <a id="plugins-contrib-command-postgres"></a> postgres
1430 The plugin `postgres` utilises the psql binary to connect to PostgreSQL databases for monitoring.
1431 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).
1433 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
1436 ---------------------------------|------------------------------------------------------------------------------------------------------------------------------
1437 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.
1438 postgres_port | **Optional.** Specifies the database port. Defaults to 5432.
1439 postgres_dbname | **Optional.** Specifies the database name to connect to. Defaults to "postgres" or "template1".
1440 postgres_dbuser | **Optional.** The username for the database connection. Defaults to "postgres".
1441 postgres_dbpass | **Optional.** The password for the database connection. You can use a .pgpass file instead.
1442 postgres_dbservice | **Optional.** Specifies the service name to use inside of pg_service.conf.
1443 postgres_warning | **Optional.** Specifies the warning threshold, range depends on the action.
1444 postgres_critical | **Optional.** Specifies the critical threshold, range depends on the action.
1445 postgres_include | **Optional.** Specifies name(s) items to specifically include (e.g. tables), depends on the action.
1446 postgres_exclude | **Optional.** Specifies name(s) items to specifically exclude (e.g. tables), depends on the action.
1447 postgres_includeuser | **Optional.** Include objects owned by certain users.
1448 postgres_excludeuser | **Optional.** Exclude objects owned by certain users.
1449 postgres_standby | **Optional.** Assume that the server is in continious WAL recovery mode if set to true. Defaults to false.
1450 postgres_production | **Optional.** Assume that the server is in production mode if set to true. Defaults to false.
1451 postgres_action | **Required.** Determines the test executed.
1452 postgres_unixsocket | **Optional.** If "postgres_unixsocket" is set to true the unix socket is used instead of an address. Defaults to false.
1454 ### <a id="plugins-contrib-command-mongodb"></a> mongodb
1456 The plugin `mongodb` utilises Python PyMongo.
1457 For development check [https://github.com](https://github.com/mzupan/nagios-plugin-mongodb).
1459 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
1462 ---------------------------------|------------------------------------------------------------------------------------------------------------------------------
1463 mongodb_host | **Required.** Specifies the hostname or address.
1464 mongodb_port | **Required.** The port mongodb is runnung on.
1465 mongodb_user | **Optional.** The username you want to login as
1466 mongodb_passwd | **Optional.** The password you want to use for that user
1467 mongodb_warning | **Optional.** The warning threshold we want to set
1468 mongodb_critical | **Optional.** The critical threshold we want to set
1469 mongodb_action | **Required.** The action you want to take
1470 mongodb_maxlag | **Optional.** Get max replication lag (for replication_lag action only)
1471 mongodb_mappedmemory | **Optional.** Get mapped memory instead of resident (if resident memory can not be read)
1472 mongodb_perfdata | **Optional.** Enable output of Nagios performance data
1473 mongodb_database | **Optional.** Specify the database to check
1474 mongodb_alldatabases | **Optional.** Check all databases (action database_size)
1475 mongodb_ssl | **Optional.** Connect using SSL
1476 mongodb_replicaset | **Optional.** Connect to replicaset
1477 mongodb_querytype | **Optional.** The query type to check [query|insert|update|delete|getmore|command] from queries_per_second
1478 mongodb_collection | **Optional.** Specify the collection to check
1479 mongodb_sampletime | **Optional.** Time used to sample number of pages faults
1481 ### <a id="plugins-contrib-command-elasticsearch"></a> elasticsearch
1483 An ElasticSearch availability and performance monitoring plugin for Nagios provided by [Anchor](http://www.anchor.com.au) on [https://github.com](https://github.com/anchor/nagios-plugin-elasticsearch).
1484 It ulitizes the API so requires HTTP enabled for your elasticsearch node.
1487 -----------------------------|-------------------------------------------------------------------------------------------------------
1488 elasticsearch_failuredomain | **Optional.** A comma-separated list of ElasticSearch attributes that make up your cluster's failure domain.
1489 elasticsearch_host | **Optional.** Hostname or network address to probe. Defaults to 'localhost'.
1490 elasticsearch_masternodes | **Optional.** Issue a warning if the number of master-eligible nodes in the cluster drops below this number. By default, do not monitor the number of nodes in the cluster.
1491 elasticsearch_port | **Optional.** TCP port to probe. The ElasticSearch API should be listening here. Defaults to 9200.
1492 elasticsearch_prefix | **Optional.** Optional prefix (e.g. 'es') for the ElasticSearch API. Defaults to ''.
1493 elasticsearch_yellowcritical | **Optional.** Instead of issuing a 'warning' for a yellow cluster state, issue a 'critical' alert. Defaults to false.
1496 ## <a id="plugins-contrib-ipmi"></a> IPMI Devices
1498 This category includes all plugins for IPMI devices.
1500 ### <a id="plugins-contrib-command-ipmi-sensor"></a> ipmi-sensor
1502 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.
1504 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
1507 ---------------------------------|-----------------------------------------------------------------------------------------------------
1508 ipmi_address | **Required.** Specifies the remote host (IPMI device) to check. Defaults to "$address$".
1509 ipmi_config_file | **Optional.** Path to the FreeIPMI configuration file. It should contain IPMI username, IPMI password, and IPMI privilege-level.
1510 ipmi_username | **Optional.** The IPMI username.
1511 ipmi_password | **Optional.** The IPMI password.
1512 ipmi_privilege_level | **Optional.** The IPMI privilege level of the IPMI user.
1513 ipmi_backward_compatibility_mode | **Optional.** Enable backward compatibility mode, useful for FreeIPMI 0.5.* (this omits FreeIPMI options "--quiet-cache" and "--sdr-cache-recreate").
1514 ipmi_sensor_type | **Optional.** Limit sensors to query based on IPMI sensor type. Examples for IPMI sensor types are 'Fan', 'Temperature' and 'Voltage'.
1515 ipmi_exclude_sensor_id | **Optional.** Exclude sensor matching ipmi_sensor_id.
1516 ipmi_sensor_id | **Optional.** Include sensor matching ipmi_sensor_id.
1517 ipmi_protocal_lan_version | **Optional.** Change the protocol LAN version. Defaults to "LAN_2_0".
1518 ipmi_number_of_active_fans | **Optional.** Number of fans that should be active. Otherwise a WARNING state is returned.
1519 ipmi_show_fru | **Optional.** Print the product serial number if it is available in the IPMI FRU data.
1520 ipmi_no_sel_checking | **Optional.** Turn off system event log checking via ipmi-sel.
1522 ## <a id="plugins-contrib-network-components"></a> Network Components
1524 This category includes all plugins for various network components like routers, switches and firewalls.
1526 ### <a id="plugins-contrib-command-interfacetable"></a> interfacetable
1528 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).
1530 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
1533 ------------------------------------|-----------------------------------------------------------------------------------------------------
1534 interfacetable_hostquery | **Required.** Specifies the remote host to poll. Defaults to "$address$".
1535 interfacetable_hostdisplay | **Optional.** Specifies the hostname to display in the HTML link. Defaults to "$host.display_name$".
1536 interfacetable_regex | **Optional.** Interface names and property names for some other options will be interpreted as regular expressions. Defaults to false.
1537 interfacetable_outputshort | **Optional.** Reduce the verbosity of the plugin output. Defaults to false.
1538 interfacetable_exclude | **Optional.** Comma separated list of interfaces globally excluded from the monitoring.
1539 interfacetable_include | **Optional.** Comma separated list of interfaces globally included in the monitoring.
1540 interfacetable_aliasmatching | **Optional.** Allow you to specify alias in addition to interface names. Defaults to false.
1541 interfacetable_excludetraffic | **Optional.** Comma separated list of interfaces excluded from traffic checks.
1542 interfacetable_includetraffic | **Optional.** Comma separated list of interfaces included for traffic checks.
1543 interfacetable_warningtraffic | **Optional.** Interface traffic load percentage leading to a warning alert.
1544 interfacetable_criticaltraffic | **Optional.** Interface traffic load percentage leading to a critical alert.
1545 interfacetable_pkt | **Optional.** Add unicast/non-unicast pkt stats for each interface.
1546 interfacetable_trackproperty | **Optional.** List of tracked properties.
1547 interfacetable_excludeproperty | **Optional.** Comma separated list of interfaces excluded from the property tracking.
1548 interfacetable_includeproperty | **Optional.** Comma separated list of interfaces included in the property tracking.
1549 interfacetable_community | **Optional.** Specifies the snmp v1/v2c community string. Defaults to "public" if using snmp v1/v2c, ignored using v3.
1550 interfacetable_snmpv2 | **Optional.** Use snmp v2c. Defaults to false.
1551 interfacetable_login | **Optional.** Login for snmpv3 authentication.
1552 interfacetable_passwd | **Optional.** Auth password for snmpv3 authentication.
1553 interfacetable_privpass | **Optional.** Priv password for snmpv3 authentication.
1554 interfacetable_protocols | **Optional.** Authentication protocol,Priv protocol for snmpv3 authentication.
1555 interfacetable_domain | **Optional.** SNMP transport domain.
1556 interfacetable_contextname | **Optional.** Context name for the snmp requests.
1557 interfacetable_port | **Optional.** SNMP port. Defaults to standard port.
1558 interfacetable_64bits | **Optional.** Use SNMP 64-bits counters. Defaults to false.
1559 interfacetable_maxrepetitions | **Optional.** Increasing this value may enhance snmp query performances by gathering more results at one time.
1560 interfacetable_snmptimeout | **Optional.** Define the Transport Layer timeout for the snmp queries.
1561 interfacetable_snmpretries | **Optional.** Define the number of times to retry sending a SNMP message.
1562 interfacetable_unixsnmp | **Optional.** Use unix snmp utilities for snmp requests. Defaults to false, which means use the perl bindings.
1563 interfacetable_enableperfdata | **Optional.** Enable port performance data. Defaults to false.
1564 interfacetable_perfdataformat | **Optional.** Define which performance data will be generated. Possible values are "full" (default), "loadonly", "globalonly".
1565 interfacetable_perfdatathreshold | **Optional.** Define which thresholds are printed in the generated performance data. Possible values are "full" (default), "loadonly", "globalonly".
1566 interfacetable_perfdatadir | **Optional.** When specified, the performance data are also written directly to a file, in the specified location.
1567 interfacetable_perfdataservicedesc | **Optional.** Specify additional parameters for output performance data to PNP. Defaults to "$service.name$", only affects **interfacetable_perfdatadir**.
1568 interfacetable_grapher | **Optional.** Specify the used graphing solution. Possible values are "pnp4nagios" (default), "nagiosgrapher", "netwaysgrapherv2" and "ingraph".
1569 interfacetable_grapherurl | **Optional.** Graphing system url. Default depends on **interfacetable_grapher**.
1570 interfacetable_portperfunit | **Optional.** Traffic could be reported in bits (counters) or in bps (calculated value).
1571 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".
1572 interfacetable_duplex | **Optional.** Add the duplex mode property for each interface in the interface table. Defaults to false.
1573 interfacetable_stp | **Optional.** Add the stp state property for each interface in the interface table. Defaults to false.
1574 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"
1575 interfacetable_noipinfo | **Optional.** Remove the ip information for each interface from the interface table. Defaults to false.
1576 interfacetable_alias | **Optional.** Add the alias information for each interface in the interface table. Defaults to false.
1577 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.
1578 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.
1579 interfacetable_delta | **Optional.** Set the delta used for interface throuput calculation in seconds.
1580 interfacetable_ifs | **Optional.** Input field separator. Defaults to ",".
1581 interfacetable_cache | **Optional.** Define the retention time of the cached data in seconds.
1582 interfacetable_noifloadgradient | **Optional.** Disable color gradient from green over yellow to red for the load percentage. Defaults to false.
1583 interfacetable_nohuman | **Optional.** Do not translate bandwidth usage in human readable format. Defaults to false.
1584 interfacetable_snapshot | **Optional.** Force the plugin to run like if it was the first launch. Defaults to false.
1585 interfacetable_timeout | **Optional.** Define the global timeout limit of the plugin in seconds. Defaults to "15s".
1586 interfacetable_css | **Optional.** Define the css stylesheet used by the generated html files. Possible values are "classic", "icinga", "icinga-alternate1" or "nagiosxi".
1587 interfacetable_config | **Optional.** Specify a config file to load.
1588 interfacetable_noconfigtable | **Optional.** Disable configuration table on the generated HTML page. Defaults to false.
1589 interfacetable_notips | **Optional.** Disable the tips in the generated html tables. Defaults to false.
1590 interfacetable_defaulttablesorting | **Optional.** Default table sorting can be "index" (default) or "name".
1591 interfacetable_tablesplit | **Optional.** Generate multiple interface tables, one per interface type. Defaults to false.
1592 interfacetable_notype | **Optional.** Remove the interface type for each interface. Defaults to false.
1594 ### <a id="plugins-contrib-command-iftraffic"></a> iftraffic
1596 The plugin [check_iftraffic](https://exchange.icinga.org/exchange/iftraffic)
1597 checks the utilization of a given interface name using the SNMP protocol.
1599 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
1602 ------------------------|---------------------------------------------------------
1603 iftraffic_address | **Required.** Specifies the remote host. Defaults to "$address$".
1604 iftraffic_community | **Optional.** SNMP community. Defaults to "public'" if omitted.
1605 iftraffic_interface | **Required.** Queried interface name.
1606 iftraffic_bandwidth | **Required.** Interface maximum speed in kilo/mega/giga/bits per second.
1607 iftraffic_units | **Optional.** Interface units can be one of these values: `g` (gigabits/s),`m` (megabits/s), `k` (kilobits/s),`b` (bits/s)
1608 iftraffic_warn | **Optional.** Percent of bandwidth usage necessary to result in warning status (defaults to `85%`).
1609 iftraffic_crit | **Optional.** Percent of bandwidth usage necessary to result in critical status (defaults to `98%`).
1610 iftraffic_max_counter | **Optional.** Maximum counter value of net devices in kilo/mega/giga/bytes.
1612 ## <a id="plugins-contrib-web"></a> Web
1614 This category includes all plugins for web-based checks.
1616 ## <a id="plugin-check-command-webinject"></a> webinject
1618 Check command object for the [check_webinject](http://http://www.webinject.org/manual.html) plugin.
1620 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
1623 ------------------------|--------------
1624 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.
1625 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.
1626 webinject_no_output | **Optional.** Suppresses all output to STDOUT except the results summary.
1627 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.
1628 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.
1629 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.
1631 ## <a id="plugins-contrib-operating-system"></a> Operating System
1633 In this category you can find plugins for gathering information about your operating system or the system beneath like memory usage.
1635 ### <a id="plugins-contrib-command-mem"></a> mem
1637 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).
1639 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
1642 -------------|-----------------------------------------------------------------------------------------------------------------------
1643 mem_used | **Optional.** Tell the plugin to check for used memory in opposite of **mem_free**. Must specify one of these as true.
1644 mem_free | **Optional.** Tell the plugin to check for free memory in opposite of **mem_used**. Must specify one of these as true.
1645 mem_cache | **Optional.** If set to true plugin will count cache as free memory. Defaults to false.
1646 mem_warning | **Required.** Specifiy the warning threshold as number interpreted as percent.
1647 mem_critical | **Required.** Specifiy the critical threshold as number interpreted as percent.
1649 ## <a id="plugin-contrib-command-running-kernel"></a> running_kernel
1651 Check command object for the `check_running_kernel` plugin
1652 provided by the `nagios-plugins-contrib` package on Debian.
1654 The `running_kernel` check command does not support any vars.
1657 ## <a id="plugins-contrib-virtualization"></a> Virtualization
1659 This category includes all plugins for various virtualization technologies.
1661 ### <a id="plugins-contrib-command-esxi-hardware"></a> esxi_hardware
1663 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.
1665 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
1668 ------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
1669 esxi_hardware_host | **Required.** Specifies the host to monitor. Defaults to "$address$".
1670 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.
1671 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.
1672 esxi_hardware_vendor | **Optional.** Defines the vendor of the server: "auto", "dell", "hp", "ibm", "intel", "unknown" (default).
1673 esxi_hardware_html | **Optional.** Add web-links to hardware manuals for Dell servers (use your country extension). Only useful with **esxi_hardware_vendor** = dell.
1674 esxi_hardware_ignore | **Optional.** Comma separated list of elements to ignore.
1675 esxi_hardware_perfdata | **Optional.** Add performcedata for graphers like PNP4Nagios to the output. Defaults to false.
1676 esxi_hardware_nopower | **Optional.** Do not collect power performance data, when **esxi_hardware_perfdata** is set to true. Defaults to false.
1677 esxi_hardware_novolts | **Optional.** Do not collect voltage performance data, when **esxi_hardware_perfdata** is set to true. Defaults to false.
1678 esxi_hardware_nocurrent | **Optional.** Do not collect current performance data, when **esxi_hardware_perfdata** is set to true. Defaults to false.
1679 esxi_hardware_notemp | **Optional.** Do not collect temperature performance data, when **esxi_hardware_perfdata** is set to true. Defaults to false.
1680 esxi_hardware_nofan | **Optional.** Do not collect fan performance data, when **esxi_hardware_perfdata** is set to true. Defaults to false.
1682 # <a id="plugins-contrib-vmware"></a> VMware
1684 Check commands for the [check_vmware_esx](https://github.com/BaldMansMojo/check_vmware_esx) plugin.
1686 ## <a id="plugins-contrib-vmware-esx-dc-volumes"></a> vmware-esx-dc-volumes
1688 Check command object for the `check_vmware_esx` plugin. Shows all datastore volumes info.
1690 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
1693 ------------------------|--------------
1694 vmware_datacenter | **Required.** Datacenter/vCenter hostname.
1695 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
1696 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
1697 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
1698 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
1699 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
1700 vmware_sessionfile | **Optional.** Session file name enhancement.
1701 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
1702 vmware_nosession | **Optional.** No auth session - IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
1703 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
1704 vmware_password | **Optional.** The username's password. No value defined as default.
1705 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
1706 vmware_subselect | **Optional.** Volume name to be checked the free space.
1707 vmware_gigabyte | **Optional.** Output in GB instead of MB.
1708 vmware_usedspace | **Optional.** Output used space instead of free. Defaults to "false".
1709 vmware_alertonly | **Optional.** List only alerting volumes. Defaults to "false".
1710 vmware_exclude | **Optional.** Blacklist volumes name. No value defined as default.
1711 vmware_include | **Optional.** Whitelist volumes name. No value defined as default.
1712 vmware_isregexp | **Optional.** Treat blacklist and whitelist expressions as regexp.
1713 vmware_dc_volume_used | **Optional.** Output used space instead of free. Defaults to "true".
1714 vmware_warn | **Optional.** The warning threshold for volumes. Defaults to "80%".
1715 vmware_crit | **Optional.** The critical threshold for volumes. Defaults to "90%".
1718 ## <a id="plugins-contrib-vmware-esx-dc-runtime-info"></a> vmware-esx-dc-runtime-info
1720 Check command object for the `check_vmware_esx` plugin. Shows all runtime info for the datacenter/Vcenter.
1722 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
1725 ------------------------|--------------
1726 vmware_datacenter | **Required.** Datacenter/vCenter hostname.
1727 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
1728 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
1729 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
1730 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
1731 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
1732 vmware_sessionfile | **Optional.** Session file name enhancement.
1733 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
1734 vmware_nosession | **Optional.** No auth session - IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
1735 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
1736 vmware_password | **Optional.** The username's password. No value defined as default.
1737 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
1740 ## <a id="plugins-contrib-vmware-esx-dc-runtime-listvms"></a> vmware-esx-dc-runtime-listvms
1742 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.
1744 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
1747 ------------------------|--------------
1748 vmware_datacenter | **Required.** Datacenter/vCenter hostname.
1749 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
1750 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
1751 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
1752 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
1753 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
1754 vmware_sessionfile | **Optional.** Session file name enhancement.
1755 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
1756 vmware_nosession | **Optional.** No auth session - IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
1757 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
1758 vmware_password | **Optional.** The username's password. No value defined as default.
1759 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
1760 vmware_alertonly | **Optional.** List only alerting VMs. Important here to avoid masses of data.
1761 vmware_exclude | **Optional.** Blacklist VMs name. No value defined as default.
1762 vmware_include | **Optional.** Whitelist VMs name. No value defined as default.
1763 vmware_isregexp | **Optional.** Treat blacklist and whitelist expressions as regexp.
1764 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.
1767 ## <a id="plugins-contrib-vmware-esx-dc-runtime-listhost"></a> vmware-esx-dc-runtime-listhost
1769 Check command object for the `check_vmware_esx` plugin. List of VMware ESX hosts and their power state.
1771 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
1774 ------------------------|--------------
1775 vmware_datacenter | **Required.** Datacenter/vCenter hostname.
1776 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
1777 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
1778 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
1779 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
1780 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
1781 vmware_sessionfile | **Optional.** Session file name enhancement.
1782 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
1783 vmware_nosession | **Optional.** No auth session - IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
1784 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
1785 vmware_password | **Optional.** The username's password. No value defined as default.
1786 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
1787 vmware_alertonly | **Optional.** List only alerting hosts. Important here to avoid masses of data.
1788 vmware_exclude | **Optional.** Blacklist VMware ESX hosts. No value defined as default.
1789 vmware_include | **Optional.** Whitelist VMware ESX hosts. No value defined as default.
1790 vmware_isregexp | **Optional.** Treat blacklist and whitelist expressions as regexp.
1791 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.
1794 ## <a id="plugins-contrib-vmware-esx-dc-runtime-listcluster"></a> vmware-esx-dc-runtime-listcluster
1796 Check command object for the `check_vmware_esx` plugin. List of VMware clusters and their states.
1798 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
1801 ------------------------|--------------
1802 vmware_datacenter | **Required.** Datacenter/vCenter hostname.
1803 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
1804 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
1805 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
1806 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
1807 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
1808 vmware_sessionfile | **Optional.** Session file name enhancement.
1809 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
1810 vmware_nosession | **Optional.** No auth session - IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
1811 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
1812 vmware_password | **Optional.** The username's password. No value defined as default.
1813 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
1814 vmware_alertonly | **Optional.** List only alerting hosts. Important here to avoid masses of data.
1815 vmware_exclude | **Optional.** Blacklist VMware cluster. No value defined as default.
1816 vmware_include | **Optional.** Whitelist VMware cluster. No value defined as default.
1817 vmware_isregexp | **Optional.** Treat blacklist and whitelist expressions as regexp.
1818 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.
1821 ## <a id="plugins-contrib-vmware-esx-dc-runtime-issues"></a> vmware-esx-dc-runtime-issues
1823 Check command object for the `check_vmware_esx` plugin. All issues for the host.
1825 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
1828 ------------------------|--------------
1829 vmware_datacenter | **Required.** Datacenter/vCenter hostname.
1830 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
1831 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
1832 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
1833 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
1834 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
1835 vmware_sessionfile | **Optional.** Session file name enhancement.
1836 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
1837 vmware_nosession | **Optional.** No auth session - IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
1838 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
1839 vmware_password | **Optional.** The username's password. No value defined as default.
1840 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 vmware_exclude | **Optional.** Blacklist issues. No value defined as default.
1842 vmware_include | **Optional.** Whitelist issues. No value defined as default.
1843 vmware_isregexp | **Optional.** Treat blacklist and whitelist expressions as regexp.
1844 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.
1847 ## <a id="plugins-contrib-vmware-esx-dc-runtime-status"></a> vmware-esx-dc-runtime-status
1849 Check command object for the `check_vmware_esx` plugin. Overall object status (gray/green/red/yellow).
1851 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
1854 ------------------------|--------------
1855 vmware_datacenter | **Required.** Datacenter/vCenter hostname.
1856 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
1857 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
1858 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
1859 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
1860 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
1861 vmware_sessionfile | **Optional.** Session file name enhancement.
1862 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
1863 vmware_nosession | **Optional.** No auth session - IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
1864 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
1865 vmware_password | **Optional.** The username's password. No value defined as default.
1866 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
1869 ## <a id="plugins-contrib-vmware-esx-dc-runtime-tools"></a> vmware-esx-dc-runtime-tools
1871 Check command object for the `check_vmware_esx` plugin. Vmware Tools status.
1873 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
1876 ------------------------|--------------
1877 vmware_datacenter | **Required.** Datacenter/vCenter hostname.
1878 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
1879 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
1880 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
1881 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
1882 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
1883 vmware_sessionfile | **Optional.** Session file name enhancement.
1884 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
1885 vmware_nosession | **Optional.** No auth session - IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
1886 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
1887 vmware_password | **Optional.** The username's password. No value defined as default.
1888 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
1889 vmware_poweredonly | **Optional.** List only VMs which are powered on. No value defined as default.
1890 vmware_alertonly | **Optional.** List only alerting VMs. Important here to avoid masses of data.
1891 vmware_exclude | **Optional.** Blacklist VMs. No value defined as default.
1892 vmware_include | **Optional.** Whitelist VMs. No value defined as default.
1893 vmware_isregexp | **Optional.** Treat blacklist and whitelist expressions as regexp.
1894 vmware_multiline | **Optional.** Multiline output in overview. This mean technically that a multiline output uses a HTML **\<br\>** for the GUI. No value defined as default.
1897 ## <a id="plugins-contrib-vmware-esx-soap-host-check"></a> vmware-esx-soap-host-check
1899 Check command object for the `check_vmware_esx` plugin. Simple check to verify a successfull connection to VMware SOAP API.
1901 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
1904 ------------------------|--------------
1905 vmware_host | **Required.** ESX or ESXi hostname.
1906 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
1907 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
1908 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
1909 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
1910 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
1911 vmware_sessionfile | **Optional.** Session file name enhancement.
1912 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
1913 vmware_nosession | **Optional.** No auth session - IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
1914 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
1915 vmware_password | **Optional.** The username's password. No value defined as default.
1916 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
1919 ## <a id="plugins-contrib-vmware-esx-soap-host-uptime"></a> vmware-esx-soap-host-uptime
1921 Check command object for the `check_vmware_esx` plugin. Displays uptime of the VMware host.
1923 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
1926 ------------------------|--------------
1927 vmware_host | **Required.** ESX or ESXi hostname.
1928 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
1929 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
1930 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
1931 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
1932 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
1933 vmware_sessionfile | **Optional.** Session file name enhancement.
1934 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
1935 vmware_nosession | **Optional.** No auth session - IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
1936 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
1937 vmware_password | **Optional.** The username's password. No value defined as default.
1938 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
1941 ## <a id="plugins-contrib-vmware-esx-soap-host-cpu"></a> vmware-esx-soap-host-cpu
1943 Check command object for the `check_vmware_esx` plugin. CPU usage in percentage.
1945 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
1948 ------------------------|--------------
1949 vmware_host | **Required.** ESX or ESXi hostname.
1950 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
1951 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
1952 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
1953 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
1954 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
1955 vmware_sessionfile | **Optional.** Session file name enhancement.
1956 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
1957 vmware_nosession | **Optional.** No auth session - IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
1958 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
1959 vmware_password | **Optional.** The username's password. No value defined as default.
1960 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
1961 vmware_warn | **Optional.** The warning threshold in percent. Defaults to "80%".
1962 vmware_crit | **Optional.** The critical threshold in percent. Defaults to "90%".
1965 ## <a id="plugins-contrib-vmware-esx-soap-host-cpu-ready"></a> vmware-esx-soap-host-cpu-ready
1967 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.
1969 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
1972 ------------------------|--------------
1973 vmware_host | **Required.** ESX or ESXi hostname.
1974 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
1975 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
1976 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
1977 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
1978 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
1979 vmware_sessionfile | **Optional.** Session file name enhancement.
1980 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
1981 vmware_nosession | **Optional.** No auth session - IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
1982 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
1983 vmware_password | **Optional.** The username's password. No value defined as default.
1984 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
1987 ## <a id="plugins-contrib-vmware-esx-soap-host-cpu-wait"></a> vmware-esx-soap-host-cpu-wait
1989 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.
1991 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
1994 ------------------------|--------------
1995 vmware_host | **Required.** ESX or ESXi hostname.
1996 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
1997 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
1998 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
1999 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
2000 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
2001 vmware_sessionfile | **Optional.** Session file name enhancement.
2002 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
2003 vmware_nosession | **Optional.** No auth session - IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
2004 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
2005 vmware_password | **Optional.** The username's password. No value defined as default.
2006 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
2009 ## <a id="plugins-contrib-vmware-esx-soap-host-cpu-usage"></a> vmware-esx-soap-host-cpu-usage
2011 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.
2013 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
2016 ------------------------|--------------
2017 vmware_host | **Required.** ESX or ESXi hostname.
2018 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
2019 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
2020 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
2021 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
2022 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
2023 vmware_sessionfile | **Optional.** Session file name enhancement.
2024 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
2025 vmware_nosession | **Optional.** No auth session - IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
2026 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
2027 vmware_password | **Optional.** The username's password. No value defined as default.
2028 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
2029 vmware_warn | **Optional.** The warning threshold in percent. Defaults to "80%".
2030 vmware_crit | **Optional.** The critical threshold in percent. Defaults to "90%".
2033 ## <a id="plugins-contrib-vmware-esx-soap-host-mem"></a> vmware-esx-soap-host-mem
2035 Check command object for the `check_vmware_esx` plugin. All mem info(except overall and no thresholds).
2037 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
2040 ------------------------|--------------
2041 vmware_host | **Required.** ESX or ESXi hostname.
2042 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
2043 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
2044 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
2045 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
2046 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
2047 vmware_sessionfile | **Optional.** Session file name enhancement.
2048 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
2049 vmware_nosession | **Optional.** No auth session - IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
2050 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
2051 vmware_password | **Optional.** The username's password. No value defined as default.
2052 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
2055 ## <a id="plugins-contrib-vmware-esx-soap-host-mem-usage"></a> vmware-esx-soap-host-mem-usage
2057 Check command object for the `check_vmware_esx` plugin. Average mem usage in percentage.
2059 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
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 percent. Defaults to "80%".
2076 vmware_crit | **Optional.** The critical threshold in percent. Defaults to "90%".
2079 ## <a id="plugins-contrib-vmware-esx-soap-host-mem-consumed"></a> vmware-esx-soap-host-mem-consumed
2081 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.
2083 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
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 percent. No value defined as default.
2100 vmware_crit | **Optional.** The critical threshold in percent. No value defined as default.
2103 ## <a id="plugins-contrib-vmware-esx-soap-host-mem-swapused"></a> vmware-esx-soap-host-mem-swapused
2105 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.
2107 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
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 percent. No value defined as default.
2124 vmware_crit | **Optional.** The critical threshold in percent. No value defined as default.
2125 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.
2128 ## <a id="plugins-contrib-vmware-esx-soap-host-mem-overhead"></a> vmware-esx-soap-host-mem-overhead
2130 Check command object for the `check_vmware_esx` plugin. Additional mem used by VM Server in MB.
2132 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
2135 ------------------------|--------------
2136 vmware_host | **Required.** ESX or ESXi hostname.
2137 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
2138 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
2139 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
2140 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
2141 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
2142 vmware_sessionfile | **Optional.** Session file name enhancement.
2143 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
2144 vmware_nosession | **Optional.** No auth session - IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
2145 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
2146 vmware_password | **Optional.** The username's password. No value defined as default.
2147 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
2148 vmware_warn | **Optional.** The warning threshold in percent. No value defined as default.
2149 vmware_crit | **Optional.** The critical threshold in percent. No value defined as default.
2152 ## <a id="plugins-contrib-vmware-esx-soap-host-mem-memctl"></a> vmware-esx-soap-host-mem-memctl
2154 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.
2156 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
2159 ------------------------|--------------
2160 vmware_host | **Required.** ESX or ESXi hostname.
2161 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
2162 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
2163 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
2164 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
2165 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
2166 vmware_sessionfile | **Optional.** Session file name enhancement.
2167 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
2168 vmware_nosession | **Optional.** No auth session - IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
2169 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
2170 vmware_password | **Optional.** The username's password. No value defined as default.
2171 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
2172 vmware_warn | **Optional.** The warning threshold in percent. No value defined as default.
2173 vmware_crit | **Optional.** The critical threshold in percent. No value defined as default.
2174 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.
2177 ## <a id="plugins-contrib-vmware-esx-soap-host-net"></a> vmware-esx-soap-host-net
2179 Check command object for the `check_vmware_esx` plugin. Shows net info.
2181 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
2184 ------------------------|--------------
2185 vmware_host | **Required.** ESX or ESXi hostname.
2186 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
2187 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
2188 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
2189 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
2190 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
2191 vmware_sessionfile | **Optional.** Session file name enhancement.
2192 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
2193 vmware_nosession | **Optional.** No auth session - IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
2194 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
2195 vmware_password | **Optional.** The username's password. No value defined as default.
2196 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
2197 vmware_exclude | **Optional.** Blacklist NICs. No value defined as default.
2198 vmware_isregexp | **Optional.** Treat blacklist expression as regexp.
2201 ## <a id="plugins-contrib-vmware-esx-soap-host-net-usage"></a> vmware-esx-soap-host-net-usage
2203 Check command object for the `check_vmware_esx` plugin. Overall network usage in KBps(Kilobytes per Second).
2205 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
2208 ------------------------|--------------
2209 vmware_host | **Required.** ESX or ESXi hostname.
2210 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
2211 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
2212 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
2213 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
2214 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
2215 vmware_sessionfile | **Optional.** Session file name enhancement.
2216 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
2217 vmware_nosession | **Optional.** No auth session - IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
2218 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
2219 vmware_password | **Optional.** The username's password. No value defined as default.
2220 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
2221 vmware_warn | **Optional.** The warning threshold in KBps(Kilobytes per Second). No value defined as default.
2222 vmware_crit | **Optional.** The critical threshold in KBps(Kilobytes per Second). No value defined as default.
2225 ## <a id="plugins-contrib-vmware-esx-soap-host-net-receive"></a> vmware-esx-soap-host-net-receive
2227 Check command object for the `check_vmware_esx` plugin. Data receive in KBps(Kilobytes per Second).
2229 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
2232 ------------------------|--------------
2233 vmware_host | **Required.** ESX or ESXi hostname.
2234 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
2235 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
2236 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
2237 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
2238 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
2239 vmware_sessionfile | **Optional.** Session file name enhancement.
2240 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
2241 vmware_nosession | **Optional.** No auth session - IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
2242 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
2243 vmware_password | **Optional.** The username's password. No value defined as default.
2244 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
2245 vmware_warn | **Optional.** The warning threshold in KBps(Kilobytes per Second). No value defined as default.
2246 vmware_crit | **Optional.** The critical threshold in KBps(Kilobytes per Second). No value defined as default.
2249 ## <a id="plugins-contrib-vmware-esx-soap-host-net-send"></a> vmware-esx-soap-host-net-send
2251 Check command object for the `check_vmware_esx` plugin. Data send in KBps(Kilobytes per Second).
2253 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
2256 ------------------------|--------------
2257 vmware_host | **Required.** ESX or ESXi hostname.
2258 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
2259 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
2260 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
2261 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
2262 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
2263 vmware_sessionfile | **Optional.** Session file name enhancement.
2264 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
2265 vmware_nosession | **Optional.** No auth session - IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
2266 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
2267 vmware_password | **Optional.** The username's password. No value defined as default.
2268 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
2269 vmware_warn | **Optional.** The warning threshold in KBps(Kilobytes per Second). No value defined as default.
2270 vmware_crit | **Optional.** The critical threshold in KBps(Kilobytes per Second). No value defined as default.
2273 ## <a id="plugins-contrib-vmware-esx-soap-host-net-nic"></a> vmware-esx-soap-host-net-nic
2275 Check command object for the `check_vmware_esx` plugin. Check all active NICs.
2277 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
2280 ------------------------|--------------
2281 vmware_host | **Required.** ESX or ESXi hostname.
2282 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
2283 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
2284 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
2285 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
2286 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
2287 vmware_sessionfile | **Optional.** Session file name enhancement.
2288 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
2289 vmware_nosession | **Optional.** No auth session - IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
2290 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
2291 vmware_password | **Optional.** The username's password. No value defined as default.
2292 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
2293 vmware_exclude | **Optional.** Blacklist NICs. No value defined as default.
2294 vmware_isregexp | **Optional.** Treat blacklist expression as regexp.
2297 ## <a id="plugins-contrib-vmware-esx-soap-host-volumes"></a> vmware-esx-soap-host-volumes
2299 Check command object for the `check_vmware_esx` plugin. Shows all datastore volumes info.
2301 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
2304 ------------------------|--------------
2305 vmware_host | **Required.** ESX or ESXi hostname.
2306 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
2307 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
2308 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
2309 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
2310 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
2311 vmware_sessionfile | **Optional.** Session file name enhancement.
2312 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
2313 vmware_nosession | **Optional.** No auth session - IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
2314 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
2315 vmware_password | **Optional.** The username's password. No value defined as default.
2316 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
2317 vmware_subselect | **Optional.** Volume name to be checked the free space.
2318 vmware_gigabyte | **Optional.** Output in GB instead of MB.
2319 vmware_usedspace | **Optional.** Output used space instead of free. Defaults to "false".
2320 vmware_alertonly | **Optional.** List only alerting volumes. Defaults to "false".
2321 vmware_exclude | **Optional.** Blacklist volumes name. No value defined as default.
2322 vmware_include | **Optional.** Whitelist volumes name. No value defined as default.
2323 vmware_isregexp | **Optional.** Treat blacklist and whitelist expressions as regexp.
2324 vmware_warn | **Optional.** The warning threshold for volumes. Defaults to "80%".
2325 vmware_crit | **Optional.** The critical threshold for volumes. Defaults to "90%".
2326 vmware_spaceleft | **Optional.** This has to be used in conjunction with thresholds as mentioned above.
2329 ## <a id="plugins-contrib-vmware-esx-soap-host-io"></a> vmware-esx-soap-host-io
2331 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.
2333 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
2336 ------------------------|--------------
2337 vmware_host | **Required.** ESX or ESXi hostname.
2338 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
2339 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
2340 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
2341 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
2342 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
2343 vmware_sessionfile | **Optional.** Session file name enhancement.
2344 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
2345 vmware_nosession | **Optional.** No auth session - IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
2346 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
2347 vmware_password | **Optional.** The username's password. No value defined as default.
2348 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
2351 ## <a id="plugins-contrib-vmware-esx-soap-host-io-aborted"></a> vmware-esx-soap-host-io-aborted
2353 Check command object for the `check_vmware_esx` plugin. Number of aborted SCSI commands.
2355 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
2358 ------------------------|--------------
2359 vmware_host | **Required.** ESX or ESXi hostname.
2360 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
2361 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
2362 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
2363 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
2364 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
2365 vmware_sessionfile | **Optional.** Session file name enhancement.
2366 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
2367 vmware_nosession | **Optional.** No auth session - IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
2368 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
2369 vmware_password | **Optional.** The username's password. No value defined as default.
2370 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
2371 vmware_warn | **Optional.** The warning threshold. No value defined as default.
2372 vmware_crit | **Optional.** The critical threshold. No value defined as default.
2375 ## <a id="plugins-contrib-vmware-esx-soap-host-io-resets"></a> vmware-esx-soap-host-io-resets
2377 Check command object for the `check_vmware_esx` plugin. Number of SCSI bus resets.
2379 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
2382 ------------------------|--------------
2383 vmware_host | **Required.** ESX or ESXi hostname.
2384 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
2385 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
2386 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
2387 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
2388 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
2389 vmware_sessionfile | **Optional.** Session file name enhancement.
2390 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
2391 vmware_nosession | **Optional.** No auth session - IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
2392 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
2393 vmware_password | **Optional.** The username's password. No value defined as default.
2394 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
2395 vmware_warn | **Optional.** The warning threshold. No value defined as default.
2396 vmware_crit | **Optional.** The critical threshold. No value defined as default.
2399 ## <a id="plugins-contrib-vmware-esx-soap-host-io-read"></a> vmware-esx-soap-host-io-read
2401 Check command object for the `check_vmware_esx` plugin. Average number of kilobytes read from the disk each second.
2403 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
2406 ------------------------|--------------
2407 vmware_host | **Required.** ESX or ESXi hostname.
2408 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
2409 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
2410 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
2411 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
2412 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
2413 vmware_sessionfile | **Optional.** Session file name enhancement.
2414 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
2415 vmware_nosession | **Optional.** No auth session - IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
2416 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
2417 vmware_password | **Optional.** The username's password. No value defined as default.
2418 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
2419 vmware_warn | **Optional.** The warning threshold. No value defined as default.
2420 vmware_crit | **Optional.** The critical threshold. No value defined as default.
2423 ## <a id="plugins-contrib-vmware-esx-soap-host-io-read-latency"></a> vmware-esx-soap-host-io-read-latency
2425 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.
2427 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
2430 ------------------------|--------------
2431 vmware_host | **Required.** ESX or ESXi hostname.
2432 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
2433 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
2434 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
2435 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
2436 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
2437 vmware_sessionfile | **Optional.** Session file name enhancement.
2438 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
2439 vmware_nosession | **Optional.** No auth session - IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
2440 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
2441 vmware_password | **Optional.** The username's password. No value defined as default.
2442 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
2443 vmware_warn | **Optional.** The warning threshold. No value defined as default.
2444 vmware_crit | **Optional.** The critical threshold. No value defined as default.
2447 ## <a id="plugins-contrib-vmware-esx-soap-host-io-write"></a> vmware-esx-soap-host-io-write
2449 Check command object for the `check_vmware_esx` plugin. Average number of kilobytes written to disk each second.
2451 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
2454 ------------------------|--------------
2455 vmware_host | **Required.** ESX or ESXi hostname.
2456 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
2457 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
2458 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
2459 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
2460 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
2461 vmware_sessionfile | **Optional.** Session file name enhancement.
2462 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
2463 vmware_nosession | **Optional.** No auth session - IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
2464 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
2465 vmware_password | **Optional.** The username's password. No value defined as default.
2466 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
2467 vmware_warn | **Optional.** The warning threshold. No value defined as default.
2468 vmware_crit | **Optional.** The critical threshold. No value defined as default.
2471 ## <a id="plugins-contrib-vmware-esx-soap-host-io-write-latency"></a> vmware-esx-soap-host-io-write-latency
2473 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.
2475 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
2478 ------------------------|--------------
2479 vmware_host | **Required.** ESX or ESXi hostname.
2480 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
2481 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
2482 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
2483 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
2484 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
2485 vmware_sessionfile | **Optional.** Session file name enhancement.
2486 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
2487 vmware_nosession | **Optional.** No auth session - IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
2488 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
2489 vmware_password | **Optional.** The username's password. No value defined as default.
2490 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
2491 vmware_warn | **Optional.** The warning threshold. No value defined as default.
2492 vmware_crit | **Optional.** The critical threshold. No value defined as default.
2495 ## <a id="plugins-contrib-vmware-esx-soap-host-io-usage"></a> vmware-esx-soap-host-io-usage
2497 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.
2499 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
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_warn | **Optional.** The warning threshold. No value defined as default.
2516 vmware_crit | **Optional.** The critical threshold. No value defined as default.
2519 ## <a id="plugins-contrib-vmware-esx-soap-host-io-kernel-latency"></a> vmware-esx-soap-host-io-kernel-latency
2521 Check command object for the `check_vmware_esx` plugin. Average amount of time (ms) spent by VMkernel processing each SCSI command.
2523 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
2526 ------------------------|--------------
2527 vmware_host | **Required.** ESX or ESXi hostname.
2528 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
2529 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
2530 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
2531 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
2532 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
2533 vmware_sessionfile | **Optional.** Session file name enhancement.
2534 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
2535 vmware_nosession | **Optional.** No auth session - IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
2536 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
2537 vmware_password | **Optional.** The username's password. No value defined as default.
2538 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
2539 vmware_warn | **Optional.** The warning threshold. No value defined as default.
2540 vmware_crit | **Optional.** The critical threshold. No value defined as default.
2543 ## <a id="plugins-contrib-vmware-esx-soap-host-io-device-latency"></a> vmware-esx-soap-host-io-device-latency
2545 Check command object for the `check_vmware_esx` plugin. Average amount of time (ms) to complete a SCSI command from the physical device.
2547 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
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
2563 vmware_warn | **Optional.** The warning threshold. No value defined as default.
2564 vmware_crit | **Optional.** The critical threshold. No value defined as default.
2567 ## <a id="plugins-contrib-vmware-esx-soap-host-io-queue-latency"></a> vmware-esx-soap-host-io-queue-latency
2569 Check command object for the `check_vmware_esx` plugin. Average amount of time (ms) spent in the VMkernel queue.
2571 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
2574 ------------------------|--------------
2575 vmware_host | **Required.** ESX or ESXi hostname.
2576 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
2577 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
2578 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
2579 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
2580 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
2581 vmware_sessionfile | **Optional.** Session file name enhancement.
2582 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
2583 vmware_nosession | **Optional.** No auth session - IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
2584 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
2585 vmware_password | **Optional.** The username's password. No value defined as default.
2586 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
2587 vmware_warn | **Optional.** The warning threshold. No value defined as default.
2588 vmware_crit | **Optional.** The critical threshold. No value defined as default.
2591 ## <a id="plugins-contrib-vmware-esx-soap-host-io-total-latency"></a> vmware-esx-soap-host-io-total-latency
2593 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.
2595 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
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
2611 vmware_warn | **Optional.** The warning threshold. No value defined as default.
2612 vmware_crit | **Optional.** The critical threshold. No value defined as default.
2615 ## <a id="plugins-contrib-vmware-esx-soap-host-media"></a> vmware-esx-soap-host-media
2617 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.
2619 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
2622 ------------------------|--------------
2623 vmware_host | **Required.** ESX or ESXi hostname.
2624 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
2625 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
2626 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
2627 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
2628 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
2629 vmware_sessionfile | **Optional.** Session file name enhancement.
2630 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
2631 vmware_nosession | **Optional.** No auth session - IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
2632 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
2633 vmware_password | **Optional.** The username's password. No value defined as default.
2634 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
2635 vmware_exclude | **Optional.** Blacklist VMs name. No value defined as default.
2636 vmware_include | **Optional.** Whitelist VMs name. No value defined as default.
2637 vmware_isregexp | **Optional.** Treat blacklist and whitelist expressions as regexp.
2638 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.
2641 ## <a id="plugins-contrib-vmware-esx-soap-host-service"></a> vmware-esx-soap-host-service
2643 Check command object for the `check_vmware_esx` plugin. Shows host service info.
2645 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
2648 ------------------------|--------------
2649 vmware_host | **Required.** ESX or ESXi hostname.
2650 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
2651 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
2652 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
2653 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
2654 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
2655 vmware_sessionfile | **Optional.** Session file name enhancement.
2656 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
2657 vmware_nosession | **Optional.** No auth session - IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
2658 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
2659 vmware_password | **Optional.** The username's password. No value defined as default.
2660 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
2661 vmware_exclude | **Optional.** Blacklist services name. No value defined as default.
2662 vmware_include | **Optional.** Whitelist services name. No value defined as default.
2663 vmware_isregexp | **Optional.** Treat blacklist and whitelist expressions as regexp.
2664 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.
2667 ## <a id="plugins-contrib-vmware-esx-soap-host-runtime"></a> vmware-esx-soap-host-runtime
2669 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.
2671 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
2674 ------------------------|--------------
2675 vmware_host | **Required.** ESX or ESXi hostname.
2676 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
2677 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
2678 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
2679 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
2680 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
2681 vmware_sessionfile | **Optional.** Session file name enhancement.
2682 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
2683 vmware_nosession | **Optional.** No auth session - IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
2684 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
2685 vmware_password | **Optional.** The username's password. No value defined as default.
2686 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
2689 ## <a id="plugins-contrib-vmware-esx-soap-host-runtime-con"></a> vmware-esx-soap-host-runtime-con
2691 Check command object for the `check_vmware_esx` plugin. Shows connection state.
2693 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
2696 ------------------------|--------------
2697 vmware_host | **Required.** ESX or ESXi hostname.
2698 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
2699 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
2700 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
2701 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
2702 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
2703 vmware_sessionfile | **Optional.** Session file name enhancement.
2704 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
2705 vmware_nosession | **Optional.** No auth session - IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
2706 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
2707 vmware_password | **Optional.** The username's password. No value defined as default.
2708 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
2711 ## <a id="plugins-contrib-vmware-esx-soap-host-runtime-listvms"></a> vmware-esx-soap-host-runtime-listvms
2713 Check command object for the `check_vmware_esx` plugin. List of VMware machines and their status.
2715 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
2718 ------------------------|--------------
2719 vmware_host | **Required.** ESX or ESXi hostname.
2720 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
2721 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
2722 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
2723 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
2724 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
2725 vmware_sessionfile | **Optional.** Session file name enhancement.
2726 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
2727 vmware_nosession | **Optional.** No auth session - IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
2728 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
2729 vmware_password | **Optional.** The username's password. No value defined as default.
2730 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
2731 vmware_exclude | **Optional.** Blacklist VMs name. No value defined as default.
2732 vmware_include | **Optional.** Whitelist VMs name. No value defined as default.
2733 vmware_isregexp | **Optional.** Treat blacklist and whitelist expressions as regexp.
2734 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.
2737 ## <a id="plugins-contrib-vmware-esx-soap-host-runtime-status"></a> vmware-esx-soap-host-runtime-status
2739 Check command object for the `check_vmware_esx` plugin. Overall object status (gray/green/red/yellow).
2741 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
2744 ------------------------|--------------
2745 vmware_host | **Required.** ESX or ESXi hostname.
2746 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
2747 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
2748 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
2749 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
2750 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
2751 vmware_sessionfile | **Optional.** Session file name enhancement.
2752 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
2753 vmware_nosession | **Optional.** No auth session - IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
2754 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
2755 vmware_password | **Optional.** The username's password. No value defined as default.
2756 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
2759 ## <a id="plugins-contrib-vmware-esx-soap-host-runtime-health"></a> vmware-esx-soap-host-runtime-health
2761 Check command object for the `check_vmware_esx` plugin. Checks cpu/storage/memory/sensor status.
2763 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
2766 ------------------------|--------------
2767 vmware_host | **Required.** ESX or ESXi hostname.
2768 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
2769 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
2770 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
2771 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
2772 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
2773 vmware_sessionfile | **Optional.** Session file name enhancement.
2774 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
2775 vmware_nosession | **Optional.** No auth session - IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
2776 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
2777 vmware_password | **Optional.** The username's password. No value defined as default.
2778 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
2779 vmware_exclude | **Optional.** Blacklist status name. No value defined as default.
2780 vmware_include | **Optional.** Whitelist status name. No value defined as default.
2781 vmware_isregexp | **Optional.** Treat blacklist and whitelist expressions as regexp.
2784 ## <a id="plugins-contrib-vmware-esx-soap-host-runtime-health-listsensors"></a> vmware-esx-soap-host-runtime-health-listsensors
2786 Check command object for the `check_vmware_esx` plugin. List all available sensors(use for listing purpose only).
2788 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
2791 ------------------------|--------------
2792 vmware_host | **Required.** ESX or ESXi hostname.
2793 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
2794 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
2795 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
2796 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
2797 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
2798 vmware_sessionfile | **Optional.** Session file name enhancement.
2799 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
2800 vmware_nosession | **Optional.** No auth session - IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
2801 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
2802 vmware_password | **Optional.** The username's password. No value defined as default.
2803 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
2804 vmware_exclude | **Optional.** Blacklist status name. No value defined as default.
2805 vmware_include | **Optional.** Whitelist status name. No value defined as default.
2806 vmware_isregexp | **Optional.** Treat blacklist and whitelist expressions as regexp.
2809 ## <a id="plugins-contrib-vmware-esx-soap-host-runtime-health-nostoragestatus"></a> vmware-esx-soap-host-runtime-health-nostoragestatus
2811 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**.
2813 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
2816 ------------------------|--------------
2817 vmware_host | **Required.** ESX or ESXi hostname.
2818 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
2819 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
2820 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
2821 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
2822 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
2823 vmware_sessionfile | **Optional.** Session file name enhancement.
2824 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
2825 vmware_nosession | **Optional.** No auth session - IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
2826 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
2827 vmware_password | **Optional.** The username's password. No value defined as default.
2828 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
2829 vmware_exclude | **Optional.** Blacklist status name. No value defined as default.
2830 vmware_include | **Optional.** Whitelist status name. No value defined as default.
2831 vmware_isregexp | **Optional.** Treat blacklist and whitelist expressions as regexp.
2834 ## <a id="plugins-contrib-vmware-esx-soap-host-runtime-storagehealth"></a> vmware-esx-soap-host-runtime-storagehealth
2836 Check command object for the `check_vmware_esx` plugin. Local storage status check.
2838 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
2841 ------------------------|--------------
2842 vmware_host | **Required.** ESX or ESXi hostname.
2843 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
2844 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
2845 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
2846 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
2847 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
2848 vmware_sessionfile | **Optional.** Session file name enhancement.
2849 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
2850 vmware_nosession | **Optional.** No auth session - IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
2851 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
2852 vmware_password | **Optional.** The username's password. No value defined as default.
2853 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
2854 vmware_exclude | **Optional.** Blacklist storage name. No value defined as default.
2855 vmware_include | **Optional.** Whitelist storage name. No value defined as default.
2856 vmware_isregexp | **Optional.** Treat blacklist and whitelist expressions as regexp.
2857 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.
2860 ## <a id="plugins-contrib-vmware-esx-soap-host-runtime-temp"></a> vmware-esx-soap-host-runtime-temp
2862 Check command object for the `check_vmware_esx` plugin. Lists all temperature sensors.
2864 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
2867 ------------------------|--------------
2868 vmware_host | **Required.** ESX or ESXi hostname.
2869 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
2870 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
2871 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
2872 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
2873 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
2874 vmware_sessionfile | **Optional.** Session file name enhancement.
2875 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
2876 vmware_nosession | **Optional.** No auth session - IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
2877 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
2878 vmware_password | **Optional.** The username's password. No value defined as default.
2879 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
2880 vmware_exclude | **Optional.** Blacklist sensor name. No value defined as default.
2881 vmware_include | **Optional.** Whitelist sensor name. No value defined as default.
2882 vmware_isregexp | **Optional.** Treat blacklist and whitelist expressions as regexp.
2883 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.
2886 ## <a id="plugins-contrib-vmware-esx-soap-host-runtime-issues"></a> vmware-esx-soap-host-runtime-issues
2888 Check command object for the `check_vmware_esx` plugin. Lists all configuration issues for the host.
2890 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
2893 ------------------------|--------------
2894 vmware_host | **Required.** ESX or ESXi hostname.
2895 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
2896 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
2897 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
2898 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
2899 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
2900 vmware_sessionfile | **Optional.** Session file name enhancement.
2901 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
2902 vmware_nosession | **Optional.** No auth session - IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
2903 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
2904 vmware_password | **Optional.** The username's password. No value defined as default.
2905 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
2906 vmware_exclude | **Optional.** Blacklist configuration issues. No value defined as default.
2907 vmware_include | **Optional.** Whitelist configuration issues. No value defined as default.
2908 vmware_isregexp | **Optional.** Treat blacklist and whitelist expressions as regexp.
2909 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.
2912 ## <a id="plugins-contrib-vmware-esx-soap-host-storage"></a> vmware-esx-soap-host-storage
2914 Check command object for the `check_vmware_esx` plugin. Shows Host storage info.
2916 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
2919 ------------------------|--------------
2920 vmware_host | **Required.** ESX or ESXi hostname.
2921 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
2922 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
2923 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
2924 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
2925 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
2926 vmware_sessionfile | **Optional.** Session file name enhancement.
2927 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
2928 vmware_nosession | **Optional.** No auth session - IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
2929 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
2930 vmware_password | **Optional.** The username's password. No value defined as default.
2931 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
2932 vmware_exclude | **Optional.** Blacklist adapters, luns and paths. No value defined as default.
2933 vmware_include | **Optional.** Whitelist adapters, luns and paths. No value defined as default.
2934 vmware_isregexp | **Optional.** Treat blacklist and whitelist expressions as regexp.
2937 ## <a id="plugins-contrib-vmware-esx-soap-host-storage-adapter"></a> vmware-esx-soap-host-storage-adapter
2939 Check command object for the `check_vmware_esx` plugin. List host bus adapters.
2941 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
2944 ------------------------|--------------
2945 vmware_host | **Required.** ESX or ESXi hostname.
2946 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
2947 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
2948 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
2949 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
2950 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
2951 vmware_sessionfile | **Optional.** Session file name enhancement.
2952 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
2953 vmware_nosession | **Optional.** No auth session - IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
2954 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
2955 vmware_password | **Optional.** The username's password. No value defined as default.
2956 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
2957 vmware_exclude | **Optional.** Blacklist adapters. No value defined as default.
2958 vmware_include | **Optional.** Whitelist adapters. No value defined as default.
2959 vmware_isregexp | **Optional.** Treat blacklist and whitelist expressions as regexp.
2960 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.
2963 ## <a id="plugins-contrib-vmware-esx-soap-host-storage-lun"></a> vmware-esx-soap-host-storage-lun
2965 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.
2967 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
2970 ------------------------|--------------
2971 vmware_host | **Required.** ESX or ESXi hostname.
2972 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
2973 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
2974 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
2975 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
2976 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
2977 vmware_sessionfile | **Optional.** Session file name enhancement.
2978 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
2979 vmware_nosession | **Optional.** No auth session - IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
2980 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
2981 vmware_password | **Optional.** The username's password. No value defined as default.
2982 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
2983 vmware_exclude | **Optional.** Blacklist luns. No value defined as default.
2984 vmware_include | **Optional.** Whitelist luns. No value defined as default.
2985 vmware_isregexp | **Optional.** Treat blacklist and whitelist expressions as regexp.
2986 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.
2989 ## <a id="plugins-contrib-vmware-esx-soap-host-storage-path"></a> vmware-esx-soap-host-storage-path
2991 Check command object for the `check_vmware_esx` plugin. List multipaths and the associated paths.
2993 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
2996 ------------------------|--------------
2997 vmware_host | **Required.** ESX or ESXi hostname.
2998 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
2999 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
3000 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
3001 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
3002 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
3003 vmware_sessionfile | **Optional.** Session file name enhancement.
3004 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
3005 vmware_nosession | **Optional.** No auth session - IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
3006 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
3007 vmware_password | **Optional.** The username's password. No value defined as default.
3008 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
3009 vmware_alertonly | **Optional.** List only alerting units. Important here to avoid masses of data. Defaults to "false".
3010 vmware_exclude | **Optional.** Blacklist paths. No value defined as default.
3011 vmware_include | **Optional.** Whitelist paths. No value defined as default.
3012 vmware_isregexp | **Optional.** Treat blacklist and whitelist expressions as regexp.
3013 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.
3016 ## <a id="plugins-contrib-vmware-esx-soap-vm-cpu"></a> vmware-esx-soap-vm-cpu
3018 Check command object for the `check_vmware_esx` plugin. Shows all CPU usage info.
3020 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
3023 ------------------------|--------------
3024 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. Conflicts with **vmware_host**.
3025 vmware_host | **Optional.** ESX or ESXi hostname. Conflicts with **vmware_datacenter**.
3026 vmware_vmname | **Required.** Virtual machine name.
3027 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
3028 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
3029 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
3030 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
3031 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
3032 vmware_sessionfile | **Optional.** Session file name enhancement.
3033 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
3034 vmware_nosession | **Optional.** No auth session - IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
3035 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
3036 vmware_password | **Optional.** The username's password. No value defined as default.
3037 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
3041 ## <a id="plugins-contrib-vmware-esx-soap-vm-cpu-ready"></a> vmware-esx-soap-vm-cpu-ready
3043 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.
3045 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
3048 ------------------------|--------------
3049 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. Conflicts with **vmware_host**.
3050 vmware_host | **Optional.** ESX or ESXi hostname. Conflicts with **vmware_datacenter**.
3051 vmware_vmname | **Required.** Virtual machine name.
3052 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
3053 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
3054 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
3055 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
3056 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
3057 vmware_sessionfile | **Optional.** Session file name enhancement.
3058 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
3059 vmware_nosession | **Optional.** No auth session - IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
3060 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
3061 vmware_password | **Optional.** The username's password. No value defined as default.
3062 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
3063 vmware_warn | **Optional.** The warning threshold. No value defined as default.
3064 vmware_crit | **Optional.** The critical threshold. No value defined as default.
3067 ## <a id="plugins-contrib-vmware-esx-soap-vm-cpu-wait"></a> vmware-esx-soap-vm-cpu-wait
3069 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.
3071 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
3074 ------------------------|--------------
3075 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. Conflicts with **vmware_host**.
3076 vmware_host | **Optional.** ESX or ESXi hostname. Conflicts with **vmware_datacenter**.
3077 vmware_vmname | **Required.** Virtual machine name.
3078 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
3079 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
3080 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
3081 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
3082 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
3083 vmware_sessionfile | **Optional.** Session file name enhancement.
3084 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
3085 vmware_nosession | **Optional.** No auth session - IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
3086 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
3087 vmware_password | **Optional.** The username's password. No value defined as default.
3088 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
3089 vmware_warn | **Optional.** The warning threshold. No value defined as default.
3090 vmware_crit | **Optional.** The critical threshold. No value defined as default.
3093 ## <a id="plugins-contrib-vmware-esx-soap-vm-cpu-usage"></a> vmware-esx-soap-vm-cpu-usage
3095 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.
3097 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
3100 ------------------------|--------------
3101 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. Conflicts with **vmware_host**.
3102 vmware_host | **Optional.** ESX or ESXi hostname. Conflicts with **vmware_datacenter**.
3103 vmware_vmname | **Required.** Virtual machine name.
3104 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
3105 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
3106 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
3107 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
3108 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
3109 vmware_sessionfile | **Optional.** Session file name enhancement.
3110 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
3111 vmware_nosession | **Optional.** No auth session - IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
3112 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
3113 vmware_password | **Optional.** The username's password. No value defined as default.
3114 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
3115 vmware_warn | **Optional.** Warning threshold in percent. Defaults to "80%".
3116 vmware_crit | **Optional.** Critical threshold in percent. Defaults to "90%".
3119 ## <a id="plugins-contrib-vmware-esx-soap-vm-mem"></a> vmware-esx-soap-vm-mem
3121 Check command object for the `check_vmware_esx` plugin. Shows all memory info, except overall.
3123 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
3126 ------------------------|--------------
3127 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. Conflicts with **vmware_host**.
3128 vmware_host | **Optional.** ESX or ESXi hostname. Conflicts with **vmware_datacenter**.
3129 vmware_vmname | **Required.** Virtual machine name.
3130 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
3131 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
3132 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
3133 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
3134 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
3135 vmware_sessionfile | **Optional.** Session file name enhancement.
3136 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
3137 vmware_nosession | **Optional.** No auth session - IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
3138 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
3139 vmware_password | **Optional.** The username's password. No value defined as default.
3140 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
3143 ## <a id="plugins-contrib-vmware-esx-soap-vm-mem-usage"></a> vmware-esx-soap-vm-mem-usage
3145 Check command object for the `check_vmware_esx` plugin. Average mem usage in percentage of configured virtual machine "physical" memory.
3147 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
3150 ------------------------|--------------
3151 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. Conflicts with **vmware_host**.
3152 vmware_host | **Optional.** ESX or ESXi hostname. Conflicts with **vmware_datacenter**.
3153 vmware_vmname | **Required.** Virtual machine name.
3154 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
3155 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
3156 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
3157 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
3158 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
3159 vmware_sessionfile | **Optional.** Session file name enhancement.
3160 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
3161 vmware_nosession | **Optional.** No auth session - IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
3162 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
3163 vmware_password | **Optional.** The username's password. No value defined as default.
3164 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
3165 vmware_warn | **Optional.** Warning threshold in percent. Defaults to "80%".
3166 vmware_crit | **Optional.** Critical threshold in percent. Defaults to "90%".
3169 ## <a id="plugins-contrib-vmware-esx-soap-vm-mem-consumed"></a> vmware-esx-soap-vm-mem-consumed
3171 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>
3172 **vm consumed memory = memory granted - memory saved**
3174 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
3177 ------------------------|--------------
3178 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. Conflicts with **vmware_host**.
3179 vmware_host | **Optional.** ESX or ESXi hostname. Conflicts with **vmware_datacenter**.
3180 vmware_vmname | **Required.** Virtual machine name.
3181 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
3182 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
3183 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
3184 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
3185 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
3186 vmware_sessionfile | **Optional.** Session file name enhancement.
3187 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
3188 vmware_nosession | **Optional.** No auth session - IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
3189 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
3190 vmware_password | **Optional.** The username's password. No value defined as default.
3191 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
3192 vmware_warn | **Optional.** The warning threshold. No value defined as default.
3193 vmware_crit | **Optional.** The critical threshold. No value defined as default.
3196 ## <a id="plugins-contrib-vmware-esx-soap-vm-mem-memctl"></a> vmware-esx-soap-vm-mem-memctl
3198 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.
3200 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
3203 ------------------------|--------------
3204 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. Conflicts with **vmware_host**.
3205 vmware_host | **Optional.** ESX or ESXi hostname. Conflicts with **vmware_datacenter**.
3206 vmware_vmname | **Required.** Virtual machine name.
3207 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
3208 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
3209 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
3210 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
3211 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
3212 vmware_sessionfile | **Optional.** Session file name enhancement.
3213 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
3214 vmware_nosession | **Optional.** No auth session - IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
3215 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
3216 vmware_password | **Optional.** The username's password. No value defined as default.
3217 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
3218 vmware_warn | **Optional.** The warning threshold. No value defined as default.
3219 vmware_crit | **Optional.** The critical threshold. No value defined as default.
3223 ## <a id="plugins-contrib-vmware-esx-soap-vm-net"></a> vmware-esx-soap-vm-net
3225 Check command object for the `check_vmware_esx` plugin. Shows net info.
3227 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
3230 ------------------------|--------------
3231 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. Conflicts with **vmware_host**.
3232 vmware_host | **Optional.** ESX or ESXi hostname. Conflicts with **vmware_datacenter**.
3233 vmware_vmname | **Required.** Virtual machine name.
3234 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
3235 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
3236 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
3237 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
3238 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
3239 vmware_sessionfile | **Optional.** Session file name enhancement.
3240 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
3241 vmware_nosession | **Optional.** No auth session - IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
3242 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
3243 vmware_password | **Optional.** The username's password. No value defined as default.
3244 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
3247 ## <a id="plugins-contrib-vmware-esx-soap-vm-net-usage"></a> vmware-esx-soap-vm-net-usage
3249 Check command object for the `check_vmware_esx` plugin. Overall network usage in KBps(Kilobytes per Second).
3251 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
3254 ------------------------|--------------
3255 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. Conflicts with **vmware_host**.
3256 vmware_host | **Optional.** ESX or ESXi hostname. Conflicts with **vmware_datacenter**.
3257 vmware_vmname | **Required.** Virtual machine name.
3258 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
3259 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
3260 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
3261 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
3262 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
3263 vmware_sessionfile | **Optional.** Session file name enhancement.
3264 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
3265 vmware_nosession | **Optional.** No auth session - IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
3266 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
3267 vmware_password | **Optional.** The username's password. No value defined as default.
3268 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
3269 vmware_warn | **Optional.** The warning threshold. No value defined as default.
3270 vmware_crit | **Optional.** The critical threshold. No value defined as default.
3273 ## <a id="plugins-contrib-vmware-esx-soap-vm-net-receive"></a> vmware-esx-soap-vm-net-receive
3275 Check command object for the `check_vmware_esx` plugin. Receive in KBps(Kilobytes per Second).
3277 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
3280 ------------------------|--------------
3281 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. Conflicts with **vmware_host**.
3282 vmware_host | **Optional.** ESX or ESXi hostname. Conflicts with **vmware_datacenter**.
3283 vmware_vmname | **Required.** Virtual machine name.
3284 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
3285 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
3286 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
3287 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
3288 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
3289 vmware_sessionfile | **Optional.** Session file name enhancement.
3290 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
3291 vmware_nosession | **Optional.** No auth session - IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
3292 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
3293 vmware_password | **Optional.** The username's password. No value defined as default.
3294 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
3295 vmware_warn | **Optional.** The warning threshold. No value defined as default.
3296 vmware_crit | **Optional.** The critical threshold. No value defined as default.
3299 ## <a id="plugins-contrib-vmware-esx-soap-vm-net-send"></a> vmware-esx-soap-vm-net-send
3301 Check command object for the `check_vmware_esx` plugin. Send in KBps(Kilobytes per Second).
3303 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
3306 ------------------------|--------------
3307 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. Conflicts with **vmware_host**.
3308 vmware_host | **Optional.** ESX or ESXi hostname. Conflicts with **vmware_datacenter**.
3309 vmware_vmname | **Required.** Virtual machine name.
3310 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
3311 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
3312 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
3313 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
3314 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
3315 vmware_sessionfile | **Optional.** Session file name enhancement.
3316 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
3317 vmware_nosession | **Optional.** No auth session - IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
3318 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
3319 vmware_password | **Optional.** The username's password. No value defined as default.
3320 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
3321 vmware_warn | **Optional.** The warning threshold. No value defined as default.
3322 vmware_crit | **Optional.** The critical threshold. No value defined as default.
3325 ## <a id="plugins-contrib-vmware-esx-soap-vm-io"></a> vmware-esx-soap-vm-io
3327 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.
3329 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
3332 ------------------------|--------------
3333 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. Conflicts with **vmware_host**.
3334 vmware_host | **Optional.** ESX or ESXi hostname. Conflicts with **vmware_datacenter**.
3335 vmware_vmname | **Required.** Virtual machine name.
3336 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
3337 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
3338 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
3339 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
3340 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
3341 vmware_sessionfile | **Optional.** Session file name enhancement.
3342 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
3343 vmware_nosession | **Optional.** No auth session - IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
3344 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
3345 vmware_password | **Optional.** The username's password. No value defined as default.
3346 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
3349 ## <a id="plugins-contrib-vmware-esx-soap-vm-io-read"></a> vmware-esx-soap-vm-io-read
3351 Check command object for the `check_vmware_esx` plugin. Average number of kilobytes read from the disk each second.
3353 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
3356 ------------------------|--------------
3357 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. Conflicts with **vmware_host**.
3358 vmware_host | **Optional.** ESX or ESXi hostname. Conflicts with **vmware_datacenter**.
3359 vmware_vmname | **Required.** Virtual machine name.
3360 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
3361 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
3362 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
3363 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
3364 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
3365 vmware_sessionfile | **Optional.** Session file name enhancement.
3366 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
3367 vmware_nosession | **Optional.** No auth session - IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
3368 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
3369 vmware_password | **Optional.** The username's password. No value defined as default.
3370 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
3371 vmware_warn | **Optional.** The warning threshold. No value defined as default.
3372 vmware_crit | **Optional.** The critical threshold. No value defined as default.
3375 ## <a id="plugins-contrib-vmware-esx-soap-vm-io-write"></a> vmware-esx-soap-vm-io-write
3377 Check command object for the `check_vmware_esx` plugin. Average number of kilobytes written to disk each second.
3379 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
3382 ------------------------|--------------
3383 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. Conflicts with **vmware_host**.
3384 vmware_host | **Optional.** ESX or ESXi hostname. Conflicts with **vmware_datacenter**.
3385 vmware_vmname | **Required.** Virtual machine name.
3386 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
3387 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
3388 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
3389 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
3390 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
3391 vmware_sessionfile | **Optional.** Session file name enhancement.
3392 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
3393 vmware_nosession | **Optional.** No auth session - IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
3394 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
3395 vmware_password | **Optional.** The username's password. No value defined as default.
3396 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
3397 vmware_warn | **Optional.** The warning threshold. No value defined as default.
3398 vmware_crit | **Optional.** The critical threshold. No value defined as default.
3401 ## <a id="plugins-contrib-vmware-esx-soap-vm-io-usage"></a> vmware-esx-soap-vm-io-usage
3403 Check command object for the `check_vmware_esx` plugin. Aggregated disk I/O rate.
3405 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
3408 ------------------------|--------------
3409 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. Conflicts with **vmware_host**.
3410 vmware_host | **Optional.** ESX or ESXi hostname. Conflicts with **vmware_datacenter**.
3411 vmware_vmname | **Required.** Virtual machine name.
3412 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
3413 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
3414 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
3415 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
3416 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
3417 vmware_sessionfile | **Optional.** Session file name enhancement.
3418 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
3419 vmware_nosession | **Optional.** No auth session - IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
3420 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
3421 vmware_password | **Optional.** The username's password. No value defined as default.
3422 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
3423 vmware_warn | **Optional.** The warning threshold. No value defined as default.
3424 vmware_crit | **Optional.** The critical threshold. No value defined as default.
3427 ## <a id="plugins-contrib-vmware-esx-soap-vm-runtime"></a> vmware-esx-soap-vm-runtime
3429 Check command object for the `check_vmware_esx` plugin. Shows virtual machine runtime info.
3431 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
3434 ------------------------|--------------
3435 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. Conflicts with **vmware_host**.
3436 vmware_host | **Optional.** ESX or ESXi hostname. Conflicts with **vmware_datacenter**.
3437 vmware_vmname | **Required.** Virtual machine name.
3438 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
3439 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
3440 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
3441 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
3442 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
3443 vmware_sessionfile | **Optional.** Session file name enhancement.
3444 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
3445 vmware_nosession | **Optional.** No auth session - IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
3446 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
3447 vmware_password | **Optional.** The username's password. No value defined as default.
3448 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
3451 ## <a id="plugins-contrib-vmware-esx-soap-vm-runtime-con"></a> vmware-esx-soap-vm-runtime-con
3453 Check command object for the `check_vmware_esx` plugin. Shows the connection state.
3455 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
3458 ------------------------|--------------
3459 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. Conflicts with **vmware_host**.
3460 vmware_host | **Optional.** ESX or ESXi hostname. Conflicts with **vmware_datacenter**.
3461 vmware_vmname | **Required.** Virtual machine name.
3462 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
3463 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
3464 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
3465 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
3466 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
3467 vmware_sessionfile | **Optional.** Session file name enhancement.
3468 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
3469 vmware_nosession | **Optional.** No auth session - IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
3470 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
3471 vmware_password | **Optional.** The username's password. No value defined as default.
3472 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
3475 ## <a id="plugins-contrib-vmware-esx-soap-vm-runtime-powerstate"></a> vmware-esx-soap-vm-runtime-powerstate
3477 Check command object for the `check_vmware_esx` plugin. Shows virtual machine power state: poweredOn, poweredOff or suspended.
3479 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
3482 ------------------------|--------------
3483 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. Conflicts with **vmware_host**.
3484 vmware_host | **Optional.** ESX or ESXi hostname. Conflicts with **vmware_datacenter**.
3485 vmware_vmname | **Required.** Virtual machine name.
3486 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
3487 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
3488 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
3489 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
3490 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
3491 vmware_sessionfile | **Optional.** Session file name enhancement.
3492 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
3493 vmware_nosession | **Optional.** No auth session - IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
3494 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
3495 vmware_password | **Optional.** The username's password. No value defined as default.
3496 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
3499 ## <a id="plugins-contrib-vmware-esx-soap-vm-runtime-status"></a> vmware-esx-soap-vm-runtime-status
3501 Check command object for the `check_vmware_esx` plugin. Overall object status (gray/green/red/yellow).
3503 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
3506 ------------------------|--------------
3507 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. Conflicts with **vmware_host**.
3508 vmware_host | **Optional.** ESX or ESXi hostname. Conflicts with **vmware_datacenter**.
3509 vmware_vmname | **Required.** Virtual machine name.
3510 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
3511 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
3512 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
3513 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
3514 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
3515 vmware_sessionfile | **Optional.** Session file name enhancement.
3516 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
3517 vmware_nosession | **Optional.** No auth session - IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
3518 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
3519 vmware_password | **Optional.** The username's password. No value defined as default.
3520 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
3523 ## <a id="plugins-contrib-vmware-esx-soap-vm-runtime-consoleconnections"></a> vmware-esx-soap-vm-runtime-consoleconnections
3525 Check command object for the `check_vmware_esx` plugin. Console connections to virtual machine.
3527 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
3530 ------------------------|--------------
3531 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. Conflicts with **vmware_host**.
3532 vmware_host | **Optional.** ESX or ESXi hostname. Conflicts with **vmware_datacenter**.
3533 vmware_vmname | **Required.** Virtual machine name.
3534 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
3535 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
3536 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
3537 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
3538 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
3539 vmware_sessionfile | **Optional.** Session file name enhancement.
3540 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
3541 vmware_nosession | **Optional.** No auth session - IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
3542 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
3543 vmware_password | **Optional.** The username's password. No value defined as default.
3544 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
3545 vmware_warn | **Optional.** The warning threshold. No value defined as default.
3546 vmware_crit | **Optional.** The critical threshold. No value defined as default.
3549 ## <a id="plugins-contrib-vmware-esx-soap-vm-runtime-gueststate"></a> vmware-esx-soap-vm-runtime-gueststate
3551 Check command object for the `check_vmware_esx` plugin. Guest OS status. Needs VMware Tools installed and running.
3553 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
3556 ------------------------|--------------
3557 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. Conflicts with **vmware_host**.
3558 vmware_host | **Optional.** ESX or ESXi hostname. Conflicts with **vmware_datacenter**.
3559 vmware_vmname | **Required.** Virtual machine name.
3560 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
3561 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
3562 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
3563 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
3564 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
3565 vmware_sessionfile | **Optional.** Session file name enhancement.
3566 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
3567 vmware_nosession | **Optional.** No auth session - IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
3568 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
3569 vmware_password | **Optional.** The username's password. No value defined as default.
3570 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
3572 ## <a id="plugins-contrib-vmware-esx-soap-vm-runtime-tools"></a> vmware-esx-soap-vm-runtime-tools
3574 Check command object for the `check_vmware_esx` plugin. Guest OS status. VMware tools status.
3576 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
3579 ------------------------|--------------
3580 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. Conflicts with **vmware_host**.
3581 vmware_host | **Optional.** ESX or ESXi hostname. Conflicts with **vmware_datacenter**.
3582 vmware_vmname | **Required.** Virtual machine name.
3583 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
3584 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
3585 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
3586 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
3587 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
3588 vmware_sessionfile | **Optional.** Session file name enhancement.
3589 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
3590 vmware_nosession | **Optional.** No auth session - IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
3591 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
3592 vmware_password | **Optional.** The username's password. No value defined as default.
3593 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
3596 ## <a id="plugins-contrib-vmware-esx-soap-vm-runtime-issues"></a> vmware-esx-soap-vm-runtime-issues
3598 Check command object for the `check_vmware_esx` plugin. All issues for the virtual machine.
3600 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
3603 ------------------------|--------------
3604 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. Conflicts with **vmware_host**.
3605 vmware_host | **Optional.** ESX or ESXi hostname. Conflicts with **vmware_datacenter**.
3606 vmware_vmname | **Required.** Virtual machine name.
3607 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
3608 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
3609 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
3610 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
3611 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
3612 vmware_sessionfile | **Optional.** Session file name enhancement.
3613 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
3614 vmware_nosession | **Optional.** No auth session - IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
3615 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
3616 vmware_password | **Optional.** The username's password. No value defined as default.
3617 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
3618 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.