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 5668.
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-passive"></a> passive
539 Specialised check command object for passive checks executing the `check_dummy` plugin with appropriate default values.
541 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
544 ----------------|--------------
545 dummy_state | **Optional.** The state. Can be one of 0 (ok), 1 (warning), 2 (critical) and 3 (unknown). Defaults to 3.
546 dummy_text | **Optional.** Plugin output. Defaults to "No Passive Check Result Received.".
549 ## <a id="plugin-check-command-ping"></a> ping
551 Check command object for the `check_ping` plugin. This command uses the host's `address` attribute
552 if available and falls back to using the `address6` attribute if the `address` attribute is not set.
555 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
558 ----------------|--------------
559 ping_address | **Optional.** The host's address. Defaults to "$address$" if the host's `address` attribute is set, "$address6$" otherwise.
560 ping_wrta | **Optional.** The RTA warning threshold in milliseconds. Defaults to 100.
561 ping_wpl | **Optional.** The packet loss warning threshold in %. Defaults to 5.
562 ping_crta | **Optional.** The RTA critical threshold in milliseconds. Defaults to 200.
563 ping_cpl | **Optional.** The packet loss critical threshold in %. Defaults to 15.
564 ping_packets | **Optional.** The number of packets to send. Defaults to 5.
565 ping_timeout | **Optional.** The plugin timeout in seconds. Defaults to 0 (no timeout).
568 ## <a id="plugin-check-command-ping4"></a> ping4
570 Check command object for the `check_ping` plugin.
572 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
575 ----------------|--------------
576 ping_address | **Optional.** The host's IPv4 address. Defaults to "$address$".
577 ping_wrta | **Optional.** The RTA warning threshold in milliseconds. Defaults to 100.
578 ping_wpl | **Optional.** The packet loss warning threshold in %. Defaults to 5.
579 ping_crta | **Optional.** The RTA critical threshold in milliseconds. Defaults to 200.
580 ping_cpl | **Optional.** The packet loss critical threshold in %. Defaults to 15.
581 ping_packets | **Optional.** The number of packets to send. Defaults to 5.
582 ping_timeout | **Optional.** The plugin timeout in seconds. Defaults to 0 (no timeout).
584 ## <a id="plugin-check-command-ping6"></a> ping6
586 Check command object for the `check_ping` plugin.
588 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
591 ----------------|--------------
592 ping_address | **Optional.** The host's IPv6 address. Defaults to "$address6$".
593 ping_wrta | **Optional.** The RTA warning threshold in milliseconds. Defaults to 100.
594 ping_wpl | **Optional.** The packet loss warning threshold in %. Defaults to 5.
595 ping_crta | **Optional.** The RTA critical threshold in milliseconds. Defaults to 200.
596 ping_cpl | **Optional.** The packet loss critical threshold in %. Defaults to 15.
597 ping_packets | **Optional.** The number of packets to send. Defaults to 5.
598 ping_timeout | **Optional.** The plugin timeout in seconds. Defaults to 0 (no timeout).
601 ## <a id="plugin-check-command-pop"></a> pop
603 Check command object for the `check_pop` plugin.
605 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
608 ----------------|--------------
609 pop_address | **Optional.** The host's address. Defaults to "$address$" if the host's `address` attribute is set, "$address6$" otherwise.
610 pop_port | **Optional.** The port that should be checked. Defaults to 110.
613 ## <a id="plugin-check-command-processes"></a> procs
615 Check command object for the `check_procs` plugin.
617 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
620 ---------------------|--------------
621 procs_warning | **Optional.** The process count warning threshold. Defaults to 250.
622 procs_critical | **Optional.** The process count critical threshold. Defaults to 400.
623 procs_metric | **Optional.** Check thresholds against metric.
624 procs_timeout | **Optional.** Seconds before plugin times out.
625 procs_traditional | **Optional.** Filter own process the traditional way by PID instead of /proc/pid/exe. Defaults to false.
626 procs_state | **Optional.** Only scan for processes that have one or more of the status flags you specify.
627 procs_ppid | **Optional.** Only scan for children of the parent process ID indicated.
628 procs_vsz | **Optional.** Only scan for processes with VSZ higher than indicated.
629 procs_rss | **Optional.** Only scan for processes with RSS higher than indicated.
630 procs_pcpu | **Optional.** Only scan for processes with PCPU higher than indicated.
631 procs_user | **Optional.** Only scan for processes with user name or ID indicated.
632 procs_argument | **Optional.** Only scan for processes with args that contain STRING.
633 procs_argument_regex | **Optional.** Only scan for processes with args that contain the regex STRING.
634 procs_command | **Optional.** Only scan for exact matches of COMMAND (without path).
635 procs_nokthreads | **Optional.** Only scan for non kernel threads. Defaults to false.
638 ## <a id="plugin-check-command-simap"></a> simap
640 Check command object for the `check_simap` plugin.
642 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
645 ----------------|--------------
646 simap_address | **Optional.** The host's address. Defaults to "$address$" if the host's `address` attribute is set, "$address6$" otherwise.
647 simap_port | **Optional.** The host's port.
650 ## <a id="plugin-check-command-smtp"></a> smtp
652 Check command object for the `check_smtp` plugin.
654 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
657 ---------------------|--------------
658 smtp_address | **Optional.** The host's address. Defaults to "$address$" if the host's `address` attribute is set, "$address6$" otherwise.
659 smtp_port | **Optional.** The port that should be checked. Defaults to 25.
660 smtp_mail_from | **Optional.** Test a MAIL FROM command with the given email address.
663 ## <a id="plugin-check-command-snmp"></a> snmp
665 Check command object for the `check_snmp` plugin.
667 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
670 --------------------|--------------
671 snmp_address | **Optional.** The host's address. Defaults to "$address$" if the host's `address` attribute is set, "$address6$" otherwise.
672 snmp_oid | **Required.** The SNMP OID.
673 snmp_community | **Optional.** The SNMP community. Defaults to "public".
674 snmp_warn | **Optional.** The warning threshold.
675 snmp_crit | **Optional.** The critical threshold.
676 snmp_string | **Optional.** Return OK state if the string matches exactly with the output value
677 snmp_ereg | **Optional.** Return OK state if extended regular expression REGEX matches with the output value
678 snmp_eregi | **Optional.** Return OK state if case-insensitive extended REGEX matches with the output value
679 snmp_label | **Optional.** Prefix label for output value
680 snmp_invert_search | **Optional.** Invert search result and return CRITICAL state if found
681 snmp_units | **Optional.** Units label(s) for output value (e.g., 'sec.').
682 snmp_version | **Optional.** Version to use. E.g. 1, 2, 2c or 3.
683 snmp_miblist | **Optional.** MIB's to use, comma separated. Defaults to "ALL".
684 snmp_rate_multiplier | **Optional.** Converts rate per second. For example, set to 60 to convert to per minute.
685 snmp_rate | **Optional.** Boolean. Enable rate calculation.
686 snmp_getnext | **Optional.** Boolean. Use SNMP GETNEXT. Defaults to false.
687 snmp_timeout | **Optional.** The command timeout in seconds. Defaults to 10 seconds.
689 ## <a id="plugin-check-command-snmpv3"></a> snmpv3
691 Check command object for the `check_snmp` plugin, using SNMPv3 authentication and encryption options.
693 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
696 ------------------|--------------
697 snmpv3_address | **Optional.** The host's address. Defaults to "$address$" if the host's `address` attribute is set, "$address6$" otherwise.
698 snmpv3_user | **Required.** The username to log in with.
699 snmpv3_auth_alg | **Optional.** The authentication algorithm. Defaults to SHA.
700 snmpv3_auth_key | **Required.** The authentication key.
701 snmpv3_priv_alg | **Optional.** The encryption algorithm. Defaults to AES.
702 snmpv3_priv_key | **Required.** The encryption key.
703 snmpv3_oid | **Required.** The SNMP OID.
704 snmpv3_warn | **Optional.** The warning threshold.
705 snmpv3_crit | **Optional.** The critical threshold.
706 snmpv3_label | **Optional.** Prefix label for output value.
708 ## <a id="plugin-check-command-snmp-uptime"></a> snmp-uptime
710 Check command object for the `check_snmp` plugin.
712 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
715 ----------------|--------------
716 snmp_address | **Optional.** The host's address. Defaults to "$address$" if the host's `address` attribute is set, "$address6$" otherwise.
717 snmp_oid | **Optional.** The SNMP OID. Defaults to "1.3.6.1.2.1.1.3.0".
718 snmp_community | **Optional.** The SNMP community. Defaults to "public".
721 ## <a id="plugin-check-command-spop"></a> spop
723 Check command object for the `check_spop` plugin.
725 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
728 ----------------|--------------
729 spop_address | **Optional.** The host's address. Defaults to "$address$" if the host's `address` attribute is set, "$address6$" otherwise.
730 spop_port | **Optional.** The host's port.
733 ## <a id="plugin-check-command-ssh"></a> ssh
735 Check command object for the `check_ssh` plugin.
737 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
740 ----------------|--------------
741 ssh_address | **Optional.** The host's address. Defaults to "$address$" if the host's `address` attribute is set, "$address6$" otherwise.
742 ssh_port | **Optional.** The port that should be checked. Defaults to 22.
743 ssh_timeout | **Optional.** Seconds before connection times out. Defaults to 10.
746 ## <a id="plugin-check-command-ssl"></a> ssl
748 Check command object for the `check_tcp` plugin, using ssl-related options.
750 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
753 ------------------------------|--------------
754 ssl_address | **Optional.** The host's address. Defaults to "$address$" if the host's `address` attribute is set, "$address6$" otherwise.
755 ssl_port | **Required.** The port that should be checked.
756 ssl_timeout | **Optional.** Timeout in seconds for the connect and handshake. The plugin default is 10 seconds.
757 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.
758 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.
761 ## <a id="plugin-check-command-ssmtp"></a> ssmtp
763 Check command object for the `check_ssmtp` plugin.
765 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
768 ----------------|--------------
769 ssmtp_address | **Required.** The host's address. Defaults to "$address$" if the host's `address` attribute is set, "$address6$" otherwise.
770 ssmtp_port | **Optional.** The port that should be checked. Defaults to 465.
773 ## <a id="plugin-check-command-swap"></a> swap
775 Check command object for the `check_swap` plugin.
777 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
780 ----------------|--------------
781 swap_wfree | **Optional.** The free swap space warning threshold in %. Defaults to 50.
782 swap_cfree | **Optional.** The free swap space critical threshold in %. Defaults to 25.
785 ## <a id="plugin-check-command-tcp"></a> tcp
787 Check command object for the `check_tcp` plugin.
789 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
792 ----------------|--------------
793 tcp_address | **Optional.** The host's address. Defaults to "$address$" if the host's `address` attribute is set, "$address6$" otherwise.
794 tcp_port | **Required.** The port that should be checked.
795 tcp_expect | **Optional.** String to expect in server response (may be repeated).
796 tcp_all | **Optional.** All expect strings need to occur in server response. Defaults to false.
797 tcp_escape_send | **Optional.** Enable usage of \n, \r, \t or \\\\ in send string.
798 tcp_send | **Optional.** String to send to the server.
799 tcp_escape_quit | **Optional.** Enable usage of \n, \r, \t or \\\\ in quit string.
800 tcp_quit | **Optional.** String to send server to initiate a clean close of the connection.
801 tcp_refuse | **Optional.** Accept TCP refusals with states ok, warn, crit. Defaults to crit.
802 tcp_mismatch | **Optional.** Accept expected string mismatches with states ok, warn, crit. Defaults to warn.
803 tcp_jail | **Optional.** Hide output from TCP socket.
804 tcp_maxbytes | **Optional.** Close connection once more than this number of bytes are received.
805 tcp_delay | **Optional.** Seconds to wait between sending string and polling for response.
806 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.
807 tcp_ssl | **Optional.** Use SSL for the connection. Defaults to false.
808 tcp_wtime | **Optional.** Response time to result in warning status (seconds).
809 tcp_ctime | **Optional.** Response time to result in critical status (seconds).
810 tcp_timeout | **Optional.** Seconds before connection times out. Defaults to 10.
813 ## <a id="plugin-check-command-udp"></a> udp
815 Check command object for the `check_udp` plugin.
817 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
820 ----------------|--------------
821 udp_address | **Optional.** The host's address. Defaults to "$address$" if the host's `address` attribute is set, "$address6$" otherwise.
822 udp_port | **Required.** The port that should be checked.
823 udp_send | **Required.** The payload to send in the UDP datagram.
824 udp_expect | **Required.** The payload to expect in the response datagram.
825 udp_quit | **Optional.** The payload to send to 'close' the session.
828 ## <a id="plugin-check-command-ups"></a> ups
830 Check command object for the `check_ups` plugin.
832 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
835 ----------------|--------------
836 ups_address | **Required.** The address of the host running upsd. Defaults to "$address$" if the host's `address` attribute is set, "$address6$" otherwise.
837 ups_name | **Required.** The UPS name. Defaults to `ups`.
838 ups_port | **Optional.** The port to which to connect. Defaults to 3493.
839 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`.
840 ups_warning | **Optional.** The warning threshold for the selected variable.
841 ups_critical | **Optional.** The critical threshold for the selected variable.
842 ups_celsius | **Optional.** Display the temperature in degrees Celsius instead of Fahrenheit. Defaults to `false`.
843 ups_timeout | **Optional.** The number of seconds before the connection times out. Defaults to 10.
846 ## <a id="plugin-check-command-users"></a> users
848 Check command object for the `check_users` plugin.
850 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
853 ----------------|--------------
854 users_wgreater | **Optional.** The user count warning threshold. Defaults to 20.
855 users_cgreater | **Optional.** The user count critical threshold. Defaults to 50.
858 # <a id="windows-plugins"></a>Icinga 2 Windows plugins
860 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.
862 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:
864 include <windows-plugins>
866 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.
869 ## <a id"windows-plugins-thresholds"></a>Threshold syntax
871 So not specified differently the thresholds for the plugins all follow the same pattern
874 :------------|:----------
875 "29" | The threshold is 29.
876 "!29" | The threshold is 29, but the negative of the result is returned.
877 "[10-40]" | The threshold is a range from (including) 20 to 40, a value inside means the threshold has been exceeded.
878 "![10-40]" | Same as above, but the result is inverted.
881 ## <a id="windows-plugins-disk-windows"></a>disk-windows
883 Check command object for the `check_disk.exe` plugin.
884 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.).
889 :---------------|:------------
890 disk\_win\_warn | **Optional**. The warning threshold.
891 disk\_win\_crit | **Optional**. The critical threshold.
892 disk\_win\_path | **Optional**. Check only these paths, default checks all.
893 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.
896 ## <a id="windows-plugins-load-windows"></a>load-windows
898 Check command object for the `check_load.exe` plugin.
899 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).
904 :---------------|:------------
905 load\_win\_warn | **Optional**. The warning threshold.
906 load\_win\_crit | **Optional**. The critical threshold.
909 ## <a id="windows-plugins-memory-windows"></a>memory-windows
911 Check command object for the `check_memory.exe` plugin.
912 The memory collection is instant.
917 :-----------------|:------------
918 memory\_win\_warn | **Optional**. The warning threshold.
919 memory\_win\_crit | **Optional**. The critical threshold.
920 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.
923 ## <a id="windows-plugins-network-windows"></a>network-windows
925 Check command object for the `check_network.exe` plugin.
926 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).
931 :------------------|:------------
932 network\_win\_warn | **Optional**. The warning threshold.
933 network\_win\_crit | **Optional**. The critical threshold.
936 ## <a id="windows-plugins-permon-windows"></a>perfmon-windows
938 Check command object for the `check_perfmon.exe` plugin.
939 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`.
941 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"`
946 :---------------------|:------------
947 perfmon\_win\_warn | **Optional**. The warning threshold.
948 perfmon\_win\_crit | **Optional**. The critical threshold.
949 perfmon\_win\_counter | **Required**. The Performance Counter to use. Ex. `\Processor(_Total)\% Idle Time`.
950 perfmon\_win\_wait | **Optional**. Time in milliseconds to wait between data collection (default: 1000).
951 perfmon\_win\_type | **Optional**. Format in which to expect perfomance values. Possible are: long, int64 and double (default).
954 ## <a id="windows-plugins-ping-windows"></a>ping-windows
956 Check command object for the `check_ping.exe` plugin.
957 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.
962 :------------------|:------------
963 ping\_win\_warn | **Optional**. The warning threshold. RTA and package loss seperated by comma.
964 ping\_win\_crit | **Optional**. The critical threshold. RTA and package loss seperated by comma.
965 ping\_win\_address | **Required**. An IPv4 or IPv6 address
966 ping\_win\_packets | **Optional**. Number of packages to send. Default: 5.
967 ping\_win\_timeout | **Optional**. The timeout in milliseconds. Default: 1000
970 ## <a id="windows-plugins-procs-windows"></a>procs-windows
972 Check command object for `check_procs.exe` plugin.
973 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.
978 :----------------|:------------
979 procs\_win\_warn | **Optional**. The warning threshold.
980 procs\_win\_crit | **Optional**. The critical threshold.
981 procs\_win\_user | **Optional**. Count this useres processes.
984 ## <a id="windows-plugins-service-windows"></a>service-windows
986 Check command object for `check_service.exe` plugin.
987 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.
992 :---------------------|:------------
993 service\_win\_warn | **Optional**. Warn when service is not running.
994 service\_win\_service | **Required**. The critical threshold.
997 ## <a id="windows-plugins-swap-windows"></a>swap-windows
999 Check command object for `check_swap.exe` plugin.
1000 The data collection is instant.
1005 :---------------|:------------
1006 swap\_win\_warn | **Optional**. The warning threshold.
1007 swap\_win\_crit | **Optional**. The critical threshold.
1008 swap\_win\_unit | **Optional**. The unit to display the received value in, thresholds are interpreted in this unit. Defaults to "mb" (megabyte).
1011 ## <a id="windows-plugins-update-windows"></a>update-windows
1013 Check command object for `check_update.exe` plugin.
1014 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.
1019 :-------------------|:------------
1020 update\_win\_warn | If set returns warning when important updates are available
1021 update\_win\_crit | If set return critical when important updates that require a reboot are available.
1022 update\_win\_reboot | Set to treat 'may need update' as 'definitely needs update'
1025 ## <a id="windows-plugins-uptime-windows"></a>uptime-windows
1027 Check command opject for `check_uptime.exe` plugin.
1028 Uses GetTickCount64 to get the uptime, so boot time is not included.
1033 :-----------------|:------------
1034 uptime\_win\_warn | **Optional**. The warning threshold.
1035 uptime\_win\_crit | **Optional**. The critical threshold.
1036 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).
1039 ## <a id="windows-plugins-users-windows"></a>users-windows
1041 Check command object for `check_users.exe` plugin.
1046 :----------------|:------------
1047 users\_win\_warn | **Optional**. The warning threshold.
1048 users\_win\_crit | **Optional**. The critical threshold.
1051 # <a id="nscp-plugin-check-commands"></a> NSClient++ Check Commands
1053 Icinga 2 can use the `nscp client` command to run arbitrary NSClient++ checks.
1055 You can enable these check commands by adding the following the include directive in your
1056 [icinga2.conf](4-configuring-icinga-2.md#icinga2-conf) configuration file:
1060 You can also optionally specify an alternative installation directory for NSClient++ by adding
1061 the NscpPath constant in your [constants.conf](4-configuring-icinga-2.md#constants-conf) configuration
1064 const NscpPath = "C:\\Program Files (x86)\\NSClient++"
1066 By default Icinga 2 uses the Microsoft Installer API to determine where NSClient++ is installed. It should
1067 not be necessary to manually set this constant.
1069 Note that it is not necessary to run NSClient++ as a Windows service for these commands to work.
1071 ## <a id="nscp-check-local"></a> nscp-local
1073 Check command object for NSClient++
1075 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
1078 ----------------|--------------
1079 nscp_path | **Optional.** Can be used to override the NSClient++ on a per-command basis. Defaults to NscpPath.
1080 nscp_log_level | **Optional.** The log level. Defaults to "critical".
1081 nscp_load_all | **Optional.** Whether to load all modules. Defaults to true.
1082 nscp_boot | **Optional.** Whether to use the --boot option. Defaults to true.
1083 nscp_query | **Required.** The NSClient++ query. Try `nscp client -q x` for a list.
1084 nscp_arguments | **Optional.** An array of query arguments.
1086 ## <a id="nscp-check-local-cpu"></a> nscp-local-cpu
1088 Check command object for the `check_cpu` NSClient++ plugin.
1090 This command has the same custom attributes like the `nscp-local` check command.
1092 ## <a id="nscp-check-local-memory"></a> nscp-local-memory
1094 Check command object for the `check_memory` NSClient++ plugin.
1096 This command has the same custom attributes like the `nscp-local` check command.
1098 ## <a id="nscp-check-local-os-version"></a> nscp-local-os-version
1100 Check command object for the `check_os_version` NSClient++ plugin.
1102 This command has the same custom attributes like the `nscp-local` check command.
1104 ## <a id="nscp-check-local-pagefile"></a> nscp-local-pagefile
1106 Check command object for the `check_pagefile` NSClient++ plugin.
1108 This command has the same custom attributes like the `nscp-local` check command.
1110 ## <a id="nscp-check-local-process"></a> nscp-local-process
1112 Check command object for the `check_process` NSClient++ plugin.
1114 This command has the same custom attributes like the `nscp-local` check command.
1116 ## <a id="nscp-check-local-service"></a> nscp-local-service
1118 Check command object for the `check_service` NSClient++ plugin.
1120 This command has the same custom attributes like the `nscp-local` check command.
1122 ## <a id="nscp-check-local-uptime"></a> nscp-local-uptime
1124 Check command object for the `check_uptime` NSClient++ plugin.
1126 This command has the same custom attributes like the `nscp-local` check command.
1128 ## <a id="nscp-check-local-version"></a> nscp-local-version
1130 Check command object for the `check_version` NSClient++ plugin.
1132 This command has the same custom attributes like the `nscp-local` check command.
1134 ## <a id="nscp-check-local-disk"></a> nscp-local-disk
1136 Check command object for the `check_drivesize` NSClient++ plugin.
1138 This command has the same custom attributes like the `nscp-local` check command.
1140 # <a id="snmp-manubulon-plugin-check-commands"></a> SNMP Manubulon Plugin Check Commands
1142 The `SNMP Manubulon Plugin Check Commands` provide example configuration for plugin check
1143 commands provided by the [SNMP Manubulon project](http://nagios.manubulon.com/index_snmp.html).
1145 The SNMP manubulon plugin check commands assume that the global constant named `ManubulonPluginDir`
1146 is set to the path where the Manubublon SNMP plugins are installed.
1148 You can enable these plugin check commands by adding the following the include directive in your
1149 [icinga2.conf](4-configuring-icinga-2.md#icinga2-conf) configuration file:
1153 ## Checks by Host Type
1155 **N/A** : Not available for this type.
1157 **SNMP** : Available for simple SNMP query.
1161 **Specific** : Script name for platform specific checks.
1164 Host type | Interface | storage | load/cpu | mem | process | env | specific
1165 ------------------------|------------|----------|-----------|-----|----------|-----|-------------------------
1166 Linux | Yes | Yes | Yes | Yes | Yes | No |
1167 Windows | Yes | Yes | Yes | Yes | Yes | No | check_snmp_win.pl
1168 Cisco router/switch | Yes | N/A | Yes | Yes | N/A | Yes |
1169 HP router/switch | Yes | N/A | Yes | Yes | N/A | No |
1170 Bluecoat proxy | Yes | SNMP | Yes | SNMP| No | Yes |
1171 CheckPoint on SPLAT | Yes | Yes | Yes | Yes | Yes | No | check_snmp_cpfw.pl
1172 CheckPoint on Nokia IP | Yes | Yes | Yes | No | ?? | No | check_snmp_vrrp.pl
1173 Boostedge | Yes | Yes | Yes | Yes | ?? | No | check_snmp_boostedge.pl
1174 AS400 | Yes | Yes | Yes | Yes | No | No |
1175 NetsecureOne Netbox | Yes | Yes | Yes | ?? | Yes | No |
1176 Radware Linkproof | Yes | N/A | SNMP | SNMP| No | No | check_snmp_linkproof_nhr <br> check_snmp_vrrp.pl
1177 IronPort | Yes | SNMP | SNMP | SNMP| No | Yes |
1178 Cisco CSS | Yes | ?? | Yes | Yes | No | ?? | check_snmp_css.pl
1181 ## <a id="plugin-check-command-snmp-load"></a> snmp-load
1183 Check command object for the [check_snmp_load.pl](http://nagios.manubulon.com/snmp_load.html) plugin.
1185 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
1189 ------------------------|--------------
1190 snmp_address | **Optional.** The host's address. Defaults to "$address$" if the host's `address` attribute is set, "$address6$" otherwise.
1191 snmp_nocrypt | **Optional.** Define SNMP encryption. If set **snmp_v3** needs to be set. Defaults to false.
1192 snmp_community | **Optional.** The SNMP community. Defaults to "public".
1193 snmp_port | **Optional.** The SNMP port connection.
1194 snmp_v2 | **Optional.** SNMP version to 2c. Defaults to false.
1195 snmp_v3 | **Optional.** SNMP version to 3. Defaults to false.
1196 snmp_login | **Optional.** SNMP version 3 username. Defaults to "snmpuser".
1197 snmp_password | **Required.** SNMP version 3 password. No value defined as default.
1198 snmp_v3_use_privpass | **Optional.** Define to use SNMP version 3 priv password. Defaults to false.
1199 snmp_authprotocol | **Optional.** SNMP version 3 authentication protocol. Defaults to "md5,des".
1200 snmp_privpass | **Required.** SNMP version 3 priv password. No value defined as default.
1201 snmp_warn | **Optional.** The warning threshold. Change the `snmp_load_type` var to "netsl" for using 3 values.
1202 snmp_crit | **Optional.** The critical threshold. Change the `snmp_load_type` var to "netsl" for using 3 values.
1203 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.
1204 snmp_perf | **Optional.** Enable perfdata values. Defaults to true.
1205 snmp_timeout | **Optional.** The command timeout in seconds. Defaults to 5 seconds.
1207 ## <a id="plugin-check-command-snmp-memory"></a> snmp-memory
1209 Check command object for the [check_snmp_mem.pl](http://nagios.manubulon.com/snmp_mem.html) plugin.
1211 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
1214 ------------------------|--------------
1215 snmp_address | **Optional.** The host's address. Defaults to "$address$" if the host's `address` attribute is set, "$address6$" otherwise.
1216 snmp_nocrypt | **Optional.** Define SNMP encryption. If set **snmp_v3** needs to be set. Defaults to false.
1217 snmp_community | **Optional.** The SNMP community. Defaults to "public".
1218 snmp_port | **Optional.** The SNMP port connection.
1219 snmp_v2 | **Optional.** SNMP version to 2c. Defaults to false.
1220 snmp_v3 | **Optional.** SNMP version to 3. Defaults to false.
1221 snmp_login | **Optional.** SNMP version 3 username. Defaults to "snmpuser".
1222 snmp_password | **Required.** SNMP version 3 password. No value defined as default.
1223 snmp_v3_use_privpass | **Optional.** Define to use SNMP version 3 priv password. Defaults to false.
1224 snmp_authprotocol | **Optional.** SNMP version 3 authentication protocol. Defaults to "md5,des".
1225 snmp_privpass | **Required.** SNMP version 3 priv password. No value defined as default.
1226 snmp_warn | **Optional.** The warning threshold.
1227 snmp_crit | **Optional.** The critical threshold.
1228 snmp_perf | **Optional.** Enable perfdata values. Defaults to true.
1229 snmp_timeout | **Optional.** The command timeout in seconds. Defaults to 5 seconds.
1231 ## <a id="plugin-check-command-snmp-storage"></a> snmp-storage
1233 Check command object for the [check_snmp_storage.pl](http://nagios.manubulon.com/snmp_storage.html) plugin.
1235 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
1238 ------------------------|--------------
1239 snmp_address | **Optional.** The host's address. Defaults to "$address$" if the host's `address` attribute is set, "$address6$" otherwise.
1240 snmp_nocrypt | **Optional.** Define SNMP encryption. If set **snmp_v3** needs to be set. Defaults to false.
1241 snmp_community | **Optional.** The SNMP community. Defaults to "public".
1242 snmp_port | **Optional.** The SNMP port connection.
1243 snmp_v2 | **Optional.** SNMP version to 2c. Defaults to false.
1244 snmp_v3 | **Optional.** SNMP version to 3. Defaults to false.
1245 snmp_login | **Optional.** SNMP version 3 username. Defaults to "snmpuser".
1246 snmp_password | **Required.** SNMP version 3 password. No value defined as default.
1247 snmp_v3_use_privpass | **Optional.** Define to use SNMP version 3 priv password. Defaults to false.
1248 snmp_authprotocol | **Optional.** SNMP version 3 authentication protocol. Defaults to "md5,des".
1249 snmp_privpass | **Required.** SNMP version 3 priv password. No value defined as default.
1250 snmp_warn | **Optional.** The warning threshold.
1251 snmp_crit | **Optional.** The critical threshold.
1252 snmp_storage_name | **Optional.** Storage name. Default to regex "^/$$". More options available in the [snmp storage](http://nagios.manubulon.com/snmp_storage.html) documentation.
1253 snmp_perf | **Optional.** Enable perfdata values. Defaults to true.
1254 snmp_timeout | **Optional.** The command timeout in seconds. Defaults to 5 seconds.
1256 ## <a id="plugin-check-command-snmp-interface"></a> snmp-interface
1258 Check command object for the [check_snmp_int.pl](http://nagios.manubulon.com/snmp_int.html) plugin.
1260 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
1263 ----------------------------|--------------
1264 snmp_address | **Optional.** The host's address. Defaults to "$address$" if the host's `address` attribute is set, "$address6$" otherwise.
1265 snmp_nocrypt | **Optional.** Define SNMP encryption. If set **snmp_v3** needs to be set. Defaults to false.
1266 snmp_community | **Optional.** The SNMP community. Defaults to "public".
1267 snmp_port | **Optional.** The SNMP port connection.
1268 snmp_v2 | **Optional.** SNMP version to 2c. Defaults to false.
1269 snmp_v3 | **Optional.** SNMP version to 3. Defaults to false.
1270 snmp_login | **Optional.** SNMP version 3 username. Defaults to "snmpuser".
1271 snmp_password | **Required.** SNMP version 3 password. No value defined as default.
1272 snmp_v3_use_privpass | **Optional.** Define to use SNMP version 3 priv password. Defaults to false.
1273 snmp_authprotocol | **Optional.** SNMP version 3 authentication protocol. Defaults to "md5,des".
1274 snmp_privpass | **Required.** SNMP version 3 priv password. No value defined as default.
1275 snmp_warn | **Optional.** The warning threshold.
1276 snmp_crit | **Optional.** The critical threshold.
1277 snmp_interface | **Optional.** Network interface name. Default to regex "eth0".
1278 snmp_interface_perf | **Optional.** Check the input/ouput bandwidth of the interface. Defaults to true.
1279 snmp_interface_label | **Optional.** Add label before speed in output: in=, out=, errors-out=, etc...
1280 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.
1281 snmp_interface_percent | **Optional.** Output performance data in % of max speed. Defaults to false.
1282 snmp_interface_kbits | **Optional.** Make the warning and critical levels in KBits/s. Defaults to true.
1283 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.
1284 snmp_interface_64bit | **Optional.** Use 64 bits counters instead of the standard counters when checking bandwidth & performance data for interface >= 1Gbps. Defaults to false.
1285 snmp_interface_errors | **Optional.** Add error & discard to Perfparse output. Defaults to true.
1286 snmp_interface_noregexp | **Optional.** Do not use regexp to match interface name in description OID. Defaults to false.
1287 snmp_interface_delta | **Optional.** Delta time of perfcheck. Defaults to "300" (5 min).
1288 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.
1289 snmp_perf | **Optional.** Enable perfdata values. Defaults to true.
1290 snmp_timeout | **Optional.** The command timeout in seconds. Defaults to 5 seconds.
1292 ## <a id="plugin-check-command-snmp-process"></a> snmp-process
1294 Check command object for the [check_snmp_process.pl](http://nagios.manubulon.com/snmp_process.html) plugin.
1296 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
1299 ------------------------|--------------
1300 snmp_address | **Optional.** The host's address. Defaults to "$address$" if the host's `address` attribute is set, "$address6$" otherwise.
1301 snmp_nocrypt | **Optional.** Define SNMP encryption. If set **snmp_v3** needs to be set. Defaults to false.
1302 snmp_community | **Optional.** The SNMP community. Defaults to "public".
1303 snmp_port | **Optional.** The SNMP port connection.
1304 snmp_v2 | **Optional.** SNMP version to 2c. Defaults to false.
1305 snmp_v3 | **Optional.** SNMP version to 3. Defaults to false.
1306 snmp_login | **Optional.** SNMP version 3 username. Defaults to "snmpuser".
1307 snmp_password | **Required.** SNMP version 3 password. No value defined as default.
1308 snmp_v3_use_privpass | **Optional.** Define to use SNMP version 3 priv password. Defaults to false.
1309 snmp_authprotocol | **Optional.** SNMP version 3 authentication protocol. Defaults to "md5,des".
1310 snmp_privpass | **Required.** SNMP version 3 priv password. No value defined as default..
1311 snmp_warn | **Optional.** The warning threshold.
1312 snmp_crit | **Optional.** The critical threshold.
1313 snmp_process_name | **Optional.** Name of the process (regexp). No trailing slash!. Defaults to ".*".
1314 snmp_perf | **Optional.** Enable perfdata values. Defaults to true.
1315 snmp_timeout | **Optional.** The command timeout in seconds. Defaults to 5 seconds.
1317 # <a id="plugins-contrib"></a> Plugins Contrib
1319 The Plugins contrib collects various contributed command definitions.
1321 These check commands assume that the global constant named `PluginContribDir`
1322 is set to the path where the user installs custom plugins and can be enabled by uncommenting the corresponding line in icinga2.conf.
1324 ## <a id="plugins-contrib-databases"></a> Databases
1326 All database plugins go in this category.
1328 ### <a id="plugins-contrib-command-mssql_health"></a> mssql_health
1330 The plugin `mssql_health` utilises Perl DBD::Sybase based on FreeTDS to connect to MSSQL databases for monitoring.
1331 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).
1333 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
1336 ---------------------------------|------------------------------------------------------------------------------------------------------------------------------
1337 mssql_health_hostname | **Optional.** Specifies the database hostname or address. No default because you typically use "mssql_health_server".
1338 mssql_health_port | **Optional.** Specifies the database port. No default because you typically use "mssql_health_server".
1339 mssql_health_server | **Optional.** The name of a predefined connection (in freetds.conf).
1340 mssql_health_currentdb | **Optional.** The name of a database which is used as the current database for the connection.
1341 mssql_health_username | **Optional.** The username for the database connection.
1342 mssql_health_password | **Optional.** The password for the database connection.
1343 mssql_health_warning | **Optional.** The warning threshold depending on the mode.
1344 mssql_health_critical | **Optional.** The critical threshold depending on the mode.
1345 mssql_health_mode | **Required.** The mode uses predefined keywords for the different checks. For example "connection-time", "database-free" or "sql".
1346 mssql_health_name | **Optional.** Depending on the mode this could be the database name or a SQL statement.
1347 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.
1348 mssql_health_regexp | **Optional.** If set to true, "mssql_health_name" will be interpreted as a regular expression. Defaults to false.
1349 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".
1350 mssql_health_offlineok | **Optional.** Set this to true, if offline databases are perfectly ok for you. Defaults to false.
1351 mssql_health_commit | **Optional.** Set this to true to turn on autocommit for the dbd::sybase module. Defaults to false.
1353 ### <a id="plugins-contrib-command-mysql_health"></a> mysql_health
1355 The plugin `mysql_health` utilises Perl DBD::MySQL to connect to MySQL databases for monitoring.
1356 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).
1358 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
1361 ---------------------------------|------------------------------------------------------------------------------------------------------------------------------
1362 mysql_health_hostname | **Required.** Specifies the database hostname or address. Defaults to "$address$" or "$address6$" if the `address` attribute is not set.
1363 mysql_health_port | **Optional.** Specifies the database port. Defaults to 3306 (or 1186 for "mysql_health_mode" cluster).
1364 mysql_health_socket | **Optional.** Specifies the database unix socket. No default.
1365 mysql_health_username | **Optional.** The username for the database connection.
1366 mysql_health_password | **Optional.** The password for the database connection.
1367 mysql_health_database | **Optional.** The database to connect to. Defaults to information_schema.
1368 mysql_health_warning | **Optional.** The warning threshold depending on the mode.
1369 mysql_health_critical | **Optional.** The critical threshold depending on the mode.
1370 mysql_health_mode | **Required.** The mode uses predefined keywords for the different checks. For example "connection-time", "slave-lag" or "sql".
1371 mysql_health_name | **Optional.** The SQL statement to be executed with "mysql_health_mode" sql.
1372 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.
1373 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".
1374 mysql_health_labelformat | **Optional.** One of those formats pnp4nagios or groundwork. Defaults to pnp4nagios.
1376 ### <a id="plugins-contrib-command-oracle_health"></a> oracle_health
1378 The plugin `oracle_health` utilises Perl DBD::Oracle based on oracle-instantclient-sdk or sqlplus to connect to Oracle databases for monitoring.
1379 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).
1381 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
1384 ---------------------------------|------------------------------------------------------------------------------------------------------------------------------
1385 oracle_health_connect | **Required.** Specifies the database connection string (from tnsnames.ora).
1386 oracle_health_username | **Optional.** The username for the database connection.
1387 oracle_health_password | **Optional.** The password for the database connection.
1388 oracle_health_warning | **Optional.** The warning threshold depending on the mode.
1389 oracle_health_critical | **Optional.** The critical threshold depending on the mode.
1390 oracle_health_mode | **Required.** The mode uses predefined keywords for the different checks. For example "connection-time", "flash-recovery-area-usage" or "sql".
1391 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.
1392 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.
1393 oracle_health_regexp | **Optional.** If set to true, "oracle_health_name" will be interpreted as a regular expression. Defaults to false.
1394 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".
1395 oracle_health_ident | **Optional.** If set to true outputs instance and database names. Defaults to false.
1396 oracle_health_commit | **Optional.** Set this to true to turn on autocommit for the dbd::oracle module. Defaults to false.
1397 oracle_health_noperfdata | **Optional.** Set this to true if you want to disable perfdata. Defaults to false.
1402 --------------------|------------------------------------------------------------------------------------------------------------------------------------------
1403 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".
1404 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".
1406 ### <a id="plugins-contrib-command-postgres"></a> postgres
1408 The plugin `postgres` utilises the psql binary to connect to PostgreSQL databases for monitoring.
1409 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).
1411 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
1414 ---------------------------------|------------------------------------------------------------------------------------------------------------------------------
1415 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.
1416 postgres_port | **Optional.** Specifies the database port. Defaults to 5432.
1417 postgres_dbname | **Optional.** Specifies the database name to connect to. Defaults to "postgres" or "template1".
1418 postgres_dbuser | **Optional.** The username for the database connection. Defaults to "postgres".
1419 postgres_dbpass | **Optional.** The password for the database connection. You can use a .pgpass file instead.
1420 postgres_dbservice | **Optional.** Specifies the service name to use inside of pg_service.conf.
1421 postgres_warning | **Optional.** Specifies the warning threshold, range depends on the action.
1422 postgres_critical | **Optional.** Specifies the critical threshold, range depends on the action.
1423 postgres_include | **Optional.** Specifies name(s) items to specifically include (e.g. tables), depends on the action.
1424 postgres_exclude | **Optional.** Specifies name(s) items to specifically exclude (e.g. tables), depends on the action.
1425 postgres_includeuser | **Optional.** Include objects owned by certain users.
1426 postgres_excludeuser | **Optional.** Exclude objects owned by certain users.
1427 postgres_standby | **Optional.** Assume that the server is in continious WAL recovery mode if set to true. Defaults to false.
1428 postgres_production | **Optional.** Assume that the server is in production mode if set to true. Defaults to false.
1429 postgres_action | **Required.** Determines the test executed.
1430 postgres_unixsocket | **Optional.** If "postgres_unixsocket" is set to true the unix socket is used instead of an address. Defaults to false.
1432 ### <a id="plugins-contrib-command-mongodb"></a> mongodb
1434 The plugin `mongodb` utilises Python PyMongo.
1435 For development check [https://github.com](https://github.com/mzupan/nagios-plugin-mongodb).
1437 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
1440 ---------------------------------|------------------------------------------------------------------------------------------------------------------------------
1441 mongodb_host | **Required.** Specifies the hostname or address.
1442 mongodb_port | **Required.** The port mongodb is runnung on.
1443 mongodb_user | **Optional.** The username you want to login as
1444 mongodb_passwd | **Optional.** The password you want to use for that user
1445 mongodb_warning | **Optional.** The warning threshold we want to set
1446 mongodb_critical | **Optional.** The critical threshold we want to set
1447 mongodb_action | **Required.** The action you want to take
1448 mongodb_maxlag | **Optional.** Get max replication lag (for replication_lag action only)
1449 mongodb_mappedmemory | **Optional.** Get mapped memory instead of resident (if resident memory can not be read)
1450 mongodb_perfdata | **Optional.** Enable output of Nagios performance data
1451 mongodb_database | **Optional.** Specify the database to check
1452 mongodb_alldatabases | **Optional.** Check all databases (action database_size)
1453 mongodb_ssl | **Optional.** Connect using SSL
1454 mongodb_replicaset | **Optional.** Connect to replicaset
1455 mongodb_querytype | **Optional.** The query type to check [query|insert|update|delete|getmore|command] from queries_per_second
1456 mongodb_collection | **Optional.** Specify the collection to check
1457 mongodb_sampletime | **Optional.** Time used to sample number of pages faults
1459 ## <a id="plugins-contrib-ipmi"></a> IPMI Devices
1461 This category includes all plugins for IPMI devices.
1463 ### <a id="plugins-contrib-command-ipmi-sensor"></a> ipmi-sensor
1465 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.
1467 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
1470 ---------------------------------|-----------------------------------------------------------------------------------------------------
1471 ipmi_address | **Required.** Specifies the remote host (IPMI device) to check. Defaults to "$address$".
1472 ipmi_config_file | **Optional.** Path to the FreeIPMI configuration file. It should contain IPMI username, IPMI password, and IPMI privilege-level.
1473 ipmi_username | **Optional.** The IPMI username.
1474 ipmi_password | **Optional.** The IPMI password.
1475 ipmi_privilege_level | **Optional.** The IPMI privilege level of the IPMI user.
1476 ipmi_backward_compatibility_mode | **Optional.** Enable backward compatibility mode, useful for FreeIPMI 0.5.* (this omits FreeIPMI options "--quiet-cache" and "--sdr-cache-recreate").
1477 ipmi_sensor_type | **Optional.** Limit sensors to query based on IPMI sensor type. Examples for IPMI sensor types are 'Fan', 'Temperature' and 'Voltage'.
1478 ipmi_exclude_sensor_id | **Optional.** Exclude sensor matching ipmi_sensor_id.
1479 ipmi_sensor_id | **Optional.** Include sensor matching ipmi_sensor_id.
1480 ipmi_protocal_lan_version | **Optional.** Change the protocol LAN version. Defaults to "LAN_2_0".
1481 ipmi_number_of_active_fans | **Optional.** Number of fans that should be active. Otherwise a WARNING state is returned.
1482 ipmi_show_fru | **Optional.** Print the product serial number if it is available in the IPMI FRU data.
1483 ipmi_no_sel_checking | **Optional.** Turn off system event log checking via ipmi-sel.
1485 ## <a id="plugins-contrib-network-components"></a> Network Components
1487 This category includes all plugins for various network components like routers, switches and firewalls.
1489 ### <a id="plugins-contrib-command-interfacetable"></a> interfacetable
1491 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).
1493 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
1496 ------------------------------------|-----------------------------------------------------------------------------------------------------
1497 interfacetable_hostquery | **Required.** Specifies the remote host to poll. Defaults to "$address$".
1498 interfacetable_hostdisplay | **Optional.** Specifies the hostname to display in the HTML link. Defaults to "$host.display_name$".
1499 interfacetable_regex | **Optional.** Interface names and property names for some other options will be interpreted as regular expressions. Defaults to false.
1500 interfacetable_outputshort | **Optional.** Reduce the verbosity of the plugin output. Defaults to false.
1501 interfacetable_exclude | **Optional.** Comma separated list of interfaces globally excluded from the monitoring.
1502 interfacetable_include | **Optional.** Comma separated list of interfaces globally included in the monitoring.
1503 interfacetable_aliasmatching | **Optional.** Allow you to specify alias in addition to interface names. Defaults to false.
1504 interfacetable_excludetraffic | **Optional.** Comma separated list of interfaces excluded from traffic checks.
1505 interfacetable_includetraffic | **Optional.** Comma separated list of interfaces included for traffic checks.
1506 interfacetable_warningtraffic | **Optional.** Interface traffic load percentage leading to a warning alert.
1507 interfacetable_criticaltraffic | **Optional.** Interface traffic load percentage leading to a critical alert.
1508 interfacetable_pkt | **Optional.** Add unicast/non-unicast pkt stats for each interface.
1509 interfacetable_trackproperty | **Optional.** List of tracked properties.
1510 interfacetable_excludeproperty | **Optional.** Comma separated list of interfaces excluded from the property tracking.
1511 interfacetable_includeproperty | **Optional.** Comma separated list of interfaces included in the property tracking.
1512 interfacetable_community | **Optional.** Specifies the snmp v1/v2c community string. Defaults to "public" if using snmp v1/v2c, ignored using v3.
1513 interfacetable_snmpv2 | **Optional.** Use snmp v2c. Defaults to false.
1514 interfacetable_login | **Optional.** Login for snmpv3 authentication.
1515 interfacetable_passwd | **Optional.** Auth password for snmpv3 authentication.
1516 interfacetable_privpass | **Optional.** Priv password for snmpv3 authentication.
1517 interfacetable_protocols | **Optional.** Authentication protocol,Priv protocol for snmpv3 authentication.
1518 interfacetable_domain | **Optional.** SNMP transport domain.
1519 interfacetable_contextname | **Optional.** Context name for the snmp requests.
1520 interfacetable_port | **Optional.** SNMP port. Defaults to standard port.
1521 interfacetable_64bits | **Optional.** Use SNMP 64-bits counters. Defaults to false.
1522 interfacetable_maxrepetitions | **Optional.** Increasing this value may enhance snmp query performances by gathering more results at one time.
1523 interfacetable_snmptimeout | **Optional.** Define the Transport Layer timeout for the snmp queries.
1524 interfacetable_snmpretries | **Optional.** Define the number of times to retry sending a SNMP message.
1525 interfacetable_unixsnmp | **Optional.** Use unix snmp utilities for snmp requests. Defaults to false, which means use the perl bindings.
1526 interfacetable_enableperfdata | **Optional.** Enable port performance data. Defaults to false.
1527 interfacetable_perfdataformat | **Optional.** Define which performance data will be generated. Possible values are "full" (default), "loadonly", "globalonly".
1528 interfacetable_perfdatathreshold | **Optional.** Define which thresholds are printed in the generated performance data. Possible values are "full" (default), "loadonly", "globalonly".
1529 interfacetable_perfdatadir | **Optional.** When specified, the performance data are also written directly to a file, in the specified location.
1530 interfacetable_perfdataservicedesc | **Optional.** Specify additional parameters for output performance data to PNP. Defaults to "$service.name$", only affects **interfacetable_perfdatadir**.
1531 interfacetable_grapher | **Optional.** Specify the used graphing solution. Possible values are "pnp4nagios" (default), "nagiosgrapher", "netwaysgrapherv2" and "ingraph".
1532 interfacetable_grapherurl | **Optional.** Graphing system url. Default depends on **interfacetable_grapher**.
1533 interfacetable_portperfunit | **Optional.** Traffic could be reported in bits (counters) or in bps (calculated value).
1534 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".
1535 interfacetable_duplex | **Optional.** Add the duplex mode property for each interface in the interface table. Defaults to false.
1536 interfacetable_stp | **Optional.** Add the stp state property for each interface in the interface table. Defaults to false.
1537 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"
1538 interfacetable_noipinfo | **Optional.** Remove the ip information for each interface from the interface table. Defaults to false.
1539 interfacetable_alias | **Optional.** Add the alias information for each interface in the interface table. Defaults to false.
1540 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.
1541 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.
1542 interfacetable_delta | **Optional.** Set the delta used for interface throuput calculation in seconds.
1543 interfacetable_ifs | **Optional.** Input field separator. Defaults to ",".
1544 interfacetable_cache | **Optional.** Define the retention time of the cached data in seconds.
1545 interfacetable_noifloadgradient | **Optional.** Disable color gradient from green over yellow to red for the load percentage. Defaults to false.
1546 interfacetable_nohuman | **Optional.** Do not translate bandwidth usage in human readable format. Defaults to false.
1547 interfacetable_snapshot | **Optional.** Force the plugin to run like if it was the first launch. Defaults to false.
1548 interfacetable_timeout | **Optional.** Define the global timeout limit of the plugin in seconds. Defaults to "15s".
1549 interfacetable_css | **Optional.** Define the css stylesheet used by the generated html files. Possible values are "classic", "icinga", "icinga-alternate1" or "nagiosxi".
1550 interfacetable_config | **Optional.** Specify a config file to load.
1551 interfacetable_noconfigtable | **Optional.** Disable configuration table on the generated HTML page. Defaults to false.
1552 interfacetable_notips | **Optional.** Disable the tips in the generated html tables. Defaults to false.
1553 interfacetable_defaulttablesorting | **Optional.** Default table sorting can be "index" (default) or "name".
1554 interfacetable_tablesplit | **Optional.** Generate multiple interface tables, one per interface type. Defaults to false.
1555 interfacetable_notype | **Optional.** Remove the interface type for each interface. Defaults to false.
1557 ### <a id="plugins-contrib-command-iftraffic"></a> iftraffic
1559 The plugin [check_iftraffic](https://exchange.icinga.org/exchange/iftraffic)
1560 checks the utilization of a given interface name using the SNMP protocol.
1562 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
1565 ------------------------|---------------------------------------------------------
1566 iftraffic_address | **Required.** Specifies the remote host. Defaults to "$address$".
1567 iftraffic_community | **Optional.** SNMP community. Defaults to "public'" if omitted.
1568 iftraffic_interface | **Required.** Queried interface name.
1569 iftraffic_bandwidth | **Required.** Interface maximum speed in kilo/mega/giga/bits per second.
1570 iftraffic_units | **Optional.** Interface units can be one of these values: `g` (gigabits/s),`m` (megabits/s), `k` (kilobits/s),`b` (bits/s)
1571 iftraffic_warn | **Optional.** Percent of bandwidth usage necessary to result in warning status (defaults to `85%`).
1572 iftraffic_crit | **Optional.** Percent of bandwidth usage necessary to result in critical status (defaults to `98%`).
1573 iftraffic_max_counter | **Optional.** Maximum counter value of net devices in kilo/mega/giga/bytes.
1575 ## <a id="plugins-contrib-web"></a> Web
1577 This category includes all plugins for web-based checks.
1579 ## <a id="plugin-check-command-webinject"></a> webinject
1581 Check command object for the [check_webinject](http://http://www.webinject.org/manual.html) plugin.
1583 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
1586 ------------------------|--------------
1587 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.
1588 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.
1589 webinject_no_output | **Optional.** Suppresses all output to STDOUT except the results summary.
1590 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.
1591 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.
1592 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.
1594 ## <a id="plugins-contrib-operating-system"></a> Operating System
1596 In this category you can find plugins for gathering information about your operating system or the system beneath like memory usage.
1598 ### <a id="plugins-contrib-command-mem"></a> mem
1600 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).
1602 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
1605 -------------|-----------------------------------------------------------------------------------------------------------------------
1606 mem_used | **Optional.** Tell the plugin to check for used memory in opposite of **mem_free**. Must specify one of these as true.
1607 mem_free | **Optional.** Tell the plugin to check for free memory in opposite of **mem_used**. Must specify one of these as true.
1608 mem_cache | **Optional.** If set to true plugin will count cache as free memory. Defaults to false.
1609 mem_warning | **Required.** Specifiy the warning threshold as number interpreted as percent.
1610 mem_critical | **Required.** Specifiy the critical threshold as number interpreted as percent.
1612 ## <a id="plugin-contrib-command-running-kernel"></a> running_kernel
1614 Check command object for the `check_running_kernel` plugin
1615 provided by the `nagios-plugins-contrib` package on Debian.
1617 The `running_kernel` check command does not support any vars.
1620 ## <a id="plugins-contrib-virtualization"></a> Virtualization
1622 This category includes all plugins for various virtualization technologies.
1624 ### <a id="plugins-contrib-command-esxi-hardware"></a> esxi_hardware
1626 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.
1628 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
1631 ------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
1632 esxi_hardware_host | **Required.** Specifies the host to monitor. Defaults to "$address$".
1633 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.
1634 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.
1635 esxi_hardware_vendor | **Optional.** Defines the vendor of the server: "auto", "dell", "hp", "ibm", "intel", "unknown" (default).
1636 esxi_hardware_html | **Optional.** Add web-links to hardware manuals for Dell servers (use your country extension). Only useful with **esxi_hardware_vendor** = dell.
1637 esxi_hardware_ignore | **Optional.** Comma separated list of elements to ignore.
1638 esxi_hardware_perfdata | **Optional.** Add performcedata for graphers like PNP4Nagios to the output. Defaults to false.
1639 esxi_hardware_nopower | **Optional.** Do not collect power performance data, when **esxi_hardware_perfdata** is set to true. Defaults to false.
1640 esxi_hardware_novolts | **Optional.** Do not collect voltage performance data, when **esxi_hardware_perfdata** is set to true. Defaults to false.
1641 esxi_hardware_nocurrent | **Optional.** Do not collect current performance data, when **esxi_hardware_perfdata** is set to true. Defaults to false.
1642 esxi_hardware_notemp | **Optional.** Do not collect temperature performance data, when **esxi_hardware_perfdata** is set to true. Defaults to false.
1643 esxi_hardware_nofan | **Optional.** Do not collect fan performance data, when **esxi_hardware_perfdata** is set to true. Defaults to false.
1645 # <a id="plugins-contrib-vmware"></a> VMware
1647 Check commands for the [check_vmware_esx](https://github.com/BaldMansMojo/check_vmware_esx) plugin.
1649 ## <a id="plugins-contrib-vmware-esx-dc-volumes"></a> vmware-esx-dc-volumes
1651 Check command object for the `check_vmware_esx` plugin. Shows all datastore volumes info.
1653 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
1656 ------------------------|--------------
1657 vmware_datacenter | **Required.** Datacenter/vCenter hostname.
1658 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
1659 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
1660 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
1661 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
1662 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
1663 vmware_sessionfile | **Optional.** Session file name enhancement.
1664 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
1665 vmware_nosession | **Optional.** No auth session - IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
1666 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
1667 vmware_password | **Optional.** The username's password. No value defined as default.
1668 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
1669 vmware_subselect | **Optional.** Volume name to be checked the free space.
1670 vmware_gigabyte | **Optional.** Output in GB instead of MB.
1671 vmware_usedspace | **Optional.** Output used space instead of free. Defaults to "false".
1672 vmware_alertonly | **Optional.** List only alerting volumes. Defaults to "false".
1673 vmware_exclude | **Optional.** Blacklist volumes name. No value defined as default.
1674 vmware_include | **Optional.** Whitelist volumes name. No value defined as default.
1675 vmware_isregexp | **Optional.** Treat blacklist and whitelist expressions as regexp.
1676 vmware_dc_volume_used | **Optional.** Output used space instead of free. Defaults to "true".
1677 vmware_warn | **Optional.** The warning threshold for volumes. Defaults to "80%".
1678 vmware_crit | **Optional.** The critical threshold for volumes. Defaults to "90%".
1681 ## <a id="plugins-contrib-vmware-esx-dc-runtime-info"></a> vmware-esx-dc-runtime-info
1683 Check command object for the `check_vmware_esx` plugin. Shows all runtime info for the datacenter/Vcenter.
1685 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
1688 ------------------------|--------------
1689 vmware_datacenter | **Required.** Datacenter/vCenter hostname.
1690 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
1691 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
1692 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
1693 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
1694 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
1695 vmware_sessionfile | **Optional.** Session file name enhancement.
1696 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
1697 vmware_nosession | **Optional.** No auth session - IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
1698 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
1699 vmware_password | **Optional.** The username's password. No value defined as default.
1700 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
1703 ## <a id="plugins-contrib-vmware-esx-dc-runtime-listvms"></a> vmware-esx-dc-runtime-listvms
1705 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.
1707 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
1710 ------------------------|--------------
1711 vmware_datacenter | **Required.** Datacenter/vCenter hostname.
1712 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
1713 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
1714 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
1715 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
1716 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
1717 vmware_sessionfile | **Optional.** Session file name enhancement.
1718 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
1719 vmware_nosession | **Optional.** No auth session - IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
1720 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
1721 vmware_password | **Optional.** The username's password. No value defined as default.
1722 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
1723 vmware_alertonly | **Optional.** List only alerting VMs. Important here to avoid masses of data.
1724 vmware_exclude | **Optional.** Blacklist VMs name. No value defined as default.
1725 vmware_include | **Optional.** Whitelist VMs name. No value defined as default.
1726 vmware_isregexp | **Optional.** Treat blacklist and whitelist expressions as regexp.
1727 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.
1730 ## <a id="plugins-contrib-vmware-esx-dc-runtime-listhost"></a> vmware-esx-dc-runtime-listhost
1732 Check command object for the `check_vmware_esx` plugin. List of VMware ESX hosts and their power state.
1734 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
1737 ------------------------|--------------
1738 vmware_datacenter | **Required.** Datacenter/vCenter hostname.
1739 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
1740 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
1741 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
1742 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
1743 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
1744 vmware_sessionfile | **Optional.** Session file name enhancement.
1745 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
1746 vmware_nosession | **Optional.** No auth session - IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
1747 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
1748 vmware_password | **Optional.** The username's password. No value defined as default.
1749 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
1750 vmware_alertonly | **Optional.** List only alerting hosts. Important here to avoid masses of data.
1751 vmware_exclude | **Optional.** Blacklist VMware ESX hosts. No value defined as default.
1752 vmware_include | **Optional.** Whitelist VMware ESX hosts. No value defined as default.
1753 vmware_isregexp | **Optional.** Treat blacklist and whitelist expressions as regexp.
1754 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.
1757 ## <a id="plugins-contrib-vmware-esx-dc-runtime-listcluster"></a> vmware-esx-dc-runtime-listcluster
1759 Check command object for the `check_vmware_esx` plugin. List of VMware clusters and their states.
1761 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
1764 ------------------------|--------------
1765 vmware_datacenter | **Required.** Datacenter/vCenter hostname.
1766 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
1767 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
1768 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
1769 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
1770 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
1771 vmware_sessionfile | **Optional.** Session file name enhancement.
1772 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
1773 vmware_nosession | **Optional.** No auth session - IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
1774 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
1775 vmware_password | **Optional.** The username's password. No value defined as default.
1776 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
1777 vmware_alertonly | **Optional.** List only alerting hosts. Important here to avoid masses of data.
1778 vmware_exclude | **Optional.** Blacklist VMware cluster. No value defined as default.
1779 vmware_include | **Optional.** Whitelist VMware cluster. No value defined as default.
1780 vmware_isregexp | **Optional.** Treat blacklist and whitelist expressions as regexp.
1781 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.
1784 ## <a id="plugins-contrib-vmware-esx-dc-runtime-issues"></a> vmware-esx-dc-runtime-issues
1786 Check command object for the `check_vmware_esx` plugin. All issues for the host.
1788 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
1791 ------------------------|--------------
1792 vmware_datacenter | **Required.** Datacenter/vCenter hostname.
1793 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
1794 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
1795 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
1796 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
1797 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
1798 vmware_sessionfile | **Optional.** Session file name enhancement.
1799 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
1800 vmware_nosession | **Optional.** No auth session - IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
1801 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
1802 vmware_password | **Optional.** The username's password. No value defined as default.
1803 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
1804 vmware_exclude | **Optional.** Blacklist issues. No value defined as default.
1805 vmware_include | **Optional.** Whitelist issues. No value defined as default.
1806 vmware_isregexp | **Optional.** Treat blacklist and whitelist expressions as regexp.
1807 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.
1810 ## <a id="plugins-contrib-vmware-esx-dc-runtime-status"></a> vmware-esx-dc-runtime-status
1812 Check command object for the `check_vmware_esx` plugin. Overall object status (gray/green/red/yellow).
1814 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
1817 ------------------------|--------------
1818 vmware_datacenter | **Required.** Datacenter/vCenter hostname.
1819 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
1820 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
1821 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
1822 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
1823 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
1824 vmware_sessionfile | **Optional.** Session file name enhancement.
1825 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
1826 vmware_nosession | **Optional.** No auth session - IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
1827 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
1828 vmware_password | **Optional.** The username's password. No value defined as default.
1829 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
1832 ## <a id="plugins-contrib-vmware-esx-dc-runtime-tools"></a> vmware-esx-dc-runtime-tools
1834 Check command object for the `check_vmware_esx` plugin. Vmware Tools status.
1836 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
1839 ------------------------|--------------
1840 vmware_datacenter | **Required.** Datacenter/vCenter hostname.
1841 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
1842 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
1843 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
1844 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
1845 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
1846 vmware_sessionfile | **Optional.** Session file name enhancement.
1847 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
1848 vmware_nosession | **Optional.** No auth session - IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
1849 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
1850 vmware_password | **Optional.** The username's password. No value defined as default.
1851 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
1852 vmware_poweredonly | **Optional.** List only VMs which are powered on. No value defined as default.
1853 vmware_alertonly | **Optional.** List only alerting VMs. Important here to avoid masses of data.
1854 vmware_exclude | **Optional.** Blacklist VMs. No value defined as default.
1855 vmware_include | **Optional.** Whitelist VMs. No value defined as default.
1856 vmware_isregexp | **Optional.** Treat blacklist and whitelist expressions as regexp.
1857 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.
1860 ## <a id="plugins-contrib-vmware-esx-soap-host-check"></a> vmware-esx-soap-host-check
1862 Check command object for the `check_vmware_esx` plugin. Simple check to verify a successfull connection to VMware SOAP API.
1864 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
1867 ------------------------|--------------
1868 vmware_host | **Required.** ESX or ESXi hostname.
1869 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
1870 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
1871 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
1872 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
1873 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
1874 vmware_sessionfile | **Optional.** Session file name enhancement.
1875 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
1876 vmware_nosession | **Optional.** No auth session - IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
1877 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
1878 vmware_password | **Optional.** The username's password. No value defined as default.
1879 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
1882 ## <a id="plugins-contrib-vmware-esx-soap-host-uptime"></a> vmware-esx-soap-host-uptime
1884 Check command object for the `check_vmware_esx` plugin. Displays uptime of the VMware host.
1886 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
1889 ------------------------|--------------
1890 vmware_host | **Required.** ESX or ESXi hostname.
1891 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
1892 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
1893 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
1894 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
1895 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
1896 vmware_sessionfile | **Optional.** Session file name enhancement.
1897 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
1898 vmware_nosession | **Optional.** No auth session - IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
1899 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
1900 vmware_password | **Optional.** The username's password. No value defined as default.
1901 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
1904 ## <a id="plugins-contrib-vmware-esx-soap-host-cpu"></a> vmware-esx-soap-host-cpu
1906 Check command object for the `check_vmware_esx` plugin. CPU usage in percentage.
1908 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
1911 ------------------------|--------------
1912 vmware_host | **Required.** ESX or ESXi hostname.
1913 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
1914 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
1915 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
1916 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
1917 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
1918 vmware_sessionfile | **Optional.** Session file name enhancement.
1919 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
1920 vmware_nosession | **Optional.** No auth session - IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
1921 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
1922 vmware_password | **Optional.** The username's password. No value defined as default.
1923 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
1924 vmware_warn | **Optional.** The warning threshold in percent. Defaults to "80%".
1925 vmware_crit | **Optional.** The critical threshold in percent. Defaults to "90%".
1928 ## <a id="plugins-contrib-vmware-esx-soap-host-cpu-ready"></a> vmware-esx-soap-host-cpu-ready
1930 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.
1932 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
1935 ------------------------|--------------
1936 vmware_host | **Required.** ESX or ESXi hostname.
1937 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
1938 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
1939 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
1940 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
1941 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
1942 vmware_sessionfile | **Optional.** Session file name enhancement.
1943 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
1944 vmware_nosession | **Optional.** No auth session - IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
1945 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
1946 vmware_password | **Optional.** The username's password. No value defined as default.
1947 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
1950 ## <a id="plugins-contrib-vmware-esx-soap-host-cpu-wait"></a> vmware-esx-soap-host-cpu-wait
1952 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.
1954 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
1957 ------------------------|--------------
1958 vmware_host | **Required.** ESX or ESXi hostname.
1959 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
1960 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
1961 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
1962 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
1963 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
1964 vmware_sessionfile | **Optional.** Session file name enhancement.
1965 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
1966 vmware_nosession | **Optional.** No auth session - IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
1967 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
1968 vmware_password | **Optional.** The username's password. No value defined as default.
1969 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
1972 ## <a id="plugins-contrib-vmware-esx-soap-host-cpu-usage"></a> vmware-esx-soap-host-cpu-usage
1974 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.
1976 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
1979 ------------------------|--------------
1980 vmware_host | **Required.** ESX or ESXi hostname.
1981 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
1982 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
1983 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
1984 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
1985 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
1986 vmware_sessionfile | **Optional.** Session file name enhancement.
1987 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
1988 vmware_nosession | **Optional.** No auth session - IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
1989 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
1990 vmware_password | **Optional.** The username's password. No value defined as default.
1991 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
1992 vmware_warn | **Optional.** The warning threshold in percent. Defaults to "80%".
1993 vmware_crit | **Optional.** The critical threshold in percent. Defaults to "90%".
1996 ## <a id="plugins-contrib-vmware-esx-soap-host-mem"></a> vmware-esx-soap-host-mem
1998 Check command object for the `check_vmware_esx` plugin. All mem info(except overall and no thresholds).
2000 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
2003 ------------------------|--------------
2004 vmware_host | **Required.** ESX or ESXi hostname.
2005 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
2006 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
2007 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
2008 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
2009 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
2010 vmware_sessionfile | **Optional.** Session file name enhancement.
2011 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
2012 vmware_nosession | **Optional.** No auth session - IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
2013 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
2014 vmware_password | **Optional.** The username's password. No value defined as default.
2015 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
2018 ## <a id="plugins-contrib-vmware-esx-soap-host-mem-usage"></a> vmware-esx-soap-host-mem-usage
2020 Check command object for the `check_vmware_esx` plugin. Average mem usage in percentage.
2022 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
2025 ------------------------|--------------
2026 vmware_host | **Required.** ESX or ESXi hostname.
2027 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
2028 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
2029 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
2030 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
2031 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
2032 vmware_sessionfile | **Optional.** Session file name enhancement.
2033 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
2034 vmware_nosession | **Optional.** No auth session - IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
2035 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
2036 vmware_password | **Optional.** The username's password. No value defined as default.
2037 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
2038 vmware_warn | **Optional.** The warning threshold in percent. Defaults to "80%".
2039 vmware_crit | **Optional.** The critical threshold in percent. Defaults to "90%".
2042 ## <a id="plugins-contrib-vmware-esx-soap-host-mem-consumed"></a> vmware-esx-soap-host-mem-consumed
2044 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.
2046 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
2049 ------------------------|--------------
2050 vmware_host | **Required.** ESX or ESXi hostname.
2051 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
2052 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
2053 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
2054 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
2055 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
2056 vmware_sessionfile | **Optional.** Session file name enhancement.
2057 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
2058 vmware_nosession | **Optional.** No auth session - IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
2059 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
2060 vmware_password | **Optional.** The username's password. No value defined as default.
2061 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
2062 vmware_warn | **Optional.** The warning threshold in percent. No value defined as default.
2063 vmware_crit | **Optional.** The critical threshold in percent. No value defined as default.
2066 ## <a id="plugins-contrib-vmware-esx-soap-host-mem-swapused"></a> vmware-esx-soap-host-mem-swapused
2068 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.
2070 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
2073 ------------------------|--------------
2074 vmware_host | **Required.** ESX or ESXi hostname.
2075 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
2076 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
2077 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
2078 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
2079 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
2080 vmware_sessionfile | **Optional.** Session file name enhancement.
2081 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
2082 vmware_nosession | **Optional.** No auth session - IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
2083 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
2084 vmware_password | **Optional.** The username's password. No value defined as default.
2085 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
2086 vmware_warn | **Optional.** The warning threshold in percent. No value defined as default.
2087 vmware_crit | **Optional.** The critical threshold in percent. No value defined as default.
2088 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.
2091 ## <a id="plugins-contrib-vmware-esx-soap-host-mem-overhead"></a> vmware-esx-soap-host-mem-overhead
2093 Check command object for the `check_vmware_esx` plugin. Additional mem used by VM Server in MB.
2095 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
2098 ------------------------|--------------
2099 vmware_host | **Required.** ESX or ESXi hostname.
2100 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
2101 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
2102 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
2103 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
2104 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
2105 vmware_sessionfile | **Optional.** Session file name enhancement.
2106 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
2107 vmware_nosession | **Optional.** No auth session - IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
2108 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
2109 vmware_password | **Optional.** The username's password. No value defined as default.
2110 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
2111 vmware_warn | **Optional.** The warning threshold in percent. No value defined as default.
2112 vmware_crit | **Optional.** The critical threshold in percent. No value defined as default.
2115 ## <a id="plugins-contrib-vmware-esx-soap-host-mem-memctl"></a> vmware-esx-soap-host-mem-memctl
2117 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.
2119 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
2122 ------------------------|--------------
2123 vmware_host | **Required.** ESX or ESXi hostname.
2124 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
2125 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
2126 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
2127 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
2128 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
2129 vmware_sessionfile | **Optional.** Session file name enhancement.
2130 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
2131 vmware_nosession | **Optional.** No auth session - IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
2132 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
2133 vmware_password | **Optional.** The username's password. No value defined as default.
2134 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
2135 vmware_warn | **Optional.** The warning threshold in percent. No value defined as default.
2136 vmware_crit | **Optional.** The critical threshold in percent. No value defined as default.
2137 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.
2140 ## <a id="plugins-contrib-vmware-esx-soap-host-net"></a> vmware-esx-soap-host-net
2142 Check command object for the `check_vmware_esx` plugin. Shows net info.
2144 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
2147 ------------------------|--------------
2148 vmware_host | **Required.** ESX or ESXi hostname.
2149 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
2150 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
2151 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
2152 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
2153 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
2154 vmware_sessionfile | **Optional.** Session file name enhancement.
2155 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
2156 vmware_nosession | **Optional.** No auth session - IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
2157 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
2158 vmware_password | **Optional.** The username's password. No value defined as default.
2159 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
2160 vmware_exclude | **Optional.** Blacklist NICs. No value defined as default.
2161 vmware_isregexp | **Optional.** Treat blacklist expression as regexp.
2164 ## <a id="plugins-contrib-vmware-esx-soap-host-net-usage"></a> vmware-esx-soap-host-net-usage
2166 Check command object for the `check_vmware_esx` plugin. Overall network usage in KBps(Kilobytes per Second).
2168 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
2171 ------------------------|--------------
2172 vmware_host | **Required.** ESX or ESXi hostname.
2173 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
2174 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
2175 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
2176 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
2177 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
2178 vmware_sessionfile | **Optional.** Session file name enhancement.
2179 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
2180 vmware_nosession | **Optional.** No auth session - IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
2181 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
2182 vmware_password | **Optional.** The username's password. No value defined as default.
2183 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
2184 vmware_warn | **Optional.** The warning threshold in KBps(Kilobytes per Second). No value defined as default.
2185 vmware_crit | **Optional.** The critical threshold in KBps(Kilobytes per Second). No value defined as default.
2188 ## <a id="plugins-contrib-vmware-esx-soap-host-net-receive"></a> vmware-esx-soap-host-net-receive
2190 Check command object for the `check_vmware_esx` plugin. Data receive in KBps(Kilobytes per Second).
2192 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
2195 ------------------------|--------------
2196 vmware_host | **Required.** ESX or ESXi hostname.
2197 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
2198 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
2199 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
2200 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
2201 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
2202 vmware_sessionfile | **Optional.** Session file name enhancement.
2203 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
2204 vmware_nosession | **Optional.** No auth session - IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
2205 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
2206 vmware_password | **Optional.** The username's password. No value defined as default.
2207 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
2208 vmware_warn | **Optional.** The warning threshold in KBps(Kilobytes per Second). No value defined as default.
2209 vmware_crit | **Optional.** The critical threshold in KBps(Kilobytes per Second). No value defined as default.
2212 ## <a id="plugins-contrib-vmware-esx-soap-host-net-send"></a> vmware-esx-soap-host-net-send
2214 Check command object for the `check_vmware_esx` plugin. Data send in KBps(Kilobytes per Second).
2216 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
2219 ------------------------|--------------
2220 vmware_host | **Required.** ESX or ESXi hostname.
2221 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
2222 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
2223 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
2224 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
2225 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
2226 vmware_sessionfile | **Optional.** Session file name enhancement.
2227 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
2228 vmware_nosession | **Optional.** No auth session - IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
2229 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
2230 vmware_password | **Optional.** The username's password. No value defined as default.
2231 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
2232 vmware_warn | **Optional.** The warning threshold in KBps(Kilobytes per Second). No value defined as default.
2233 vmware_crit | **Optional.** The critical threshold in KBps(Kilobytes per Second). No value defined as default.
2236 ## <a id="plugins-contrib-vmware-esx-soap-host-net-nic"></a> vmware-esx-soap-host-net-nic
2238 Check command object for the `check_vmware_esx` plugin. Check all active NICs.
2240 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
2243 ------------------------|--------------
2244 vmware_host | **Required.** ESX or ESXi hostname.
2245 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
2246 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
2247 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
2248 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
2249 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
2250 vmware_sessionfile | **Optional.** Session file name enhancement.
2251 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
2252 vmware_nosession | **Optional.** No auth session - IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
2253 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
2254 vmware_password | **Optional.** The username's password. No value defined as default.
2255 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
2256 vmware_exclude | **Optional.** Blacklist NICs. No value defined as default.
2257 vmware_isregexp | **Optional.** Treat blacklist expression as regexp.
2260 ## <a id="plugins-contrib-vmware-esx-soap-host-volumes"></a> vmware-esx-soap-host-volumes
2262 Check command object for the `check_vmware_esx` plugin. Shows all datastore volumes info.
2264 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
2267 ------------------------|--------------
2268 vmware_host | **Required.** ESX or ESXi hostname.
2269 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
2270 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
2271 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
2272 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
2273 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
2274 vmware_sessionfile | **Optional.** Session file name enhancement.
2275 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
2276 vmware_nosession | **Optional.** No auth session - IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
2277 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
2278 vmware_password | **Optional.** The username's password. No value defined as default.
2279 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
2280 vmware_subselect | **Optional.** Volume name to be checked the free space.
2281 vmware_gigabyte | **Optional.** Output in GB instead of MB.
2282 vmware_usedspace | **Optional.** Output used space instead of free. Defaults to "false".
2283 vmware_alertonly | **Optional.** List only alerting volumes. Defaults to "false".
2284 vmware_exclude | **Optional.** Blacklist volumes name. No value defined as default.
2285 vmware_include | **Optional.** Whitelist volumes name. No value defined as default.
2286 vmware_isregexp | **Optional.** Treat blacklist and whitelist expressions as regexp.
2287 vmware_warn | **Optional.** The warning threshold for volumes. Defaults to "80%".
2288 vmware_crit | **Optional.** The critical threshold for volumes. Defaults to "90%".
2289 vmware_spaceleft | **Optional.** This has to be used in conjunction with thresholds as mentioned above.
2292 ## <a id="plugins-contrib-vmware-esx-soap-host-io"></a> vmware-esx-soap-host-io
2294 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.
2296 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
2299 ------------------------|--------------
2300 vmware_host | **Required.** ESX or ESXi hostname.
2301 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
2302 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
2303 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
2304 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
2305 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
2306 vmware_sessionfile | **Optional.** Session file name enhancement.
2307 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
2308 vmware_nosession | **Optional.** No auth session - IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
2309 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
2310 vmware_password | **Optional.** The username's password. No value defined as default.
2311 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
2314 ## <a id="plugins-contrib-vmware-esx-soap-host-io-aborted"></a> vmware-esx-soap-host-io-aborted
2316 Check command object for the `check_vmware_esx` plugin. Number of aborted SCSI commands.
2318 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
2321 ------------------------|--------------
2322 vmware_host | **Required.** ESX or ESXi hostname.
2323 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
2324 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
2325 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
2326 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
2327 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
2328 vmware_sessionfile | **Optional.** Session file name enhancement.
2329 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
2330 vmware_nosession | **Optional.** No auth session - IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
2331 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
2332 vmware_password | **Optional.** The username's password. No value defined as default.
2333 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
2334 vmware_warn | **Optional.** The warning threshold. No value defined as default.
2335 vmware_crit | **Optional.** The critical threshold. No value defined as default.
2338 ## <a id="plugins-contrib-vmware-esx-soap-host-io-resets"></a> vmware-esx-soap-host-io-resets
2340 Check command object for the `check_vmware_esx` plugin. Number of SCSI bus resets.
2342 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
2345 ------------------------|--------------
2346 vmware_host | **Required.** ESX or ESXi hostname.
2347 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
2348 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
2349 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
2350 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
2351 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
2352 vmware_sessionfile | **Optional.** Session file name enhancement.
2353 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
2354 vmware_nosession | **Optional.** No auth session - IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
2355 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
2356 vmware_password | **Optional.** The username's password. No value defined as default.
2357 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
2358 vmware_warn | **Optional.** The warning threshold. No value defined as default.
2359 vmware_crit | **Optional.** The critical threshold. No value defined as default.
2362 ## <a id="plugins-contrib-vmware-esx-soap-host-io-read"></a> vmware-esx-soap-host-io-read
2364 Check command object for the `check_vmware_esx` plugin. Average number of kilobytes read from the disk each second.
2366 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
2369 ------------------------|--------------
2370 vmware_host | **Required.** ESX or ESXi hostname.
2371 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
2372 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
2373 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
2374 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
2375 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
2376 vmware_sessionfile | **Optional.** Session file name enhancement.
2377 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
2378 vmware_nosession | **Optional.** No auth session - IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
2379 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
2380 vmware_password | **Optional.** The username's password. No value defined as default.
2381 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
2382 vmware_warn | **Optional.** The warning threshold. No value defined as default.
2383 vmware_crit | **Optional.** The critical threshold. No value defined as default.
2386 ## <a id="plugins-contrib-vmware-esx-soap-host-io-read-latency"></a> vmware-esx-soap-host-io-read-latency
2388 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.
2390 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
2393 ------------------------|--------------
2394 vmware_host | **Required.** ESX or ESXi hostname.
2395 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
2396 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
2397 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
2398 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
2399 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
2400 vmware_sessionfile | **Optional.** Session file name enhancement.
2401 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
2402 vmware_nosession | **Optional.** No auth session - IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
2403 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
2404 vmware_password | **Optional.** The username's password. No value defined as default.
2405 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
2406 vmware_warn | **Optional.** The warning threshold. No value defined as default.
2407 vmware_crit | **Optional.** The critical threshold. No value defined as default.
2410 ## <a id="plugins-contrib-vmware-esx-soap-host-io-write"></a> vmware-esx-soap-host-io-write
2412 Check command object for the `check_vmware_esx` plugin. Average number of kilobytes written to disk each second.
2414 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
2417 ------------------------|--------------
2418 vmware_host | **Required.** ESX or ESXi hostname.
2419 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
2420 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
2421 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
2422 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
2423 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
2424 vmware_sessionfile | **Optional.** Session file name enhancement.
2425 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
2426 vmware_nosession | **Optional.** No auth session - IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
2427 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
2428 vmware_password | **Optional.** The username's password. No value defined as default.
2429 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
2430 vmware_warn | **Optional.** The warning threshold. No value defined as default.
2431 vmware_crit | **Optional.** The critical threshold. No value defined as default.
2434 ## <a id="plugins-contrib-vmware-esx-soap-host-io-write-latency"></a> vmware-esx-soap-host-io-write-latency
2436 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.
2438 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
2441 ------------------------|--------------
2442 vmware_host | **Required.** ESX or ESXi hostname.
2443 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
2444 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
2445 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
2446 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
2447 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
2448 vmware_sessionfile | **Optional.** Session file name enhancement.
2449 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
2450 vmware_nosession | **Optional.** No auth session - IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
2451 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
2452 vmware_password | **Optional.** The username's password. No value defined as default.
2453 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
2454 vmware_warn | **Optional.** The warning threshold. No value defined as default.
2455 vmware_crit | **Optional.** The critical threshold. No value defined as default.
2458 ## <a id="plugins-contrib-vmware-esx-soap-host-io-usage"></a> vmware-esx-soap-host-io-usage
2460 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.
2462 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
2465 ------------------------|--------------
2466 vmware_host | **Required.** ESX or ESXi hostname.
2467 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
2468 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
2469 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
2470 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
2471 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
2472 vmware_sessionfile | **Optional.** Session file name enhancement.
2473 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
2474 vmware_nosession | **Optional.** No auth session - IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
2475 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
2476 vmware_password | **Optional.** The username's password. No value defined as default.
2477 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
2478 vmware_warn | **Optional.** The warning threshold. No value defined as default.
2479 vmware_crit | **Optional.** The critical threshold. No value defined as default.
2482 ## <a id="plugins-contrib-vmware-esx-soap-host-io-kernel-latency"></a> vmware-esx-soap-host-io-kernel-latency
2484 Check command object for the `check_vmware_esx` plugin. Average amount of time (ms) spent by VMkernel processing each SCSI command.
2486 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
2489 ------------------------|--------------
2490 vmware_host | **Required.** ESX or ESXi hostname.
2491 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
2492 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
2493 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
2494 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
2495 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
2496 vmware_sessionfile | **Optional.** Session file name enhancement.
2497 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
2498 vmware_nosession | **Optional.** No auth session - IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
2499 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
2500 vmware_password | **Optional.** The username's password. No value defined as default.
2501 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
2502 vmware_warn | **Optional.** The warning threshold. No value defined as default.
2503 vmware_crit | **Optional.** The critical threshold. No value defined as default.
2506 ## <a id="plugins-contrib-vmware-esx-soap-host-io-device-latency"></a> vmware-esx-soap-host-io-device-latency
2508 Check command object for the `check_vmware_esx` plugin. Average amount of time (ms) to complete a SCSI command from the physical device.
2510 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
2513 ------------------------|--------------
2514 vmware_host | **Required.** ESX or ESXi hostname.
2515 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
2516 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
2517 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
2518 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
2519 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
2520 vmware_sessionfile | **Optional.** Session file name enhancement.
2521 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
2522 vmware_nosession | **Optional.** No auth session - IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
2523 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
2524 vmware_password | **Optional.** The username's password. No value defined as default.
2525 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
2526 vmware_warn | **Optional.** The warning threshold. No value defined as default.
2527 vmware_crit | **Optional.** The critical threshold. No value defined as default.
2530 ## <a id="plugins-contrib-vmware-esx-soap-host-io-queue-latency"></a> vmware-esx-soap-host-io-queue-latency
2532 Check command object for the `check_vmware_esx` plugin. Average amount of time (ms) spent in the VMkernel queue.
2534 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
2537 ------------------------|--------------
2538 vmware_host | **Required.** ESX or ESXi hostname.
2539 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
2540 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
2541 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
2542 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
2543 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
2544 vmware_sessionfile | **Optional.** Session file name enhancement.
2545 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
2546 vmware_nosession | **Optional.** No auth session - IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
2547 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
2548 vmware_password | **Optional.** The username's password. No value defined as default.
2549 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
2550 vmware_warn | **Optional.** The warning threshold. No value defined as default.
2551 vmware_crit | **Optional.** The critical threshold. No value defined as default.
2554 ## <a id="plugins-contrib-vmware-esx-soap-host-io-total-latency"></a> vmware-esx-soap-host-io-total-latency
2556 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.
2558 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
2561 ------------------------|--------------
2562 vmware_host | **Required.** ESX or ESXi hostname.
2563 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
2564 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
2565 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
2566 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
2567 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
2568 vmware_sessionfile | **Optional.** Session file name enhancement.
2569 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
2570 vmware_nosession | **Optional.** No auth session - IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
2571 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
2572 vmware_password | **Optional.** The username's password. No value defined as default.
2573 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
2574 vmware_warn | **Optional.** The warning threshold. No value defined as default.
2575 vmware_crit | **Optional.** The critical threshold. No value defined as default.
2578 ## <a id="plugins-contrib-vmware-esx-soap-host-media"></a> vmware-esx-soap-host-media
2580 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.
2582 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
2585 ------------------------|--------------
2586 vmware_host | **Required.** ESX or ESXi hostname.
2587 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
2588 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
2589 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
2590 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
2591 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
2592 vmware_sessionfile | **Optional.** Session file name enhancement.
2593 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
2594 vmware_nosession | **Optional.** No auth session - IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
2595 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
2596 vmware_password | **Optional.** The username's password. No value defined as default.
2597 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
2598 vmware_exclude | **Optional.** Blacklist VMs name. No value defined as default.
2599 vmware_include | **Optional.** Whitelist VMs name. No value defined as default.
2600 vmware_isregexp | **Optional.** Treat blacklist and whitelist expressions as regexp.
2601 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.
2604 ## <a id="plugins-contrib-vmware-esx-soap-host-service"></a> vmware-esx-soap-host-service
2606 Check command object for the `check_vmware_esx` plugin. Shows host service info.
2608 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
2611 ------------------------|--------------
2612 vmware_host | **Required.** ESX or ESXi hostname.
2613 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
2614 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
2615 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
2616 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
2617 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
2618 vmware_sessionfile | **Optional.** Session file name enhancement.
2619 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
2620 vmware_nosession | **Optional.** No auth session - IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
2621 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
2622 vmware_password | **Optional.** The username's password. No value defined as default.
2623 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
2624 vmware_exclude | **Optional.** Blacklist services name. No value defined as default.
2625 vmware_include | **Optional.** Whitelist services name. No value defined as default.
2626 vmware_isregexp | **Optional.** Treat blacklist and whitelist expressions as regexp.
2627 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.
2630 ## <a id="plugins-contrib-vmware-esx-soap-host-runtime"></a> vmware-esx-soap-host-runtime
2632 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.
2634 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
2637 ------------------------|--------------
2638 vmware_host | **Required.** ESX or ESXi hostname.
2639 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
2640 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
2641 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
2642 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
2643 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
2644 vmware_sessionfile | **Optional.** Session file name enhancement.
2645 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
2646 vmware_nosession | **Optional.** No auth session - IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
2647 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
2648 vmware_password | **Optional.** The username's password. No value defined as default.
2649 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
2652 ## <a id="plugins-contrib-vmware-esx-soap-host-runtime-con"></a> vmware-esx-soap-host-runtime-con
2654 Check command object for the `check_vmware_esx` plugin. Shows connection state.
2656 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
2659 ------------------------|--------------
2660 vmware_host | **Required.** ESX or ESXi hostname.
2661 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
2662 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
2663 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
2664 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
2665 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
2666 vmware_sessionfile | **Optional.** Session file name enhancement.
2667 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
2668 vmware_nosession | **Optional.** No auth session - IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
2669 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
2670 vmware_password | **Optional.** The username's password. No value defined as default.
2671 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
2674 ## <a id="plugins-contrib-vmware-esx-soap-host-runtime-listvms"></a> vmware-esx-soap-host-runtime-listvms
2676 Check command object for the `check_vmware_esx` plugin. List of VMware machines and their status.
2678 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
2681 ------------------------|--------------
2682 vmware_host | **Required.** ESX or ESXi hostname.
2683 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
2684 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
2685 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
2686 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
2687 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
2688 vmware_sessionfile | **Optional.** Session file name enhancement.
2689 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
2690 vmware_nosession | **Optional.** No auth session - IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
2691 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
2692 vmware_password | **Optional.** The username's password. No value defined as default.
2693 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
2694 vmware_exclude | **Optional.** Blacklist VMs name. No value defined as default.
2695 vmware_include | **Optional.** Whitelist VMs name. No value defined as default.
2696 vmware_isregexp | **Optional.** Treat blacklist and whitelist expressions as regexp.
2697 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.
2700 ## <a id="plugins-contrib-vmware-esx-soap-host-runtime-status"></a> vmware-esx-soap-host-runtime-status
2702 Check command object for the `check_vmware_esx` plugin. Overall object status (gray/green/red/yellow).
2704 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
2707 ------------------------|--------------
2708 vmware_host | **Required.** ESX or ESXi hostname.
2709 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
2710 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
2711 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
2712 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
2713 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
2714 vmware_sessionfile | **Optional.** Session file name enhancement.
2715 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
2716 vmware_nosession | **Optional.** No auth session - IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
2717 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
2718 vmware_password | **Optional.** The username's password. No value defined as default.
2719 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
2722 ## <a id="plugins-contrib-vmware-esx-soap-host-runtime-health"></a> vmware-esx-soap-host-runtime-health
2724 Check command object for the `check_vmware_esx` plugin. Checks cpu/storage/memory/sensor status.
2726 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
2729 ------------------------|--------------
2730 vmware_host | **Required.** ESX or ESXi hostname.
2731 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
2732 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
2733 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
2734 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
2735 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
2736 vmware_sessionfile | **Optional.** Session file name enhancement.
2737 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
2738 vmware_nosession | **Optional.** No auth session - IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
2739 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
2740 vmware_password | **Optional.** The username's password. No value defined as default.
2741 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
2742 vmware_exclude | **Optional.** Blacklist status name. No value defined as default.
2743 vmware_include | **Optional.** Whitelist status name. No value defined as default.
2744 vmware_isregexp | **Optional.** Treat blacklist and whitelist expressions as regexp.
2747 ## <a id="plugins-contrib-vmware-esx-soap-host-runtime-health-listsensors"></a> vmware-esx-soap-host-runtime-health-listsensors
2749 Check command object for the `check_vmware_esx` plugin. List all available sensors(use for listing purpose only).
2751 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
2754 ------------------------|--------------
2755 vmware_host | **Required.** ESX or ESXi hostname.
2756 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
2757 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
2758 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
2759 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
2760 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
2761 vmware_sessionfile | **Optional.** Session file name enhancement.
2762 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
2763 vmware_nosession | **Optional.** No auth session - IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
2764 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
2765 vmware_password | **Optional.** The username's password. No value defined as default.
2766 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
2767 vmware_exclude | **Optional.** Blacklist status name. No value defined as default.
2768 vmware_include | **Optional.** Whitelist status name. No value defined as default.
2769 vmware_isregexp | **Optional.** Treat blacklist and whitelist expressions as regexp.
2772 ## <a id="plugins-contrib-vmware-esx-soap-host-runtime-health-nostoragestatus"></a> vmware-esx-soap-host-runtime-health-nostoragestatus
2774 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**.
2776 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
2779 ------------------------|--------------
2780 vmware_host | **Required.** ESX or ESXi hostname.
2781 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
2782 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
2783 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
2784 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
2785 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
2786 vmware_sessionfile | **Optional.** Session file name enhancement.
2787 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
2788 vmware_nosession | **Optional.** No auth session - IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
2789 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
2790 vmware_password | **Optional.** The username's password. No value defined as default.
2791 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
2792 vmware_exclude | **Optional.** Blacklist status name. No value defined as default.
2793 vmware_include | **Optional.** Whitelist status name. No value defined as default.
2794 vmware_isregexp | **Optional.** Treat blacklist and whitelist expressions as regexp.
2797 ## <a id="plugins-contrib-vmware-esx-soap-host-runtime-storagehealth"></a> vmware-esx-soap-host-runtime-storagehealth
2799 Check command object for the `check_vmware_esx` plugin. Local storage status check.
2801 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
2804 ------------------------|--------------
2805 vmware_host | **Required.** ESX or ESXi hostname.
2806 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
2807 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
2808 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
2809 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
2810 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
2811 vmware_sessionfile | **Optional.** Session file name enhancement.
2812 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
2813 vmware_nosession | **Optional.** No auth session - IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
2814 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
2815 vmware_password | **Optional.** The username's password. No value defined as default.
2816 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
2817 vmware_exclude | **Optional.** Blacklist storage name. No value defined as default.
2818 vmware_include | **Optional.** Whitelist storage name. No value defined as default.
2819 vmware_isregexp | **Optional.** Treat blacklist and whitelist expressions as regexp.
2820 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.
2823 ## <a id="plugins-contrib-vmware-esx-soap-host-runtime-temp"></a> vmware-esx-soap-host-runtime-temp
2825 Check command object for the `check_vmware_esx` plugin. Lists all temperature sensors.
2827 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
2830 ------------------------|--------------
2831 vmware_host | **Required.** ESX or ESXi hostname.
2832 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
2833 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
2834 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
2835 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
2836 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
2837 vmware_sessionfile | **Optional.** Session file name enhancement.
2838 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
2839 vmware_nosession | **Optional.** No auth session - IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
2840 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
2841 vmware_password | **Optional.** The username's password. No value defined as default.
2842 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
2843 vmware_exclude | **Optional.** Blacklist sensor name. No value defined as default.
2844 vmware_include | **Optional.** Whitelist sensor name. No value defined as default.
2845 vmware_isregexp | **Optional.** Treat blacklist and whitelist expressions as regexp.
2846 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.
2849 ## <a id="plugins-contrib-vmware-esx-soap-host-runtime-issues"></a> vmware-esx-soap-host-runtime-issues
2851 Check command object for the `check_vmware_esx` plugin. Lists all configuration issues for the host.
2853 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
2856 ------------------------|--------------
2857 vmware_host | **Required.** ESX or ESXi hostname.
2858 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
2859 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
2860 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
2861 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
2862 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
2863 vmware_sessionfile | **Optional.** Session file name enhancement.
2864 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
2865 vmware_nosession | **Optional.** No auth session - IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
2866 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
2867 vmware_password | **Optional.** The username's password. No value defined as default.
2868 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
2869 vmware_exclude | **Optional.** Blacklist configuration issues. No value defined as default.
2870 vmware_include | **Optional.** Whitelist configuration issues. No value defined as default.
2871 vmware_isregexp | **Optional.** Treat blacklist and whitelist expressions as regexp.
2872 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.
2875 ## <a id="plugins-contrib-vmware-esx-soap-host-storage"></a> vmware-esx-soap-host-storage
2877 Check command object for the `check_vmware_esx` plugin. Shows Host storage info.
2879 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
2882 ------------------------|--------------
2883 vmware_host | **Required.** ESX or ESXi hostname.
2884 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
2885 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
2886 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
2887 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
2888 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
2889 vmware_sessionfile | **Optional.** Session file name enhancement.
2890 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
2891 vmware_nosession | **Optional.** No auth session - IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
2892 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
2893 vmware_password | **Optional.** The username's password. No value defined as default.
2894 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
2895 vmware_exclude | **Optional.** Blacklist adapters, luns and paths. No value defined as default.
2896 vmware_include | **Optional.** Whitelist adapters, luns and paths. No value defined as default.
2897 vmware_isregexp | **Optional.** Treat blacklist and whitelist expressions as regexp.
2900 ## <a id="plugins-contrib-vmware-esx-soap-host-storage-adapter"></a> vmware-esx-soap-host-storage-adapter
2902 Check command object for the `check_vmware_esx` plugin. List host bus adapters.
2904 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
2907 ------------------------|--------------
2908 vmware_host | **Required.** ESX or ESXi hostname.
2909 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
2910 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
2911 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
2912 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
2913 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
2914 vmware_sessionfile | **Optional.** Session file name enhancement.
2915 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
2916 vmware_nosession | **Optional.** No auth session - IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
2917 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
2918 vmware_password | **Optional.** The username's password. No value defined as default.
2919 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
2920 vmware_exclude | **Optional.** Blacklist adapters. No value defined as default.
2921 vmware_include | **Optional.** Whitelist adapters. No value defined as default.
2922 vmware_isregexp | **Optional.** Treat blacklist and whitelist expressions as regexp.
2923 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.
2926 ## <a id="plugins-contrib-vmware-esx-soap-host-storage-lun"></a> vmware-esx-soap-host-storage-lun
2928 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.
2930 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
2933 ------------------------|--------------
2934 vmware_host | **Required.** ESX or ESXi hostname.
2935 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
2936 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
2937 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
2938 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
2939 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
2940 vmware_sessionfile | **Optional.** Session file name enhancement.
2941 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
2942 vmware_nosession | **Optional.** No auth session - IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
2943 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
2944 vmware_password | **Optional.** The username's password. No value defined as default.
2945 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
2946 vmware_exclude | **Optional.** Blacklist luns. No value defined as default.
2947 vmware_include | **Optional.** Whitelist luns. No value defined as default.
2948 vmware_isregexp | **Optional.** Treat blacklist and whitelist expressions as regexp.
2949 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.
2952 ## <a id="plugins-contrib-vmware-esx-soap-host-storage-path"></a> vmware-esx-soap-host-storage-path
2954 Check command object for the `check_vmware_esx` plugin. List multipaths and the associated paths.
2956 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
2959 ------------------------|--------------
2960 vmware_host | **Required.** ESX or ESXi hostname.
2961 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
2962 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
2963 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
2964 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
2965 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
2966 vmware_sessionfile | **Optional.** Session file name enhancement.
2967 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
2968 vmware_nosession | **Optional.** No auth session - IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
2969 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
2970 vmware_password | **Optional.** The username's password. No value defined as default.
2971 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
2972 vmware_alertonly | **Optional.** List only alerting units. Important here to avoid masses of data. Defaults to "false".
2973 vmware_exclude | **Optional.** Blacklist paths. No value defined as default.
2974 vmware_include | **Optional.** Whitelist paths. No value defined as default.
2975 vmware_isregexp | **Optional.** Treat blacklist and whitelist expressions as regexp.
2976 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.
2979 ## <a id="plugins-contrib-vmware-esx-soap-vm-cpu"></a> vmware-esx-soap-vm-cpu
2981 Check command object for the `check_vmware_esx` plugin. Shows all CPU usage info.
2983 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
2986 ------------------------|--------------
2987 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. Conflicts with **vmware_host**.
2988 vmware_host | **Optional.** ESX or ESXi hostname. Conflicts with **vmware_datacenter**.
2989 vmware_vmname | **Required.** Virtual machine name.
2990 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
2991 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
2992 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
2993 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
2994 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
2995 vmware_sessionfile | **Optional.** Session file name enhancement.
2996 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
2997 vmware_nosession | **Optional.** No auth session - IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
2998 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
2999 vmware_password | **Optional.** The username's password. No value defined as default.
3000 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
3004 ## <a id="plugins-contrib-vmware-esx-soap-vm-cpu-ready"></a> vmware-esx-soap-vm-cpu-ready
3006 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.
3008 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
3011 ------------------------|--------------
3012 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. Conflicts with **vmware_host**.
3013 vmware_host | **Optional.** ESX or ESXi hostname. Conflicts with **vmware_datacenter**.
3014 vmware_vmname | **Required.** Virtual machine name.
3015 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
3016 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
3017 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
3018 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
3019 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
3020 vmware_sessionfile | **Optional.** Session file name enhancement.
3021 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
3022 vmware_nosession | **Optional.** No auth session - IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
3023 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
3024 vmware_password | **Optional.** The username's password. No value defined as default.
3025 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
3026 vmware_warn | **Optional.** The warning threshold. No value defined as default.
3027 vmware_crit | **Optional.** The critical threshold. No value defined as default.
3030 ## <a id="plugins-contrib-vmware-esx-soap-vm-cpu-wait"></a> vmware-esx-soap-vm-cpu-wait
3032 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.
3034 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
3037 ------------------------|--------------
3038 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. Conflicts with **vmware_host**.
3039 vmware_host | **Optional.** ESX or ESXi hostname. Conflicts with **vmware_datacenter**.
3040 vmware_vmname | **Required.** Virtual machine name.
3041 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
3042 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
3043 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
3044 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
3045 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
3046 vmware_sessionfile | **Optional.** Session file name enhancement.
3047 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
3048 vmware_nosession | **Optional.** No auth session - IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
3049 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
3050 vmware_password | **Optional.** The username's password. No value defined as default.
3051 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
3052 vmware_warn | **Optional.** The warning threshold. No value defined as default.
3053 vmware_crit | **Optional.** The critical threshold. No value defined as default.
3056 ## <a id="plugins-contrib-vmware-esx-soap-vm-cpu-usage"></a> vmware-esx-soap-vm-cpu-usage
3058 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.
3060 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
3063 ------------------------|--------------
3064 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. Conflicts with **vmware_host**.
3065 vmware_host | **Optional.** ESX or ESXi hostname. Conflicts with **vmware_datacenter**.
3066 vmware_vmname | **Required.** Virtual machine name.
3067 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
3068 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
3069 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
3070 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
3071 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
3072 vmware_sessionfile | **Optional.** Session file name enhancement.
3073 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
3074 vmware_nosession | **Optional.** No auth session - IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
3075 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
3076 vmware_password | **Optional.** The username's password. No value defined as default.
3077 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
3078 vmware_warn | **Optional.** Warning threshold in percent. Defaults to "80%".
3079 vmware_crit | **Optional.** Critical threshold in percent. Defaults to "90%".
3082 ## <a id="plugins-contrib-vmware-esx-soap-vm-mem"></a> vmware-esx-soap-vm-mem
3084 Check command object for the `check_vmware_esx` plugin. Shows all memory info, except overall.
3086 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
3089 ------------------------|--------------
3090 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. Conflicts with **vmware_host**.
3091 vmware_host | **Optional.** ESX or ESXi hostname. Conflicts with **vmware_datacenter**.
3092 vmware_vmname | **Required.** Virtual machine name.
3093 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
3094 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
3095 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
3096 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
3097 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
3098 vmware_sessionfile | **Optional.** Session file name enhancement.
3099 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
3100 vmware_nosession | **Optional.** No auth session - IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
3101 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
3102 vmware_password | **Optional.** The username's password. No value defined as default.
3103 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
3106 ## <a id="plugins-contrib-vmware-esx-soap-vm-mem-usage"></a> vmware-esx-soap-vm-mem-usage
3108 Check command object for the `check_vmware_esx` plugin. Average mem usage in percentage of configured virtual machine "physical" memory.
3110 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
3113 ------------------------|--------------
3114 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. Conflicts with **vmware_host**.
3115 vmware_host | **Optional.** ESX or ESXi hostname. Conflicts with **vmware_datacenter**.
3116 vmware_vmname | **Required.** Virtual machine name.
3117 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
3118 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
3119 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
3120 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
3121 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
3122 vmware_sessionfile | **Optional.** Session file name enhancement.
3123 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
3124 vmware_nosession | **Optional.** No auth session - IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
3125 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
3126 vmware_password | **Optional.** The username's password. No value defined as default.
3127 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
3128 vmware_warn | **Optional.** Warning threshold in percent. Defaults to "80%".
3129 vmware_crit | **Optional.** Critical threshold in percent. Defaults to "90%".
3132 ## <a id="plugins-contrib-vmware-esx-soap-vm-mem-consumed"></a> vmware-esx-soap-vm-mem-consumed
3134 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>
3135 **vm consumed memory = memory granted - memory saved**
3137 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
3140 ------------------------|--------------
3141 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. Conflicts with **vmware_host**.
3142 vmware_host | **Optional.** ESX or ESXi hostname. Conflicts with **vmware_datacenter**.
3143 vmware_vmname | **Required.** Virtual machine name.
3144 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
3145 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
3146 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
3147 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
3148 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
3149 vmware_sessionfile | **Optional.** Session file name enhancement.
3150 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
3151 vmware_nosession | **Optional.** No auth session - IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
3152 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
3153 vmware_password | **Optional.** The username's password. No value defined as default.
3154 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
3155 vmware_warn | **Optional.** The warning threshold. No value defined as default.
3156 vmware_crit | **Optional.** The critical threshold. No value defined as default.
3159 ## <a id="plugins-contrib-vmware-esx-soap-vm-mem-memctl"></a> vmware-esx-soap-vm-mem-memctl
3161 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.
3163 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
3166 ------------------------|--------------
3167 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. Conflicts with **vmware_host**.
3168 vmware_host | **Optional.** ESX or ESXi hostname. Conflicts with **vmware_datacenter**.
3169 vmware_vmname | **Required.** Virtual machine name.
3170 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
3171 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
3172 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
3173 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
3174 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
3175 vmware_sessionfile | **Optional.** Session file name enhancement.
3176 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
3177 vmware_nosession | **Optional.** No auth session - IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
3178 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
3179 vmware_password | **Optional.** The username's password. No value defined as default.
3180 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
3181 vmware_warn | **Optional.** The warning threshold. No value defined as default.
3182 vmware_crit | **Optional.** The critical threshold. No value defined as default.
3186 ## <a id="plugins-contrib-vmware-esx-soap-vm-net"></a> vmware-esx-soap-vm-net
3188 Check command object for the `check_vmware_esx` plugin. Shows net info.
3190 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
3193 ------------------------|--------------
3194 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. Conflicts with **vmware_host**.
3195 vmware_host | **Optional.** ESX or ESXi hostname. Conflicts with **vmware_datacenter**.
3196 vmware_vmname | **Required.** Virtual machine name.
3197 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
3198 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
3199 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
3200 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
3201 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
3202 vmware_sessionfile | **Optional.** Session file name enhancement.
3203 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
3204 vmware_nosession | **Optional.** No auth session - IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
3205 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
3206 vmware_password | **Optional.** The username's password. No value defined as default.
3207 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
3210 ## <a id="plugins-contrib-vmware-esx-soap-vm-net-usage"></a> vmware-esx-soap-vm-net-usage
3212 Check command object for the `check_vmware_esx` plugin. Overall network usage in KBps(Kilobytes per Second).
3214 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
3217 ------------------------|--------------
3218 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. Conflicts with **vmware_host**.
3219 vmware_host | **Optional.** ESX or ESXi hostname. Conflicts with **vmware_datacenter**.
3220 vmware_vmname | **Required.** Virtual machine name.
3221 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
3222 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
3223 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
3224 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
3225 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
3226 vmware_sessionfile | **Optional.** Session file name enhancement.
3227 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
3228 vmware_nosession | **Optional.** No auth session - IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
3229 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
3230 vmware_password | **Optional.** The username's password. No value defined as default.
3231 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
3232 vmware_warn | **Optional.** The warning threshold. No value defined as default.
3233 vmware_crit | **Optional.** The critical threshold. No value defined as default.
3236 ## <a id="plugins-contrib-vmware-esx-soap-vm-net-receive"></a> vmware-esx-soap-vm-net-receive
3238 Check command object for the `check_vmware_esx` plugin. Receive in KBps(Kilobytes per Second).
3240 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
3243 ------------------------|--------------
3244 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. Conflicts with **vmware_host**.
3245 vmware_host | **Optional.** ESX or ESXi hostname. Conflicts with **vmware_datacenter**.
3246 vmware_vmname | **Required.** Virtual machine name.
3247 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
3248 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
3249 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
3250 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
3251 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
3252 vmware_sessionfile | **Optional.** Session file name enhancement.
3253 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
3254 vmware_nosession | **Optional.** No auth session - IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
3255 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
3256 vmware_password | **Optional.** The username's password. No value defined as default.
3257 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
3258 vmware_warn | **Optional.** The warning threshold. No value defined as default.
3259 vmware_crit | **Optional.** The critical threshold. No value defined as default.
3262 ## <a id="plugins-contrib-vmware-esx-soap-vm-net-send"></a> vmware-esx-soap-vm-net-send
3264 Check command object for the `check_vmware_esx` plugin. Send in KBps(Kilobytes per Second).
3266 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
3269 ------------------------|--------------
3270 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. Conflicts with **vmware_host**.
3271 vmware_host | **Optional.** ESX or ESXi hostname. Conflicts with **vmware_datacenter**.
3272 vmware_vmname | **Required.** Virtual machine name.
3273 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
3274 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
3275 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
3276 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
3277 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
3278 vmware_sessionfile | **Optional.** Session file name enhancement.
3279 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
3280 vmware_nosession | **Optional.** No auth session - IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
3281 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
3282 vmware_password | **Optional.** The username's password. No value defined as default.
3283 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
3284 vmware_warn | **Optional.** The warning threshold. No value defined as default.
3285 vmware_crit | **Optional.** The critical threshold. No value defined as default.
3288 ## <a id="plugins-contrib-vmware-esx-soap-vm-io"></a> vmware-esx-soap-vm-io
3290 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.
3292 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
3295 ------------------------|--------------
3296 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. Conflicts with **vmware_host**.
3297 vmware_host | **Optional.** ESX or ESXi hostname. Conflicts with **vmware_datacenter**.
3298 vmware_vmname | **Required.** Virtual machine name.
3299 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
3300 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
3301 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
3302 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
3303 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
3304 vmware_sessionfile | **Optional.** Session file name enhancement.
3305 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
3306 vmware_nosession | **Optional.** No auth session - IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
3307 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
3308 vmware_password | **Optional.** The username's password. No value defined as default.
3309 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
3312 ## <a id="plugins-contrib-vmware-esx-soap-vm-io-read"></a> vmware-esx-soap-vm-io-read
3314 Check command object for the `check_vmware_esx` plugin. Average number of kilobytes read from the disk each second.
3316 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
3319 ------------------------|--------------
3320 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. Conflicts with **vmware_host**.
3321 vmware_host | **Optional.** ESX or ESXi hostname. Conflicts with **vmware_datacenter**.
3322 vmware_vmname | **Required.** Virtual machine name.
3323 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
3324 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
3325 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
3326 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
3327 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
3328 vmware_sessionfile | **Optional.** Session file name enhancement.
3329 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
3330 vmware_nosession | **Optional.** No auth session - IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
3331 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
3332 vmware_password | **Optional.** The username's password. No value defined as default.
3333 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
3334 vmware_warn | **Optional.** The warning threshold. No value defined as default.
3335 vmware_crit | **Optional.** The critical threshold. No value defined as default.
3338 ## <a id="plugins-contrib-vmware-esx-soap-vm-io-write"></a> vmware-esx-soap-vm-io-write
3340 Check command object for the `check_vmware_esx` plugin. Average number of kilobytes written to disk each second.
3342 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
3345 ------------------------|--------------
3346 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. Conflicts with **vmware_host**.
3347 vmware_host | **Optional.** ESX or ESXi hostname. Conflicts with **vmware_datacenter**.
3348 vmware_vmname | **Required.** Virtual machine name.
3349 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
3350 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
3351 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
3352 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
3353 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
3354 vmware_sessionfile | **Optional.** Session file name enhancement.
3355 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
3356 vmware_nosession | **Optional.** No auth session - IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
3357 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
3358 vmware_password | **Optional.** The username's password. No value defined as default.
3359 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
3360 vmware_warn | **Optional.** The warning threshold. No value defined as default.
3361 vmware_crit | **Optional.** The critical threshold. No value defined as default.
3364 ## <a id="plugins-contrib-vmware-esx-soap-vm-io-usage"></a> vmware-esx-soap-vm-io-usage
3366 Check command object for the `check_vmware_esx` plugin. Aggregated disk I/O rate.
3368 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
3371 ------------------------|--------------
3372 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. Conflicts with **vmware_host**.
3373 vmware_host | **Optional.** ESX or ESXi hostname. Conflicts with **vmware_datacenter**.
3374 vmware_vmname | **Required.** Virtual machine name.
3375 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
3376 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
3377 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
3378 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
3379 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
3380 vmware_sessionfile | **Optional.** Session file name enhancement.
3381 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
3382 vmware_nosession | **Optional.** No auth session - IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
3383 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
3384 vmware_password | **Optional.** The username's password. No value defined as default.
3385 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
3386 vmware_warn | **Optional.** The warning threshold. No value defined as default.
3387 vmware_crit | **Optional.** The critical threshold. No value defined as default.
3390 ## <a id="plugins-contrib-vmware-esx-soap-vm-runtime"></a> vmware-esx-soap-vm-runtime
3392 Check command object for the `check_vmware_esx` plugin. Shows virtual machine runtime info.
3394 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
3397 ------------------------|--------------
3398 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. Conflicts with **vmware_host**.
3399 vmware_host | **Optional.** ESX or ESXi hostname. Conflicts with **vmware_datacenter**.
3400 vmware_vmname | **Required.** Virtual machine name.
3401 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
3402 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
3403 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
3404 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
3405 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
3406 vmware_sessionfile | **Optional.** Session file name enhancement.
3407 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
3408 vmware_nosession | **Optional.** No auth session - IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
3409 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
3410 vmware_password | **Optional.** The username's password. No value defined as default.
3411 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
3414 ## <a id="plugins-contrib-vmware-esx-soap-vm-runtime-con"></a> vmware-esx-soap-vm-runtime-con
3416 Check command object for the `check_vmware_esx` plugin. Shows the connection state.
3418 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
3421 ------------------------|--------------
3422 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. Conflicts with **vmware_host**.
3423 vmware_host | **Optional.** ESX or ESXi hostname. Conflicts with **vmware_datacenter**.
3424 vmware_vmname | **Required.** Virtual machine name.
3425 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
3426 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
3427 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
3428 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
3429 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
3430 vmware_sessionfile | **Optional.** Session file name enhancement.
3431 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
3432 vmware_nosession | **Optional.** No auth session - IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
3433 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
3434 vmware_password | **Optional.** The username's password. No value defined as default.
3435 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
3438 ## <a id="plugins-contrib-vmware-esx-soap-vm-runtime-powerstate"></a> vmware-esx-soap-vm-runtime-powerstate
3440 Check command object for the `check_vmware_esx` plugin. Shows virtual machine power state: poweredOn, poweredOff or suspended.
3442 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
3445 ------------------------|--------------
3446 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. Conflicts with **vmware_host**.
3447 vmware_host | **Optional.** ESX or ESXi hostname. Conflicts with **vmware_datacenter**.
3448 vmware_vmname | **Required.** Virtual machine name.
3449 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
3450 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
3451 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
3452 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
3453 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
3454 vmware_sessionfile | **Optional.** Session file name enhancement.
3455 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
3456 vmware_nosession | **Optional.** No auth session - IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
3457 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
3458 vmware_password | **Optional.** The username's password. No value defined as default.
3459 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
3462 ## <a id="plugins-contrib-vmware-esx-soap-vm-runtime-status"></a> vmware-esx-soap-vm-runtime-status
3464 Check command object for the `check_vmware_esx` plugin. Overall object status (gray/green/red/yellow).
3466 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
3469 ------------------------|--------------
3470 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. Conflicts with **vmware_host**.
3471 vmware_host | **Optional.** ESX or ESXi hostname. Conflicts with **vmware_datacenter**.
3472 vmware_vmname | **Required.** Virtual machine name.
3473 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
3474 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
3475 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
3476 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
3477 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
3478 vmware_sessionfile | **Optional.** Session file name enhancement.
3479 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
3480 vmware_nosession | **Optional.** No auth session - IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
3481 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
3482 vmware_password | **Optional.** The username's password. No value defined as default.
3483 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
3486 ## <a id="plugins-contrib-vmware-esx-soap-vm-runtime-consoleconnections"></a> vmware-esx-soap-vm-runtime-consoleconnections
3488 Check command object for the `check_vmware_esx` plugin. Console connections to virtual machine.
3490 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
3493 ------------------------|--------------
3494 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. Conflicts with **vmware_host**.
3495 vmware_host | **Optional.** ESX or ESXi hostname. Conflicts with **vmware_datacenter**.
3496 vmware_vmname | **Required.** Virtual machine name.
3497 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
3498 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
3499 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
3500 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
3501 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
3502 vmware_sessionfile | **Optional.** Session file name enhancement.
3503 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
3504 vmware_nosession | **Optional.** No auth session - IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
3505 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
3506 vmware_password | **Optional.** The username's password. No value defined as default.
3507 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
3508 vmware_warn | **Optional.** The warning threshold. No value defined as default.
3509 vmware_crit | **Optional.** The critical threshold. No value defined as default.
3512 ## <a id="plugins-contrib-vmware-esx-soap-vm-runtime-gueststate"></a> vmware-esx-soap-vm-runtime-gueststate
3514 Check command object for the `check_vmware_esx` plugin. Guest OS status. Needs VMware Tools installed and running.
3516 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
3519 ------------------------|--------------
3520 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. Conflicts with **vmware_host**.
3521 vmware_host | **Optional.** ESX or ESXi hostname. Conflicts with **vmware_datacenter**.
3522 vmware_vmname | **Required.** Virtual machine name.
3523 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
3524 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
3525 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
3526 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
3527 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
3528 vmware_sessionfile | **Optional.** Session file name enhancement.
3529 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
3530 vmware_nosession | **Optional.** No auth session - IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
3531 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
3532 vmware_password | **Optional.** The username's password. No value defined as default.
3533 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
3535 ## <a id="plugins-contrib-vmware-esx-soap-vm-runtime-tools"></a> vmware-esx-soap-vm-runtime-tools
3537 Check command object for the `check_vmware_esx` plugin. Guest OS status. VMware tools status.
3539 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
3542 ------------------------|--------------
3543 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. Conflicts with **vmware_host**.
3544 vmware_host | **Optional.** ESX or ESXi hostname. Conflicts with **vmware_datacenter**.
3545 vmware_vmname | **Required.** Virtual machine name.
3546 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
3547 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
3548 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
3549 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
3550 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
3551 vmware_sessionfile | **Optional.** Session file name enhancement.
3552 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
3553 vmware_nosession | **Optional.** No auth session - IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
3554 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
3555 vmware_password | **Optional.** The username's password. No value defined as default.
3556 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
3559 ## <a id="plugins-contrib-vmware-esx-soap-vm-runtime-issues"></a> vmware-esx-soap-vm-runtime-issues
3561 Check command object for the `check_vmware_esx` plugin. All issues for the virtual machine.
3563 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
3566 ------------------------|--------------
3567 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. Conflicts with **vmware_host**.
3568 vmware_host | **Optional.** ESX or ESXi hostname. Conflicts with **vmware_datacenter**.
3569 vmware_vmname | **Required.** Virtual machine name.
3570 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
3571 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
3572 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
3573 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
3574 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
3575 vmware_sessionfile | **Optional.** Session file name enhancement.
3576 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
3577 vmware_nosession | **Optional.** No auth session - IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
3578 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
3579 vmware_password | **Optional.** The username's password. No value defined as default.
3580 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
3581 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.