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.
488 load_percpu | **Optional.** Divide the load averages by the number of CPUs (when possible). Defaults to false.
491 ## <a id="plugin-check-command-nrpe"></a> nrpe
493 Check command object for the `check_nrpe` plugin.
495 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
498 ----------------|--------------
499 nrpe_address | **Optional.** The host's address. Defaults to "$address$" if the host's `address` attribute is set, "$address6$" otherwise.
500 nrpe_port | **Optional.** The NRPE port. Defaults to 5666.
501 nrpe_command | **Optional.** The command that should be executed.
502 nrpe_no_ssl | **Optional.** Whether to disable SSL or not. Defaults to `false`.
503 nrpe_timeout_unknown | **Optional.** Whether to set timeouts to unknown instead of critical state. Defaults to `false`.
504 nrpe_timeout | **Optional.** The timeout in seconds.
505 nrpe_arguments | **Optional.** Arguments that should be passed to the command. Multiple arguments must be defined as array.
508 ## <a id="plugin-check-command-nscp"></a> nscp
510 Check command object for the `check_nt` plugin.
512 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
515 ----------------|--------------
516 nscp_address | **Optional.** The host's address. Defaults to "$address$" if the host's `address` attribute is set, "$address6$" otherwise.
517 nscp_port | **Optional.** The NSClient++ port. Defaults to 12489.
518 nscp_password | **Optional.** The NSClient++ password.
519 nscp_variable | **Required.** The variable that should be checked.
520 nscp_params | **Optional.** Parameters for the query. Multiple parameters must be defined as array.
521 nscp_warn | **Optional.** The warning threshold.
522 nscp_crit | **Optional.** The critical threshold.
523 nscp_timeout | **Optional.** The query timeout in seconds.
524 nscp_showall | **Optional.** Use with SERVICESTATE to see working services or PROCSTATE for running processes. Defaults to false.
527 ## <a id="plugin-check-command-ntp-time"></a> ntp_time
529 Check command object for the `check_ntp_time` plugin.
531 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
534 ----------------|--------------
535 ntp_address | **Optional.** The host's address. Defaults to "$address$" if the host's `address` attribute is set, "$address6$" otherwise.
536 ntp_port | **Optional.** Port number (default: 123).
537 ntp_quit | **Optional.** Returns UNKNOWN instead of CRITICAL if offset cannot be found.
538 ntp_warning | **Optional.** Offset to result in warning status (seconds).
539 ntp_critical | **Optional.** Offset to result in critical status (seconds).
540 ntp_timeoffset | **Optional.** Expected offset of the ntp server relative to local server (seconds).
541 ntp_timeout | **Optional.** Seconds before connection times out (default: 10).
544 ## <a id="plugin-check-command-ntp-peer"></a> ntp_peer
546 Check command object for the `check_ntp_peer` plugin.
548 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
551 ----------------|--------------
552 ntp_address | **Optional.** The host's address. Defaults to "$address$" if the host's `address` attribute is set, "$address6$" otherwise.
553 ntp_port | **Optional.** The port to use. Default to 123.
554 ntp_warning | **Optional.** Offset to result in warning status (seconds).
555 ntp_critical | **Optional.** Offset to result in critical status (seconds).
556 ntp_wstratum | **Optional.** Warning threshold for stratum of server's synchronization peer.
557 ntp_cstratum | **Optional.** Critical threshold for stratum of server's synchronization peer.
558 ntp_wjitter | **Optional.** Warning threshold for jitter.
559 ntp_cjitter | **Optional.** Critical threshold for jitter.
560 ntp_wsource | **Optional.** Warning threshold for number of usable time sources.
561 ntp_csource | **Optional.** Critical threshold for number of usable time sources.
562 ntp_timeout | **Optional.** Seconds before connection times out (default: 10).
565 ## <a id="plugin-check-command-passive"></a> passive
567 Specialised check command object for passive checks executing the `check_dummy` plugin with appropriate default values.
569 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
572 ----------------|--------------
573 dummy_state | **Optional.** The state. Can be one of 0 (ok), 1 (warning), 2 (critical) and 3 (unknown). Defaults to 3.
574 dummy_text | **Optional.** Plugin output. Defaults to "No Passive Check Result Received.".
577 ## <a id="plugin-check-command-ping"></a> ping
579 Check command object for the `check_ping` plugin. This command uses the host's `address` attribute
580 if available and falls back to using the `address6` attribute if the `address` attribute is not set.
583 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
586 ----------------|--------------
587 ping_address | **Optional.** The host's address. Defaults to "$address$" if the host's `address` attribute is set, "$address6$" otherwise.
588 ping_wrta | **Optional.** The RTA warning threshold in milliseconds. Defaults to 100.
589 ping_wpl | **Optional.** The packet loss warning threshold in %. Defaults to 5.
590 ping_crta | **Optional.** The RTA critical threshold in milliseconds. Defaults to 200.
591 ping_cpl | **Optional.** The packet loss critical threshold in %. Defaults to 15.
592 ping_packets | **Optional.** The number of packets to send. Defaults to 5.
593 ping_timeout | **Optional.** The plugin timeout in seconds. Defaults to 0 (no timeout).
596 ## <a id="plugin-check-command-ping4"></a> ping4
598 Check command object for the `check_ping` plugin.
600 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
603 ----------------|--------------
604 ping_address | **Optional.** The host's IPv4 address. Defaults to "$address$".
605 ping_wrta | **Optional.** The RTA warning threshold in milliseconds. Defaults to 100.
606 ping_wpl | **Optional.** The packet loss warning threshold in %. Defaults to 5.
607 ping_crta | **Optional.** The RTA critical threshold in milliseconds. Defaults to 200.
608 ping_cpl | **Optional.** The packet loss critical threshold in %. Defaults to 15.
609 ping_packets | **Optional.** The number of packets to send. Defaults to 5.
610 ping_timeout | **Optional.** The plugin timeout in seconds. Defaults to 0 (no timeout).
612 ## <a id="plugin-check-command-ping6"></a> ping6
614 Check command object for the `check_ping` plugin.
616 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
619 ----------------|--------------
620 ping_address | **Optional.** The host's IPv6 address. Defaults to "$address6$".
621 ping_wrta | **Optional.** The RTA warning threshold in milliseconds. Defaults to 100.
622 ping_wpl | **Optional.** The packet loss warning threshold in %. Defaults to 5.
623 ping_crta | **Optional.** The RTA critical threshold in milliseconds. Defaults to 200.
624 ping_cpl | **Optional.** The packet loss critical threshold in %. Defaults to 15.
625 ping_packets | **Optional.** The number of packets to send. Defaults to 5.
626 ping_timeout | **Optional.** The plugin timeout in seconds. Defaults to 0 (no timeout).
629 ## <a id="plugin-check-command-pop"></a> pop
631 Check command object for the `check_pop` plugin.
633 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
636 ----------------|--------------
637 pop_address | **Optional.** The host's address. Defaults to "$address$" if the host's `address` attribute is set, "$address6$" otherwise.
638 pop_port | **Optional.** The port that should be checked. Defaults to 110.
641 ## <a id="plugin-check-command-processes"></a> procs
643 Check command object for the `check_procs` plugin.
645 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
648 ---------------------|--------------
649 procs_warning | **Optional.** The process count warning threshold. Defaults to 250.
650 procs_critical | **Optional.** The process count critical threshold. Defaults to 400.
651 procs_metric | **Optional.** Check thresholds against metric.
652 procs_timeout | **Optional.** Seconds before plugin times out.
653 procs_traditional | **Optional.** Filter own process the traditional way by PID instead of /proc/pid/exe. Defaults to false.
654 procs_state | **Optional.** Only scan for processes that have one or more of the status flags you specify.
655 procs_ppid | **Optional.** Only scan for children of the parent process ID indicated.
656 procs_vsz | **Optional.** Only scan for processes with VSZ higher than indicated.
657 procs_rss | **Optional.** Only scan for processes with RSS higher than indicated.
658 procs_pcpu | **Optional.** Only scan for processes with PCPU higher than indicated.
659 procs_user | **Optional.** Only scan for processes with user name or ID indicated.
660 procs_argument | **Optional.** Only scan for processes with args that contain STRING.
661 procs_argument_regex | **Optional.** Only scan for processes with args that contain the regex STRING.
662 procs_command | **Optional.** Only scan for exact matches of COMMAND (without path).
663 procs_nokthreads | **Optional.** Only scan for non kernel threads. Defaults to false.
666 ## <a id="plugin-check-command-simap"></a> simap
668 Check command object for the `check_simap` plugin.
670 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
673 ----------------|--------------
674 simap_address | **Optional.** The host's address. Defaults to "$address$" if the host's `address` attribute is set, "$address6$" otherwise.
675 simap_port | **Optional.** The host's port.
678 ## <a id="plugin-check-command-smtp"></a> smtp
680 Check command object for the `check_smtp` plugin.
682 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
685 ----------------------|--------------
686 smtp_address | **Optional.** The host's address. Defaults to "$address$" if the host's `address` attribute is set, "$address6$" otherwise.
687 smtp_port | **Optional.** The port that should be checked. Defaults to 25.
688 smtp_mail_from | **Optional.** Test a MAIL FROM command with the given email address.
689 smtp_expect | **Optional.** String to expect in first line of server response (default: '220').
690 smtp_command | **Optional.** SMTP command (may be used repeatedly).
691 smtp_response | **Optional.** Expected response to command (may be used repeatedly).
692 smtp_helo_fqdn | **Optional.** FQDN used for HELO
693 smtp_certificate_age | **Optional.** Minimum number of days a certificate has to be valid.
694 smtp_starttls | **Optional.** Use STARTTLS for the connection.
695 smtp_authtype | **Optional.** SMTP AUTH type to check (default none, only LOGIN supported).
696 smtp_authuser | **Optional.** SMTP AUTH username.
697 smtp_authpass | **Optional.** SMTP AUTH password.
698 smtp_ignore_quit | **Optional.** Ignore failure when sending QUIT command to server.
699 smtp_warning | **Optional.** Response time to result in warning status (seconds).
700 smtp_critical | **Optional.** Response time to result in critical status (seconds).
701 smtp_timeout | **Optional.** Seconds before connection times out (default: 10).
704 ## <a id="plugin-check-command-snmp"></a> snmp
706 Check command object for the `check_snmp` plugin.
708 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
711 --------------------|--------------
712 snmp_address | **Optional.** The host's address. Defaults to "$address$" if the host's `address` attribute is set, "$address6$" otherwise.
713 snmp_oid | **Required.** The SNMP OID.
714 snmp_community | **Optional.** The SNMP community. Defaults to "public".
715 snmp_warn | **Optional.** The warning threshold.
716 snmp_crit | **Optional.** The critical threshold.
717 snmp_string | **Optional.** Return OK state if the string matches exactly with the output value
718 snmp_ereg | **Optional.** Return OK state if extended regular expression REGEX matches with the output value
719 snmp_eregi | **Optional.** Return OK state if case-insensitive extended REGEX matches with the output value
720 snmp_label | **Optional.** Prefix label for output value
721 snmp_invert_search | **Optional.** Invert search result and return CRITICAL state if found
722 snmp_units | **Optional.** Units label(s) for output value (e.g., 'sec.').
723 snmp_version | **Optional.** Version to use. E.g. 1, 2, 2c or 3.
724 snmp_miblist | **Optional.** MIB's to use, comma separated. Defaults to "ALL".
725 snmp_rate_multiplier | **Optional.** Converts rate per second. For example, set to 60 to convert to per minute.
726 snmp_rate | **Optional.** Boolean. Enable rate calculation.
727 snmp_getnext | **Optional.** Boolean. Use SNMP GETNEXT. Defaults to false.
728 snmp_timeout | **Optional.** The command timeout in seconds. Defaults to 10 seconds.
730 ## <a id="plugin-check-command-snmpv3"></a> snmpv3
732 Check command object for the `check_snmp` plugin, using SNMPv3 authentication and encryption options.
734 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
737 ------------------|--------------
738 snmpv3_address | **Optional.** The host's address. Defaults to "$address$" if the host's `address` attribute is set, "$address6$" otherwise.
739 snmpv3_user | **Required.** The username to log in with.
740 snmpv3_auth_alg | **Optional.** The authentication algorithm. Defaults to SHA.
741 snmpv3_seclevel | **Optional.** The security level. Defaults to authPriv.
742 snmpv3_auth_key | **Required,** The authentication key. Required if `snmpv3_seclevel` is set to `authPriv` otherwise optional.
743 snmpv3_priv_alg | **Optional.** The encryption algorithm. Defaults to AES.
744 snmpv3_priv_key | **Required.** The encryption key.
745 snmpv3_oid | **Required.** The SNMP OID.
746 snmpv3_warn | **Optional.** The warning threshold.
747 snmpv3_crit | **Optional.** The critical threshold.
748 snmpv3_label | **Optional.** Prefix label for output value.
750 ## <a id="plugin-check-command-snmp-uptime"></a> snmp-uptime
752 Check command object for the `check_snmp` plugin.
754 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
757 ----------------|--------------
758 snmp_address | **Optional.** The host's address. Defaults to "$address$" if the host's `address` attribute is set, "$address6$" otherwise.
759 snmp_oid | **Optional.** The SNMP OID. Defaults to "1.3.6.1.2.1.1.3.0".
760 snmp_community | **Optional.** The SNMP community. Defaults to "public".
763 ## <a id="plugin-check-command-spop"></a> spop
765 Check command object for the `check_spop` plugin.
767 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
770 ----------------|--------------
771 spop_address | **Optional.** The host's address. Defaults to "$address$" if the host's `address` attribute is set, "$address6$" otherwise.
772 spop_port | **Optional.** The host's port.
775 ## <a id="plugin-check-command-ssh"></a> ssh
777 Check command object for the `check_ssh` plugin.
779 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
782 ----------------|--------------
783 ssh_address | **Optional.** The host's address. Defaults to "$address$" if the host's `address` attribute is set, "$address6$" otherwise.
784 ssh_port | **Optional.** The port that should be checked. Defaults to 22.
785 ssh_timeout | **Optional.** Seconds before connection times out. Defaults to 10.
788 ## <a id="plugin-check-command-ssl"></a> ssl
790 Check command object for the `check_tcp` plugin, using ssl-related options.
792 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
795 ------------------------------|--------------
796 ssl_address | **Optional.** The host's address. Defaults to "$address$" if the host's `address` attribute is set, "$address6$" otherwise.
797 ssl_port | **Required.** The port that should be checked.
798 ssl_timeout | **Optional.** Timeout in seconds for the connect and handshake. The plugin default is 10 seconds.
799 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.
800 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.
803 ## <a id="plugin-check-command-ssmtp"></a> ssmtp
805 Check command object for the `check_ssmtp` plugin.
807 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
810 ----------------|--------------
811 ssmtp_address | **Required.** The host's address. Defaults to "$address$" if the host's `address` attribute is set, "$address6$" otherwise.
812 ssmtp_port | **Optional.** The port that should be checked. Defaults to 465.
815 ## <a id="plugin-check-command-swap"></a> swap
817 Check command object for the `check_swap` plugin.
819 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
822 ----------------|--------------
823 swap_wfree | **Optional.** The free swap space warning threshold in %. Defaults to 50.
824 swap_cfree | **Optional.** The free swap space critical threshold in %. Defaults to 25.
827 ## <a id="plugin-check-command-tcp"></a> tcp
829 Check command object for the `check_tcp` plugin.
831 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
834 ----------------|--------------
835 tcp_address | **Optional.** The host's address. Defaults to "$address$" if the host's `address` attribute is set, "$address6$" otherwise.
836 tcp_port | **Required.** The port that should be checked.
837 tcp_expect | **Optional.** String to expect in server response (may be repeated).
838 tcp_all | **Optional.** All expect strings need to occur in server response. Defaults to false.
839 tcp_escape_send | **Optional.** Enable usage of \n, \r, \t or \\\\ in send string.
840 tcp_send | **Optional.** String to send to the server.
841 tcp_escape_quit | **Optional.** Enable usage of \n, \r, \t or \\\\ in quit string.
842 tcp_quit | **Optional.** String to send server to initiate a clean close of the connection.
843 tcp_refuse | **Optional.** Accept TCP refusals with states ok, warn, crit. Defaults to crit.
844 tcp_mismatch | **Optional.** Accept expected string mismatches with states ok, warn, crit. Defaults to warn.
845 tcp_jail | **Optional.** Hide output from TCP socket.
846 tcp_maxbytes | **Optional.** Close connection once more than this number of bytes are received.
847 tcp_delay | **Optional.** Seconds to wait between sending string and polling for response.
848 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.
849 tcp_ssl | **Optional.** Use SSL for the connection. Defaults to false.
850 tcp_wtime | **Optional.** Response time to result in warning status (seconds).
851 tcp_ctime | **Optional.** Response time to result in critical status (seconds).
852 tcp_timeout | **Optional.** Seconds before connection times out. Defaults to 10.
855 ## <a id="plugin-check-command-udp"></a> udp
857 Check command object for the `check_udp` plugin.
859 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
862 ----------------|--------------
863 udp_address | **Optional.** The host's address. Defaults to "$address$" if the host's `address` attribute is set, "$address6$" otherwise.
864 udp_port | **Required.** The port that should be checked.
865 udp_send | **Required.** The payload to send in the UDP datagram.
866 udp_expect | **Required.** The payload to expect in the response datagram.
867 udp_quit | **Optional.** The payload to send to 'close' the session.
870 ## <a id="plugin-check-command-ups"></a> ups
872 Check command object for the `check_ups` plugin.
874 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
877 ----------------|--------------
878 ups_address | **Required.** The address of the host running upsd. Defaults to "$address$" if the host's `address` attribute is set, "$address6$" otherwise.
879 ups_name | **Required.** The UPS name. Defaults to `ups`.
880 ups_port | **Optional.** The port to which to connect. Defaults to 3493.
881 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`.
882 ups_warning | **Optional.** The warning threshold for the selected variable.
883 ups_critical | **Optional.** The critical threshold for the selected variable.
884 ups_celsius | **Optional.** Display the temperature in degrees Celsius instead of Fahrenheit. Defaults to `false`.
885 ups_timeout | **Optional.** The number of seconds before the connection times out. Defaults to 10.
888 ## <a id="plugin-check-command-users"></a> users
890 Check command object for the `check_users` plugin.
892 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
895 ----------------|--------------
896 users_wgreater | **Optional.** The user count warning threshold. Defaults to 20.
897 users_cgreater | **Optional.** The user count critical threshold. Defaults to 50.
900 ## <a id="plugin-check-command-clamd"></a> clamd
902 Check command object for the `check_clamd` plugin.
904 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
907 -------------------|--------------
908 clamd_address | **Required.** The host's address or unix socket (must be an absolute path).
909 clamd_port | **Optional.** Port number (default: none).
910 clamd_expect | **Optional.** String to expect in server response (may be repeated).
911 clamd_all | **Optional.** All expect strings need to occur in server response. Defaults to false.
912 clamd_escape_send | **Optional.** Enable usage of \n, \r, \t or \\\\ in send string.
913 clamd_send | **Optional.** String to send to the server.
914 clamd_escape_quit | **Optional.** Enable usage of \n, \r, \t or \\\\ in quit string.
915 clamd_quit | **Optional.** String to send server to initiate a clean close of the connection.
916 clamd_refuse | **Optional.** Accept TCP refusals with states ok, warn, crit. Defaults to crit.
917 clamd_mismatch | **Optional.** Accept expected string mismatches with states ok, warn, crit. Defaults to warn.
918 clamd_jail | **Optional.** Hide output from TCP socket.
919 clamd_maxbytes | **Optional.** Close connection once more than this number of bytes are received.
920 clamd_delay | **Optional.** Seconds to wait between sending string and polling for response.
921 clamd_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.
922 clamd_ssl | **Optional.** Use SSL for the connection. Defaults to false.
923 clamd_wtime | **Optional.** Response time to result in warning status (seconds).
924 clamd_ctime | **Optional.** Response time to result in critical status (seconds).
925 clamd_timeout | **Optional.** Seconds before connection times out. Defaults to 10.
928 ## <a id="plugin-check-command-mailq"></a> mailq
930 Check command object for the `check_mailq` plugin.
932 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
935 ------------------------|--------------
936 mailq_warning | **Required.** Min. number of messages in queue to generate warning.
937 mailq_critical | **Required.** Min. number of messages in queue to generate critical alert ( w < c ).
938 mailq_domain_warning | **Optional.** Min. number of messages for same domain in queue to generate warning
939 mailq_domain_critical | **Optional.** Min. number of messages for same domain in queue to generate critical alert ( W < C ).
940 mailq_timeout | **Optional.** Plugin timeout in seconds (default = 15).
941 mailq_servertype | **Optional.** [ sendmail | qmail | postfix | exim | nullmailer ] (default = autodetect).
944 # <a id="windows-plugins"></a>Icinga 2 Windows plugins
946 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.
948 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:
950 include <windows-plugins>
952 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.
955 ## <a id="windows-plugins-thresholds"></a>Threshold syntax
957 So not specified differently the thresholds for the plugins all follow the same pattern
960 :------------|:----------
961 "29" | The threshold is 29.
962 "!29" | The threshold is 29, but the negative of the result is returned.
963 "[10-40]" | The threshold is a range from (including) 20 to 40, a value inside means the threshold has been exceeded.
964 "![10-40]" | Same as above, but the result is inverted.
967 ## <a id="windows-plugins-disk-windows"></a>disk-windows
969 Check command object for the `check_disk.exe` plugin.
970 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.).
975 :---------------|:------------
976 disk\_win\_warn | **Optional**. The warning threshold.
977 disk\_win\_crit | **Optional**. The critical threshold.
978 disk\_win\_path | **Optional**. Check only these paths, default checks all.
979 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.
982 ## <a id="windows-plugins-load-windows"></a>load-windows
984 Check command object for the `check_load.exe` plugin.
985 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).
990 :---------------|:------------
991 load\_win\_warn | **Optional**. The warning threshold.
992 load\_win\_crit | **Optional**. The critical threshold.
995 ## <a id="windows-plugins-memory-windows"></a>memory-windows
997 Check command object for the `check_memory.exe` plugin.
998 The memory collection is instant.
1003 :-----------------|:------------
1004 memory\_win\_warn | **Optional**. The warning threshold.
1005 memory\_win\_crit | **Optional**. The critical threshold.
1006 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.
1009 ## <a id="windows-plugins-network-windows"></a>network-windows
1011 Check command object for the `check_network.exe` plugin.
1012 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).
1017 :------------------|:------------
1018 network\_win\_warn | **Optional**. The warning threshold.
1019 network\_win\_crit | **Optional**. The critical threshold.
1022 ## <a id="windows-plugins-permon-windows"></a>perfmon-windows
1024 Check command object for the `check_perfmon.exe` plugin.
1025 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`.
1027 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"`
1032 :---------------------|:------------
1033 perfmon\_win\_warn | **Optional**. The warning threshold.
1034 perfmon\_win\_crit | **Optional**. The critical threshold.
1035 perfmon\_win\_counter | **Required**. The Performance Counter to use. Ex. `\Processor(_Total)\% Idle Time`.
1036 perfmon\_win\_wait | **Optional**. Time in milliseconds to wait between data collection (default: 1000).
1037 perfmon\_win\_type | **Optional**. Format in which to expect perfomance values. Possible are: long, int64 and double (default).
1040 ## <a id="windows-plugins-ping-windows"></a>ping-windows
1042 Check command object for the `check_ping.exe` plugin.
1043 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.
1048 :------------------|:------------
1049 ping\_win\_warn | **Optional**. The warning threshold. RTA and package loss seperated by comma.
1050 ping\_win\_crit | **Optional**. The critical threshold. RTA and package loss seperated by comma.
1051 ping\_win\_address | **Required**. An IPv4 or IPv6 address
1052 ping\_win\_packets | **Optional**. Number of packages to send. Default: 5.
1053 ping\_win\_timeout | **Optional**. The timeout in milliseconds. Default: 1000
1056 ## <a id="windows-plugins-procs-windows"></a>procs-windows
1058 Check command object for `check_procs.exe` plugin.
1059 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.
1064 :----------------|:------------
1065 procs\_win\_warn | **Optional**. The warning threshold.
1066 procs\_win\_crit | **Optional**. The critical threshold.
1067 procs\_win\_user | **Optional**. Count this useres processes.
1070 ## <a id="windows-plugins-service-windows"></a>service-windows
1072 Check command object for `check_service.exe` plugin.
1073 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.
1078 :---------------------|:------------
1079 service\_win\_warn | **Optional**. Warn when service is not running.
1080 service\_win\_service | **Required**. The critical threshold.
1083 ## <a id="windows-plugins-swap-windows"></a>swap-windows
1085 Check command object for `check_swap.exe` plugin.
1086 The data collection is instant.
1091 :---------------|:------------
1092 swap\_win\_warn | **Optional**. The warning threshold.
1093 swap\_win\_crit | **Optional**. The critical threshold.
1094 swap\_win\_unit | **Optional**. The unit to display the received value in, thresholds are interpreted in this unit. Defaults to "mb" (megabyte).
1097 ## <a id="windows-plugins-update-windows"></a>update-windows
1099 Check command object for `check_update.exe` plugin.
1100 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.
1105 :-------------------|:------------
1106 update\_win\_warn | If set returns warning when important updates are available
1107 update\_win\_crit | If set return critical when important updates that require a reboot are available.
1108 update\_win\_reboot | Set to treat 'may need update' as 'definitely needs update'
1111 ## <a id="windows-plugins-uptime-windows"></a>uptime-windows
1113 Check command opject for `check_uptime.exe` plugin.
1114 Uses GetTickCount64 to get the uptime, so boot time is not included.
1119 :-----------------|:------------
1120 uptime\_win\_warn | **Optional**. The warning threshold.
1121 uptime\_win\_crit | **Optional**. The critical threshold.
1122 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).
1125 ## <a id="windows-plugins-users-windows"></a>users-windows
1127 Check command object for `check_users.exe` plugin.
1132 :----------------|:------------
1133 users\_win\_warn | **Optional**. The warning threshold.
1134 users\_win\_crit | **Optional**. The critical threshold.
1137 # <a id="nscp-plugin-check-commands"></a> NSClient++ Check Commands
1139 Icinga 2 can use the `nscp client` command to run arbitrary NSClient++ checks.
1141 You can enable these check commands by adding the following the include directive in your
1142 [icinga2.conf](4-configuring-icinga-2.md#icinga2-conf) configuration file:
1146 You can also optionally specify an alternative installation directory for NSClient++ by adding
1147 the NscpPath constant in your [constants.conf](4-configuring-icinga-2.md#constants-conf) configuration
1150 const NscpPath = "C:\\Program Files (x86)\\NSClient++"
1152 By default Icinga 2 uses the Microsoft Installer API to determine where NSClient++ is installed. It should
1153 not be necessary to manually set this constant.
1155 Note that it is not necessary to run NSClient++ as a Windows service for these commands to work.
1157 ## <a id="nscp-check-local"></a> nscp-local
1159 Check command object for NSClient++
1161 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
1164 ----------------|--------------
1165 nscp_log_level | **Optional.** The log level. Defaults to "critical".
1166 nscp_load_all | **Optional.** Whether to load all modules. Defaults to true.
1167 nscp_boot | **Optional.** Whether to use the --boot option. Defaults to true.
1168 nscp_query | **Required.** The NSClient++ query. Try `nscp client -q x` for a list.
1169 nscp_arguments | **Optional.** An array of query arguments.
1171 ## <a id="nscp-check-local-cpu"></a> nscp-local-cpu
1173 Check command object for the `check_cpu` NSClient++ plugin.
1175 This command has the same custom attributes like the `nscp-local` check command.
1177 ## <a id="nscp-check-local-memory"></a> nscp-local-memory
1179 Check command object for the `check_memory` NSClient++ plugin.
1181 This command has the same custom attributes like the `nscp-local` check command.
1183 ## <a id="nscp-check-local-os-version"></a> nscp-local-os-version
1185 Check command object for the `check_os_version` NSClient++ plugin.
1187 This command has the same custom attributes like the `nscp-local` check command.
1189 ## <a id="nscp-check-local-pagefile"></a> nscp-local-pagefile
1191 Check command object for the `check_pagefile` NSClient++ plugin.
1193 This command has the same custom attributes like the `nscp-local` check command.
1195 ## <a id="nscp-check-local-process"></a> nscp-local-process
1197 Check command object for the `check_process` NSClient++ plugin.
1199 This command has the same custom attributes like the `nscp-local` check command.
1201 ## <a id="nscp-check-local-service"></a> nscp-local-service
1203 Check command object for the `check_service` NSClient++ plugin.
1205 This command has the same custom attributes like the `nscp-local` check command.
1207 ## <a id="nscp-check-local-uptime"></a> nscp-local-uptime
1209 Check command object for the `check_uptime` NSClient++ plugin.
1211 This command has the same custom attributes like the `nscp-local` check command.
1213 ## <a id="nscp-check-local-version"></a> nscp-local-version
1215 Check command object for the `check_version` NSClient++ plugin.
1217 This command has the same custom attributes like the `nscp-local` check command.
1219 ## <a id="nscp-check-local-disk"></a> nscp-local-disk
1221 Check command object for the `check_drivesize` NSClient++ plugin.
1223 This command has the same custom attributes like the `nscp-local` check command.
1225 # <a id="snmp-manubulon-plugin-check-commands"></a> SNMP Manubulon Plugin Check Commands
1227 The `SNMP Manubulon Plugin Check Commands` provide example configuration for plugin check
1228 commands provided by the [SNMP Manubulon project](http://nagios.manubulon.com/index_snmp.html).
1230 The SNMP manubulon plugin check commands assume that the global constant named `ManubulonPluginDir`
1231 is set to the path where the Manubublon SNMP plugins are installed.
1233 You can enable these plugin check commands by adding the following the include directive in your
1234 [icinga2.conf](4-configuring-icinga-2.md#icinga2-conf) configuration file:
1238 ## Checks by Host Type
1240 **N/A** : Not available for this type.
1242 **SNMP** : Available for simple SNMP query.
1246 **Specific** : Script name for platform specific checks.
1249 Host type | Interface | storage | load/cpu | mem | process | env | specific
1250 ------------------------|------------|----------|-----------|-----|----------|-----|-------------------------
1251 Linux | Yes | Yes | Yes | Yes | Yes | No |
1252 Windows | Yes | Yes | Yes | Yes | Yes | No | check_snmp_win.pl
1253 Cisco router/switch | Yes | N/A | Yes | Yes | N/A | Yes |
1254 HP router/switch | Yes | N/A | Yes | Yes | N/A | No |
1255 Bluecoat proxy | Yes | SNMP | Yes | SNMP| No | Yes |
1256 CheckPoint on SPLAT | Yes | Yes | Yes | Yes | Yes | No | check_snmp_cpfw.pl
1257 CheckPoint on Nokia IP | Yes | Yes | Yes | No | ?? | No | check_snmp_vrrp.pl
1258 Boostedge | Yes | Yes | Yes | Yes | ?? | No | check_snmp_boostedge.pl
1259 AS400 | Yes | Yes | Yes | Yes | No | No |
1260 NetsecureOne Netbox | Yes | Yes | Yes | ?? | Yes | No |
1261 Radware Linkproof | Yes | N/A | SNMP | SNMP| No | No | check_snmp_linkproof_nhr <br> check_snmp_vrrp.pl
1262 IronPort | Yes | SNMP | SNMP | SNMP| No | Yes |
1263 Cisco CSS | Yes | ?? | Yes | Yes | No | ?? | check_snmp_css.pl
1266 ## <a id="plugin-check-command-snmp-load"></a> snmp-load
1268 Check command object for the [check_snmp_load.pl](http://nagios.manubulon.com/snmp_load.html) plugin.
1270 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
1274 ------------------------|--------------
1275 snmp_address | **Optional.** The host's address. Defaults to "$address$" if the host's `address` attribute is set, "$address6$" otherwise.
1276 snmp_nocrypt | **Optional.** Define SNMP encryption. If set **snmp_v3** needs to be set. Defaults to false.
1277 snmp_community | **Optional.** The SNMP community. Defaults to "public".
1278 snmp_port | **Optional.** The SNMP port connection.
1279 snmp_v2 | **Optional.** SNMP version to 2c. Defaults to false.
1280 snmp_v3 | **Optional.** SNMP version to 3. Defaults to false.
1281 snmp_login | **Optional.** SNMP version 3 username. Defaults to "snmpuser".
1282 snmp_password | **Required.** SNMP version 3 password. No value defined as default.
1283 snmp_v3_use_privpass | **Optional.** Define to use SNMP version 3 priv password. Defaults to false.
1284 snmp_authprotocol | **Optional.** SNMP version 3 authentication protocol. Defaults to "md5,des".
1285 snmp_privpass | **Required.** SNMP version 3 priv password. No value defined as default.
1286 snmp_warn | **Optional.** The warning threshold. Change the `snmp_load_type` var to "netsl" for using 3 values.
1287 snmp_crit | **Optional.** The critical threshold. Change the `snmp_load_type` var to "netsl" for using 3 values.
1288 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.
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-memory"></a> snmp-memory
1294 Check command object for the [check_snmp_mem.pl](http://nagios.manubulon.com/snmp_mem.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_is_cisco | **Optional.** Change OIDs for Cisco switches. Defaults to false.
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="plugin-check-command-snmp-storage"></a> snmp-storage
1319 Check command object for the [check_snmp_storage.pl](http://nagios.manubulon.com/snmp_storage.html) plugin.
1321 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
1324 ------------------------|--------------
1325 snmp_address | **Optional.** The host's address. Defaults to "$address$" if the host's `address` attribute is set, "$address6$" otherwise.
1326 snmp_nocrypt | **Optional.** Define SNMP encryption. If set **snmp_v3** needs to be set. Defaults to false.
1327 snmp_community | **Optional.** The SNMP community. Defaults to "public".
1328 snmp_port | **Optional.** The SNMP port connection.
1329 snmp_v2 | **Optional.** SNMP version to 2c. Defaults to false.
1330 snmp_v3 | **Optional.** SNMP version to 3. Defaults to false.
1331 snmp_login | **Optional.** SNMP version 3 username. Defaults to "snmpuser".
1332 snmp_password | **Required.** SNMP version 3 password. No value defined as default.
1333 snmp_v3_use_privpass | **Optional.** Define to use SNMP version 3 priv password. Defaults to false.
1334 snmp_authprotocol | **Optional.** SNMP version 3 authentication protocol. Defaults to "md5,des".
1335 snmp_privpass | **Required.** SNMP version 3 priv password. No value defined as default.
1336 snmp_warn | **Optional.** The warning threshold.
1337 snmp_crit | **Optional.** The critical threshold.
1338 snmp_storage_name | **Optional.** Storage name. Default to regex "^/$$". More options available in the [snmp storage](http://nagios.manubulon.com/snmp_storage.html) documentation.
1339 snmp_perf | **Optional.** Enable perfdata values. Defaults to true.
1340 snmp_timeout | **Optional.** The command timeout in seconds. Defaults to 5 seconds.
1342 ## <a id="plugin-check-command-snmp-interface"></a> snmp-interface
1344 Check command object for the [check_snmp_int.pl](http://nagios.manubulon.com/snmp_int.html) plugin.
1346 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
1349 ----------------------------|--------------
1350 snmp_address | **Optional.** The host's address. Defaults to "$address$" if the host's `address` attribute is set, "$address6$" otherwise.
1351 snmp_nocrypt | **Optional.** Define SNMP encryption. If set **snmp_v3** needs to be set. Defaults to false.
1352 snmp_community | **Optional.** The SNMP community. Defaults to "public".
1353 snmp_port | **Optional.** The SNMP port connection.
1354 snmp_v2 | **Optional.** SNMP version to 2c. Defaults to false.
1355 snmp_v3 | **Optional.** SNMP version to 3. Defaults to false.
1356 snmp_login | **Optional.** SNMP version 3 username. Defaults to "snmpuser".
1357 snmp_password | **Required.** SNMP version 3 password. No value defined as default.
1358 snmp_v3_use_privpass | **Optional.** Define to use SNMP version 3 priv password. Defaults to false.
1359 snmp_authprotocol | **Optional.** SNMP version 3 authentication protocol. Defaults to "md5,des".
1360 snmp_privpass | **Required.** SNMP version 3 priv password. No value defined as default.
1361 snmp_warn | **Optional.** The warning threshold.
1362 snmp_crit | **Optional.** The critical threshold.
1363 snmp_interface | **Optional.** Network interface name. Default to regex "eth0".
1364 snmp_interface_perf | **Optional.** Check the input/ouput bandwidth of the interface. Defaults to true.
1365 snmp_interface_label | **Optional.** Add label before speed in output: in=, out=, errors-out=, etc...
1366 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.
1367 snmp_interface_percent | **Optional.** Output performance data in % of max speed. Defaults to false.
1368 snmp_interface_kbits | **Optional.** Make the warning and critical levels in KBits/s. Defaults to true.
1369 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.
1370 snmp_interface_64bit | **Optional.** Use 64 bits counters instead of the standard counters when checking bandwidth & performance data for interface >= 1Gbps. Defaults to false.
1371 snmp_interface_errors | **Optional.** Add error & discard to Perfparse output. Defaults to true.
1372 snmp_interface_noregexp | **Optional.** Do not use regexp to match interface name in description OID. Defaults to false.
1373 snmp_interface_delta | **Optional.** Delta time of perfcheck. Defaults to "300" (5 min).
1374 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.
1375 snmp_perf | **Optional.** Enable perfdata values. Defaults to true.
1376 snmp_timeout | **Optional.** The command timeout in seconds. Defaults to 5 seconds.
1378 ## <a id="plugin-check-command-snmp-process"></a> snmp-process
1380 Check command object for the [check_snmp_process.pl](http://nagios.manubulon.com/snmp_process.html) plugin.
1382 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
1385 ------------------------|--------------
1386 snmp_address | **Optional.** The host's address. Defaults to "$address$" if the host's `address` attribute is set, "$address6$" otherwise.
1387 snmp_nocrypt | **Optional.** Define SNMP encryption. If set **snmp_v3** needs to be set. Defaults to false.
1388 snmp_community | **Optional.** The SNMP community. Defaults to "public".
1389 snmp_port | **Optional.** The SNMP port connection.
1390 snmp_v2 | **Optional.** SNMP version to 2c. Defaults to false.
1391 snmp_v3 | **Optional.** SNMP version to 3. Defaults to false.
1392 snmp_login | **Optional.** SNMP version 3 username. Defaults to "snmpuser".
1393 snmp_password | **Required.** SNMP version 3 password. No value defined as default.
1394 snmp_v3_use_privpass | **Optional.** Define to use SNMP version 3 priv password. Defaults to false.
1395 snmp_authprotocol | **Optional.** SNMP version 3 authentication protocol. Defaults to "md5,des".
1396 snmp_privpass | **Required.** SNMP version 3 priv password. No value defined as default..
1397 snmp_warn | **Optional.** The warning threshold.
1398 snmp_crit | **Optional.** The critical threshold.
1399 snmp_process_name | **Optional.** Name of the process (regexp). No trailing slash!. Defaults to ".*".
1400 snmp_perf | **Optional.** Enable perfdata values. Defaults to true.
1401 snmp_timeout | **Optional.** The command timeout in seconds. Defaults to 5 seconds.
1403 # <a id="plugins-contrib"></a> Plugins Contrib
1405 The Plugins contrib collects various contributed command definitions.
1407 These check commands assume that the global constant named `PluginContribDir`
1408 is set to the path where the user installs custom plugins and can be enabled by uncommenting the corresponding line in icinga2.conf.
1410 ## <a id="plugins-contrib-databases"></a> Databases
1412 All database plugins go in this category.
1414 ### <a id="plugins-contrib-command-mssql_health"></a> mssql_health
1416 The plugin `mssql_health` utilises Perl DBD::Sybase based on FreeTDS to connect to MSSQL databases for monitoring.
1417 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).
1419 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
1422 ---------------------------------|------------------------------------------------------------------------------------------------------------------------------
1423 mssql_health_hostname | **Optional.** Specifies the database hostname or address. No default because you typically use "mssql_health_server".
1424 mssql_health_port | **Optional.** Specifies the database port. No default because you typically use "mssql_health_server".
1425 mssql_health_server | **Optional.** The name of a predefined connection (in freetds.conf).
1426 mssql_health_currentdb | **Optional.** The name of a database which is used as the current database for the connection.
1427 mssql_health_username | **Optional.** The username for the database connection.
1428 mssql_health_password | **Optional.** The password for the database connection.
1429 mssql_health_warning | **Optional.** The warning threshold depending on the mode.
1430 mssql_health_critical | **Optional.** The critical threshold depending on the mode.
1431 mssql_health_mode | **Required.** The mode uses predefined keywords for the different checks. For example "connection-time", "database-free" or "sql".
1432 mssql_health_name | **Optional.** Depending on the mode this could be the database name or a SQL statement.
1433 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.
1434 mssql_health_regexp | **Optional.** If set to true, "mssql_health_name" will be interpreted as a regular expression. Defaults to false.
1435 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".
1436 mssql_health_offlineok | **Optional.** Set this to true, if offline databases are perfectly ok for you. Defaults to false.
1437 mssql_health_commit | **Optional.** Set this to true to turn on autocommit for the dbd::sybase module. Defaults to false.
1439 ### <a id="plugins-contrib-command-mysql_health"></a> mysql_health
1441 The plugin `mysql_health` utilises Perl DBD::MySQL to connect to MySQL databases for monitoring.
1442 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).
1444 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
1447 ---------------------------------|------------------------------------------------------------------------------------------------------------------------------
1448 mysql_health_hostname | **Required.** Specifies the database hostname or address. Defaults to "$address$" or "$address6$" if the `address` attribute is not set.
1449 mysql_health_port | **Optional.** Specifies the database port. Defaults to 3306 (or 1186 for "mysql_health_mode" cluster).
1450 mysql_health_socket | **Optional.** Specifies the database unix socket. No default.
1451 mysql_health_username | **Optional.** The username for the database connection.
1452 mysql_health_password | **Optional.** The password for the database connection.
1453 mysql_health_database | **Optional.** The database to connect to. Defaults to information_schema.
1454 mysql_health_warning | **Optional.** The warning threshold depending on the mode.
1455 mysql_health_critical | **Optional.** The critical threshold depending on the mode.
1456 mysql_health_mode | **Required.** The mode uses predefined keywords for the different checks. For example "connection-time", "slave-lag" or "sql".
1457 mysql_health_name | **Optional.** The SQL statement to be executed with "mysql_health_mode" sql.
1458 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.
1459 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".
1460 mysql_health_labelformat | **Optional.** One of those formats pnp4nagios or groundwork. Defaults to pnp4nagios.
1462 ### <a id="plugins-contrib-command-oracle_health"></a> oracle_health
1464 The plugin `oracle_health` utilises Perl DBD::Oracle based on oracle-instantclient-sdk or sqlplus to connect to Oracle databases for monitoring.
1465 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).
1467 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
1470 ---------------------------------|------------------------------------------------------------------------------------------------------------------------------
1471 oracle_health_connect | **Required.** Specifies the database connection string (from tnsnames.ora).
1472 oracle_health_username | **Optional.** The username for the database connection.
1473 oracle_health_password | **Optional.** The password for the database connection.
1474 oracle_health_warning | **Optional.** The warning threshold depending on the mode.
1475 oracle_health_critical | **Optional.** The critical threshold depending on the mode.
1476 oracle_health_mode | **Required.** The mode uses predefined keywords for the different checks. For example "connection-time", "flash-recovery-area-usage" or "sql".
1477 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.
1478 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.
1479 oracle_health_regexp | **Optional.** If set to true, "oracle_health_name" will be interpreted as a regular expression. Defaults to false.
1480 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".
1481 oracle_health_ident | **Optional.** If set to true outputs instance and database names. Defaults to false.
1482 oracle_health_commit | **Optional.** Set this to true to turn on autocommit for the dbd::oracle module. Defaults to false.
1483 oracle_health_noperfdata | **Optional.** Set this to true if you want to disable perfdata. Defaults to false.
1488 --------------------|------------------------------------------------------------------------------------------------------------------------------------------
1489 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".
1490 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".
1492 ### <a id="plugins-contrib-command-postgres"></a> postgres
1494 The plugin `postgres` utilises the psql binary to connect to PostgreSQL databases for monitoring.
1495 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).
1497 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
1500 ---------------------------------|------------------------------------------------------------------------------------------------------------------------------
1501 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.
1502 postgres_port | **Optional.** Specifies the database port. Defaults to 5432.
1503 postgres_dbname | **Optional.** Specifies the database name to connect to. Defaults to "postgres" or "template1".
1504 postgres_dbuser | **Optional.** The username for the database connection. Defaults to "postgres".
1505 postgres_dbpass | **Optional.** The password for the database connection. You can use a .pgpass file instead.
1506 postgres_dbservice | **Optional.** Specifies the service name to use inside of pg_service.conf.
1507 postgres_warning | **Optional.** Specifies the warning threshold, range depends on the action.
1508 postgres_critical | **Optional.** Specifies the critical threshold, range depends on the action.
1509 postgres_include | **Optional.** Specifies name(s) items to specifically include (e.g. tables), depends on the action.
1510 postgres_exclude | **Optional.** Specifies name(s) items to specifically exclude (e.g. tables), depends on the action.
1511 postgres_includeuser | **Optional.** Include objects owned by certain users.
1512 postgres_excludeuser | **Optional.** Exclude objects owned by certain users.
1513 postgres_standby | **Optional.** Assume that the server is in continious WAL recovery mode if set to true. Defaults to false.
1514 postgres_production | **Optional.** Assume that the server is in production mode if set to true. Defaults to false.
1515 postgres_action | **Required.** Determines the test executed.
1516 postgres_unixsocket | **Optional.** If "postgres_unixsocket" is set to true the unix socket is used instead of an address. Defaults to false.
1518 ### <a id="plugins-contrib-command-mongodb"></a> mongodb
1520 The plugin `mongodb` utilises Python PyMongo.
1521 For development check [https://github.com](https://github.com/mzupan/nagios-plugin-mongodb).
1523 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
1526 ---------------------------------|------------------------------------------------------------------------------------------------------------------------------
1527 mongodb_host | **Required.** Specifies the hostname or address.
1528 mongodb_port | **Required.** The port mongodb is runnung on.
1529 mongodb_user | **Optional.** The username you want to login as
1530 mongodb_passwd | **Optional.** The password you want to use for that user
1531 mongodb_warning | **Optional.** The warning threshold we want to set
1532 mongodb_critical | **Optional.** The critical threshold we want to set
1533 mongodb_action | **Required.** The action you want to take
1534 mongodb_maxlag | **Optional.** Get max replication lag (for replication_lag action only)
1535 mongodb_mappedmemory | **Optional.** Get mapped memory instead of resident (if resident memory can not be read)
1536 mongodb_perfdata | **Optional.** Enable output of Nagios performance data
1537 mongodb_database | **Optional.** Specify the database to check
1538 mongodb_alldatabases | **Optional.** Check all databases (action database_size)
1539 mongodb_ssl | **Optional.** Connect using SSL
1540 mongodb_replicaset | **Optional.** Connect to replicaset
1541 mongodb_querytype | **Optional.** The query type to check [query|insert|update|delete|getmore|command] from queries_per_second
1542 mongodb_collection | **Optional.** Specify the collection to check
1543 mongodb_sampletime | **Optional.** Time used to sample number of pages faults
1545 ### <a id="plugins-contrib-command-elasticsearch"></a> elasticsearch
1547 An [ElasticSearch](https://www.elastic.co/products/elasticsearch) availability
1548 and performance monitoring plugin available for download at [GitHub](https://github.com/anchor/nagios-plugin-elasticsearch).
1549 The plugin requires the HTTP API enabled on your ElasticSearch node.
1552 -----------------------------|-------------------------------------------------------------------------------------------------------
1553 elasticsearch_failuredomain | **Optional.** A comma-separated list of ElasticSearch attributes that make up your cluster's failure domain.
1554 elasticsearch_host | **Optional.** Hostname or network address to probe. Defaults to 'localhost'.
1555 elasticsearch_masternodes | **Optional.** Issue a warning if the number of master-eligible nodes in the cluster drops below this number. By default, do not monitor the number of nodes in the cluster.
1556 elasticsearch_port | **Optional.** TCP port to probe. The ElasticSearch API should be listening here. Defaults to 9200.
1557 elasticsearch_prefix | **Optional.** Optional prefix (e.g. 'es') for the ElasticSearch API. Defaults to ''.
1558 elasticsearch_yellowcritical | **Optional.** Instead of issuing a 'warning' for a yellow cluster state, issue a 'critical' alert. Defaults to false.
1560 ### <a id="plugins-contrib-command-redis"></a> redis
1562 The plugin `redis` can measure response time, hitrate, memory utilization, check replication sync and more. It can also test data in a specified key (if necessary doing average or sum on range).
1563 It is provided by `William Leibzon` at [https://github.com](https://github.com/willixix/naglio-plugins/blob/master/check_redis.pl).
1566 -------------------------|--------------------------------------------------------------------------------------------------------------
1567 redis_hostname | **Required.** Hostname or IP Address to check. Defaults to "127.0.0.1".
1568 redis_port | **Optional.** Port number to query. Default to "6379".
1569 redis_database | **Optional.** Database name (usually a number) to query, needed for **redis_query**.
1570 redis_password | **Optional.** Password for Redis authentication. Safer alternative is to put them in a file and use **redis_credentials**.
1571 redis_credentials | **Optional.** Credentials file to read for Redis authentication.
1572 redis_timeout | **Optional.** Allows to set timeout for execution of this plugin.
1573 redis_variables | **Optional.** List of variables from info data to do threshold checks on.
1574 redis_warn | **Optional.** This option can only be used if **redis_variables** is used and the number of values listed here must exactly match number of variables specified.
1575 redis_crit | **Optional.** This option can only be used if **redis_variables** is used and the number of values listed here must exactly match number of variables specified.
1576 redis_perfparse | **Optional.** This should only be used with variables and causes variable data not only to be printed as part of main status line but also as perfparse compatible output. Defaults to false.
1577 redis_perfvars | **Optional.** This allows to list variables which values will go only into perfparse output (and not for threshold checking).
1578 redis_prev_perfdata | **Optional.** If set to true previous performance data are used to calculate rate of change for counter statistics variables and for proper calculation of hitrate. Defaults to false.
1579 redis_rate_label | **Optional.** Prefix or Suffix label used to create a new variable which has rate of change of another base variable. You can specify PREFIX or SUFFIX or both as one string separated by ",". Default if not specified is suffix "_rate".
1580 redis_query | **Optional.** Option specifies key to query and optional variable name to assign the results to after.
1581 redis_option | **Optional.** Specifiers are separated by "," and must include NAME or PATTERN.
1582 redis_response_time | **Optional.** If this is used plugin will measure and output connection response time in seconds. With **redis_perfparse** this would also be provided on perf variables.
1583 redis_hitrate | **Optional.** Calculates Hitrate and specify values are interpreted as WARNING and CRITICAL thresholds.
1584 redis_memory_utilization | **Optional.** This calculates percent of total memory on system used by redis. Total_memory on server must be specified with **redis_total_memory**. If you specify by itself, the plugin will just output this info. Parameter values are interpreted as WARNING and CRITICAL thresholds.
1585 redis_total_memory | **Optional.** Amount of memory on a system for memory utilization calculation. Use system memory or max_memory setting of redis.
1586 redis_replication_delay | **Optional.** Allows to set threshold on replication delay info.
1588 ## <a id="plugins-contrib-ipmi"></a> IPMI Devices
1590 This category includes all plugins for IPMI devices.
1592 ### <a id="plugins-contrib-command-ipmi-sensor"></a> ipmi-sensor
1594 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.
1596 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
1599 ---------------------------------|-----------------------------------------------------------------------------------------------------
1600 ipmi_address | **Required.** Specifies the remote host (IPMI device) to check. Defaults to "$address$".
1601 ipmi_config_file | **Optional.** Path to the FreeIPMI configuration file. It should contain IPMI username, IPMI password, and IPMI privilege-level.
1602 ipmi_username | **Optional.** The IPMI username.
1603 ipmi_password | **Optional.** The IPMI password.
1604 ipmi_privilege_level | **Optional.** The IPMI privilege level of the IPMI user.
1605 ipmi_backward_compatibility_mode | **Optional.** Enable backward compatibility mode, useful for FreeIPMI 0.5.* (this omits FreeIPMI options "--quiet-cache" and "--sdr-cache-recreate").
1606 ipmi_sensor_type | **Optional.** Limit sensors to query based on IPMI sensor type. Examples for IPMI sensor types are 'Fan', 'Temperature' and 'Voltage'.
1607 ipmi_exclude_sensor_id | **Optional.** Exclude sensor matching ipmi_sensor_id.
1608 ipmi_sensor_id | **Optional.** Include sensor matching ipmi_sensor_id.
1609 ipmi_protocal_lan_version | **Optional.** Change the protocol LAN version. Defaults to "LAN_2_0".
1610 ipmi_number_of_active_fans | **Optional.** Number of fans that should be active. Otherwise a WARNING state is returned.
1611 ipmi_show_fru | **Optional.** Print the product serial number if it is available in the IPMI FRU data.
1612 ipmi_no_sel_checking | **Optional.** Turn off system event log checking via ipmi-sel.
1614 ## <a id="plugins-contrib-network-components"></a> Network Components
1616 This category includes all plugins for various network components like routers, switches and firewalls.
1618 ### <a id="plugins-contrib-command-interfacetable"></a> interfacetable
1620 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).
1622 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
1625 ------------------------------------|-----------------------------------------------------------------------------------------------------
1626 interfacetable_hostquery | **Required.** Specifies the remote host to poll. Defaults to "$address$".
1627 interfacetable_hostdisplay | **Optional.** Specifies the hostname to display in the HTML link. Defaults to "$host.display_name$".
1628 interfacetable_regex | **Optional.** Interface names and property names for some other options will be interpreted as regular expressions. Defaults to false.
1629 interfacetable_outputshort | **Optional.** Reduce the verbosity of the plugin output. Defaults to false.
1630 interfacetable_exclude | **Optional.** Comma separated list of interfaces globally excluded from the monitoring.
1631 interfacetable_include | **Optional.** Comma separated list of interfaces globally included in the monitoring.
1632 interfacetable_aliasmatching | **Optional.** Allow you to specify alias in addition to interface names. Defaults to false.
1633 interfacetable_excludetraffic | **Optional.** Comma separated list of interfaces excluded from traffic checks.
1634 interfacetable_includetraffic | **Optional.** Comma separated list of interfaces included for traffic checks.
1635 interfacetable_warningtraffic | **Optional.** Interface traffic load percentage leading to a warning alert.
1636 interfacetable_criticaltraffic | **Optional.** Interface traffic load percentage leading to a critical alert.
1637 interfacetable_pkt | **Optional.** Add unicast/non-unicast pkt stats for each interface.
1638 interfacetable_trackproperty | **Optional.** List of tracked properties.
1639 interfacetable_excludeproperty | **Optional.** Comma separated list of interfaces excluded from the property tracking.
1640 interfacetable_includeproperty | **Optional.** Comma separated list of interfaces included in the property tracking.
1641 interfacetable_community | **Optional.** Specifies the snmp v1/v2c community string. Defaults to "public" if using snmp v1/v2c, ignored using v3.
1642 interfacetable_snmpv2 | **Optional.** Use snmp v2c. Defaults to false.
1643 interfacetable_login | **Optional.** Login for snmpv3 authentication.
1644 interfacetable_passwd | **Optional.** Auth password for snmpv3 authentication.
1645 interfacetable_privpass | **Optional.** Priv password for snmpv3 authentication.
1646 interfacetable_protocols | **Optional.** Authentication protocol,Priv protocol for snmpv3 authentication.
1647 interfacetable_domain | **Optional.** SNMP transport domain.
1648 interfacetable_contextname | **Optional.** Context name for the snmp requests.
1649 interfacetable_port | **Optional.** SNMP port. Defaults to standard port.
1650 interfacetable_64bits | **Optional.** Use SNMP 64-bits counters. Defaults to false.
1651 interfacetable_maxrepetitions | **Optional.** Increasing this value may enhance snmp query performances by gathering more results at one time.
1652 interfacetable_snmptimeout | **Optional.** Define the Transport Layer timeout for the snmp queries.
1653 interfacetable_snmpretries | **Optional.** Define the number of times to retry sending a SNMP message.
1654 interfacetable_unixsnmp | **Optional.** Use unix snmp utilities for snmp requests. Defaults to false, which means use the perl bindings.
1655 interfacetable_enableperfdata | **Optional.** Enable port performance data. Defaults to false.
1656 interfacetable_perfdataformat | **Optional.** Define which performance data will be generated. Possible values are "full" (default), "loadonly", "globalonly".
1657 interfacetable_perfdatathreshold | **Optional.** Define which thresholds are printed in the generated performance data. Possible values are "full" (default), "loadonly", "globalonly".
1658 interfacetable_perfdatadir | **Optional.** When specified, the performance data are also written directly to a file, in the specified location.
1659 interfacetable_perfdataservicedesc | **Optional.** Specify additional parameters for output performance data to PNP. Defaults to "$service.name$", only affects **interfacetable_perfdatadir**.
1660 interfacetable_grapher | **Optional.** Specify the used graphing solution. Possible values are "pnp4nagios" (default), "nagiosgrapher", "netwaysgrapherv2" and "ingraph".
1661 interfacetable_grapherurl | **Optional.** Graphing system url. Default depends on **interfacetable_grapher**.
1662 interfacetable_portperfunit | **Optional.** Traffic could be reported in bits (counters) or in bps (calculated value).
1663 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".
1664 interfacetable_duplex | **Optional.** Add the duplex mode property for each interface in the interface table. Defaults to false.
1665 interfacetable_stp | **Optional.** Add the stp state property for each interface in the interface table. Defaults to false.
1666 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"
1667 interfacetable_noipinfo | **Optional.** Remove the ip information for each interface from the interface table. Defaults to false.
1668 interfacetable_alias | **Optional.** Add the alias information for each interface in the interface table. Defaults to false.
1669 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.
1670 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.
1671 interfacetable_delta | **Optional.** Set the delta used for interface throuput calculation in seconds.
1672 interfacetable_ifs | **Optional.** Input field separator. Defaults to ",".
1673 interfacetable_cache | **Optional.** Define the retention time of the cached data in seconds.
1674 interfacetable_noifloadgradient | **Optional.** Disable color gradient from green over yellow to red for the load percentage. Defaults to false.
1675 interfacetable_nohuman | **Optional.** Do not translate bandwidth usage in human readable format. Defaults to false.
1676 interfacetable_snapshot | **Optional.** Force the plugin to run like if it was the first launch. Defaults to false.
1677 interfacetable_timeout | **Optional.** Define the global timeout limit of the plugin in seconds. Defaults to "15s".
1678 interfacetable_css | **Optional.** Define the css stylesheet used by the generated html files. Possible values are "classic", "icinga", "icinga-alternate1" or "nagiosxi".
1679 interfacetable_config | **Optional.** Specify a config file to load.
1680 interfacetable_noconfigtable | **Optional.** Disable configuration table on the generated HTML page. Defaults to false.
1681 interfacetable_notips | **Optional.** Disable the tips in the generated html tables. Defaults to false.
1682 interfacetable_defaulttablesorting | **Optional.** Default table sorting can be "index" (default) or "name".
1683 interfacetable_tablesplit | **Optional.** Generate multiple interface tables, one per interface type. Defaults to false.
1684 interfacetable_notype | **Optional.** Remove the interface type for each interface. Defaults to false.
1686 ### <a id="plugins-contrib-command-iftraffic"></a> iftraffic
1688 The plugin [check_iftraffic](https://exchange.icinga.org/exchange/iftraffic)
1689 checks the utilization of a given interface name using the SNMP protocol.
1691 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
1694 ------------------------|---------------------------------------------------------
1695 iftraffic_address | **Required.** Specifies the remote host. Defaults to "$address$".
1696 iftraffic_community | **Optional.** SNMP community. Defaults to "public'" if omitted.
1697 iftraffic_interface | **Required.** Queried interface name.
1698 iftraffic_bandwidth | **Required.** Interface maximum speed in kilo/mega/giga/bits per second.
1699 iftraffic_units | **Optional.** Interface units can be one of these values: `g` (gigabits/s),`m` (megabits/s), `k` (kilobits/s),`b` (bits/s)
1700 iftraffic_warn | **Optional.** Percent of bandwidth usage necessary to result in warning status (defaults to `85%`).
1701 iftraffic_crit | **Optional.** Percent of bandwidth usage necessary to result in critical status (defaults to `98%`).
1702 iftraffic_max_counter | **Optional.** Maximum counter value of net devices in kilo/mega/giga/bytes.
1704 ### <a id="plugins-contrib-command-interfaces"></a> interfaces
1706 The plugin [check_interfaces](https://www.netways.org/projects/check-interfaces)
1707 Check interfaces and utilization.
1709 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
1712 --------------------------|---------------------------------------------------------
1713 interfaces_address | **Optional.** The host's address. Defaults to "$address$" if the host's `address` attribute is set, "$address6$" otherwise.
1714 interfaces_regex | **Optional.** Interface list regexp.
1715 interfaces_exclude_regex | **Optional.** Interface list negative regexp.
1716 interfaces_errors | **Optional.** Number of in errors (CRC errors for cisco) to consider a warning (default 50).
1717 interface_out_errors | **Optional.** Number of out errors (collisions for cisco) to consider a warning (default same as in errors).
1718 interfaces_perfdata | **Optional.** perfdata from last check result.
1719 interfaces_prefix | **Optional.** Prefix interface names with this label.
1720 interfaces_lastcheck | **Optional.** Last checktime (unixtime).
1721 interfaces_bandwidth | **Optional.** Bandwidth warn level in percent.
1722 interfaces_speed | **Optional.** Override speed detection with this value (bits per sec).
1723 interfaces_trim | **Optional.** Cut this number of characters from the start of interface descriptions.
1724 interfaces_mode | **Optional.** Special operating mode (default,cisco,nonbulk,bintec).
1725 interfaces_auth_proto | **Optional.** SNMPv3 Auth Protocol (SHA|MD5)
1726 interfaces_auth_phrase | **Optional.** SNMPv3 Auth Phrase
1727 interfaces_priv_proto | **Optional.** SNMPv3 Privacy Protocol (AES|DES)
1728 interfaces_priv_phrase | **Optional.** SNMPv3 Privacy Phrase
1729 interfaces_user | **Optional.** SNMPv3 User
1730 interfaces_down_is_ok | **Optional.** Disables critical alerts for down interfaces.
1731 interfaces_aliases | **Optional.** Retrieves the interface description.
1732 interfaces_match_aliases | **Optional.** Also match against aliases (Option --aliases automatically enabled).
1733 interfaces_timeout | **Optional.** Sets the SNMP timeout (in ms).
1734 interfaces_sleep | **Optional.** Sleep between every SNMP query (in ms).
1736 ## <a id="plugins-contrib-web"></a> Web
1738 This category includes all plugins for web-based checks.
1740 ### <a id="plugin-check-command-webinject"></a> webinject
1742 Check command object for the [check_webinject](http://http://www.webinject.org/manual.html) plugin.
1744 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
1747 ------------------------|--------------
1748 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.
1749 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.
1750 webinject_no_output | **Optional.** Suppresses all output to STDOUT except the results summary.
1751 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.
1752 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.
1753 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.
1755 ### <a id="plugin-check-command-jmx4perl"></a> jmx4perl
1757 The plugin `jmx4perl` utilizes the api provided by the jolokia web application to query java message beans on an application server. It is part of the perl module provided by Roland Huß on [cpan](http://search.cpan.org/~roland/jmx4perl/) including a detailed [documentation](http://search.cpan.org/~roland/jmx4perl/scripts/check_jmx4perl) containing installation tutorial, security advices und usage examples.
1759 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
1762 -----------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------
1763 jmx4perl_url | **Required.** URL to agent web application. Defaults to "http://$address$:8080/jolokia".
1764 jmx4perl_product | **Optional.** Name of app server product (e.g. jboss), by default is uses an autodetection facility.
1765 jmx4perl_alias | **Optional.** Alias name for attribute (e.g. MEMORY_HEAP_USED). All availables aliases can be viewed by executing `jmx4perl aliases` on the command line.
1766 jmx4perl_mbean | **Optional.** MBean name (e.g. java.lang:type=Memory).
1767 jmx4perl_attribute | **Optional.** Attribute name (e.g. HeapMemoryUsage).
1768 jmx4perl_operation | **Optional.** Operation to execute.
1769 jmx4perl_value | **Optional.** Shortcut for specifying mbean/attribute/path. Slashes within names must be escaped with backslash.
1770 jmx4perl_delta | **Optional.** Switches on incremental mode. Optional argument are seconds used for normalizing.
1771 jmx4perl_path | **Optional.** Inner path for extracting a single value from a complex attribute or return value (e.g. used).
1772 jmx4perl_target | **Optional.** JSR-160 Service URL specifing the target server.
1773 jmx4perl_target_user | **Optional.** Username to use for JSR-160 connection.
1774 jmx4perl_target_password | **Optional.** Password to use for JSR-160 connection.
1775 jmx4perl_proxy | **Optional.** Proxy to use.
1776 jmx4perl_user | **Optional.** User for HTTP authentication.
1777 jmx4perl_password | **Optional.** Password for HTTP authentication.
1778 jmx4perl_name | **Optional.** Name to use for output, by default a standard value based on the MBean and attribute will be used.
1779 jmx4perl_method | **Optional.** HTTP method to use, either get or post. By default a method is determined automatically based on the request type.
1780 jmx4perl_base | **Optional.** Base name, which when given, interprets critical and warning values as relative in the range 0 .. 100%. Must be given in the form mbean/attribute/path.
1781 jmx4perl_base_mbean | **Optional.** Base MBean name, interprets critical and warning values as relative in the range 0 .. 100%. Requires "jmx4perl_base_attribute".
1782 jmx4perl_base_attribute | **Optional.** Base attribute for a relative check. Requires "jmx4perl_base_mbean".
1783 jmx4perl_base_path | **Optional.** Base path for relative checks, where this path is used on the base attribute's value.
1784 jmx4perl_unit | **Optional.** Unit of measurement of the data retreived. Recognized values are [B|KB|MN|GB|TB] for memory values and [us|ms|s|m|h|d] for time values.
1785 jmx4perl_null | **Optional.** Value which should be used in case of a null return value of an operation or attribute. Defaults to null.
1786 jmx4perl_string | **Optional.** Force string comparison for critical and warning checks. Defaults to false.
1787 jmx4perl_numeric | **Optional.** Force numeric comparison for critical and warning checks. Defaults to false.
1788 jmx4perl_critical | **Optional.** Critical threshold for value.
1789 jmx4perl_warning | **Optional.** Warning threshold for value.
1790 jmx4perl_label | **Optional.** Label to be used for printing out the result of the check. For placeholders which can be used see the documentation.
1791 jmx4perl_perfdata | **Optional.** Whether performance data should be omitted, which are included by default. Defaults to "on" for numeric values, to "off" for strings.
1792 jmx4perl_unknown_is_critical | **Optional.** Map UNKNOWN errors to errors with a CRITICAL status. Defaults to false.
1793 jmx4perl_timeout | **Optional.** Seconds before plugin times out. Defaults to "15".
1796 ## <a id="plugins-contrib-operating-system"></a> Operating System
1798 In this category you can find plugins for gathering information about your operating system or the system beneath like memory usage.
1800 ### <a id="plugins-contrib-command-mem"></a> mem
1802 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).
1804 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
1807 -------------|-----------------------------------------------------------------------------------------------------------------------
1808 mem_used | **Optional.** Tell the plugin to check for used memory in opposite of **mem_free**. Must specify one of these as true.
1809 mem_free | **Optional.** Tell the plugin to check for free memory in opposite of **mem_used**. Must specify one of these as true.
1810 mem_cache | **Optional.** If set to true plugin will count cache as free memory. Defaults to false.
1811 mem_warning | **Required.** Specifiy the warning threshold as number interpreted as percent.
1812 mem_critical | **Required.** Specifiy the critical threshold as number interpreted as percent.
1814 ### <a id="plugin-contrib-command-running-kernel"></a> running_kernel
1816 Check command object for the `check_running_kernel` plugin
1817 provided by the `nagios-plugins-contrib` package on Debian.
1819 The `running_kernel` check command does not support any vars.
1821 ### <a id="plugin-contrib-command-yum"></a> yum
1823 The plugin `yum` is used to check the YUM package management system for package updates. To differentiate between security and normal updates it requires the YUM security plugin installed. It is provied by `Christoph Anton Mitterer` on [https://github.com](https://github.com/calestyo/check_yum).
1825 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
1828 ------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
1829 yum_all_updates | **Optional.** Set to true to not distinguish between security and non-security updates, but returns critical for any available update. This may be used if the YUM security plugin is absent or you want to maintain every single package at the latest version. You may want to use **yum_warn_on_any_update** instead of this option. Defaults to false.
1830 yum_warn_on_any_update | **Optional.** Set to true to warn if there are any (non-security) package updates available. Defaults to false.
1831 yum_cache_only | **Optional.** If set to true plugin runs entirely from cache and does not update the cache when running YUM. Useful if you have `yum makecache` cronned. Defaults to false.
1832 yum_no_warn_on_lock | **Optional.** If set to true returns OK instead of WARNING when YUM is locked and fails to check for updates due to another instance running. Defaults to false.
1833 yum_no_warn_on_updates | **Optional.** If set to true returns OK instead of WARNING even when updates are available. The plugin output still shows the number of available updates. Defaults to false.
1834 yum_enablerepo | **Optional.** Explicitly enables a reposity when calling YUM. Can take a comma separated list of repositories. Note that enabling repositories can lead to unexpected results, for example when protected repositories are enabled.
1835 yum_disablerepo | **Optional.** Explicitly disables a reposity when calling YUM. Can take a comma separated list of repositories. Note that enabling repositories can lead to unexpected results, for example when protected repositories are enabled.
1836 yum_installroot | **Optional.** Specifies another installation root directory (for example a chroot).
1837 yum_timeout | **Optional.** Set a timeout in seconds after which the plugin will exit (defaults to 55 seconds).
1839 ## <a id="plugins-contrib-virtualization"></a> Virtualization
1841 This category includes all plugins for various virtualization technologies.
1843 ### <a id="plugins-contrib-command-esxi-hardware"></a> esxi_hardware
1845 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.
1847 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
1850 ------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
1851 esxi_hardware_host | **Required.** Specifies the host to monitor. Defaults to "$address$".
1852 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.
1853 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.
1854 esxi_hardware_vendor | **Optional.** Defines the vendor of the server: "auto", "dell", "hp", "ibm", "intel", "unknown" (default).
1855 esxi_hardware_html | **Optional.** Add web-links to hardware manuals for Dell servers (use your country extension). Only useful with **esxi_hardware_vendor** = dell.
1856 esxi_hardware_ignore | **Optional.** Comma separated list of elements to ignore.
1857 esxi_hardware_perfdata | **Optional.** Add performcedata for graphers like PNP4Nagios to the output. Defaults to false.
1858 esxi_hardware_nopower | **Optional.** Do not collect power performance data, when **esxi_hardware_perfdata** is set to true. Defaults to false.
1859 esxi_hardware_novolts | **Optional.** Do not collect voltage performance data, when **esxi_hardware_perfdata** is set to true. Defaults to false.
1860 esxi_hardware_nocurrent | **Optional.** Do not collect current performance data, when **esxi_hardware_perfdata** is set to true. Defaults to false.
1861 esxi_hardware_notemp | **Optional.** Do not collect temperature performance data, when **esxi_hardware_perfdata** is set to true. Defaults to false.
1862 esxi_hardware_nofan | **Optional.** Do not collect fan performance data, when **esxi_hardware_perfdata** is set to true. Defaults to false.
1864 # <a id="plugins-contrib-vmware"></a> VMware
1866 Check commands for the [check_vmware_esx](https://github.com/BaldMansMojo/check_vmware_esx) plugin.
1868 ## <a id="plugins-contrib-vmware-esx-dc-volumes"></a> vmware-esx-dc-volumes
1870 Check command object for the `check_vmware_esx` plugin. Shows all datastore volumes info.
1872 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
1875 ------------------------|--------------
1876 vmware_datacenter | **Required.** Datacenter/vCenter hostname.
1877 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
1878 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
1879 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
1880 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
1881 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
1882 vmware_sessionfile | **Optional.** Session file name enhancement.
1883 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
1884 vmware_nosession | **Optional.** No auth session - IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
1885 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
1886 vmware_password | **Optional.** The username's password. No value defined as default.
1887 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
1888 vmware_subselect | **Optional.** Volume name to be checked the free space.
1889 vmware_gigabyte | **Optional.** Output in GB instead of MB.
1890 vmware_usedspace | **Optional.** Output used space instead of free. Defaults to "false".
1891 vmware_alertonly | **Optional.** List only alerting volumes. Defaults to "false".
1892 vmware_exclude | **Optional.** Blacklist volumes name. No value defined as default.
1893 vmware_include | **Optional.** Whitelist volumes name. No value defined as default.
1894 vmware_isregexp | **Optional.** Treat blacklist and whitelist expressions as regexp.
1895 vmware_dc_volume_used | **Optional.** Output used space instead of free. Defaults to "true".
1896 vmware_warn | **Optional.** The warning threshold for volumes. Defaults to "80%".
1897 vmware_crit | **Optional.** The critical threshold for volumes. Defaults to "90%".
1900 ## <a id="plugins-contrib-vmware-esx-dc-runtime-info"></a> vmware-esx-dc-runtime-info
1902 Check command object for the `check_vmware_esx` plugin. Shows all runtime info for the datacenter/Vcenter.
1904 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
1907 ------------------------|--------------
1908 vmware_datacenter | **Required.** Datacenter/vCenter hostname.
1909 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
1910 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
1911 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
1912 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
1913 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
1914 vmware_sessionfile | **Optional.** Session file name enhancement.
1915 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
1916 vmware_nosession | **Optional.** No auth session - IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
1917 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
1918 vmware_password | **Optional.** The username's password. No value defined as default.
1919 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
1922 ## <a id="plugins-contrib-vmware-esx-dc-runtime-listvms"></a> vmware-esx-dc-runtime-listvms
1924 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.
1926 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
1929 ------------------------|--------------
1930 vmware_datacenter | **Required.** Datacenter/vCenter hostname.
1931 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
1932 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
1933 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
1934 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
1935 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
1936 vmware_sessionfile | **Optional.** Session file name enhancement.
1937 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
1938 vmware_nosession | **Optional.** No auth session - IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
1939 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
1940 vmware_password | **Optional.** The username's password. No value defined as default.
1941 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
1942 vmware_alertonly | **Optional.** List only alerting VMs. Important here to avoid masses of data.
1943 vmware_exclude | **Optional.** Blacklist VMs name. No value defined as default.
1944 vmware_include | **Optional.** Whitelist VMs name. No value defined as default.
1945 vmware_isregexp | **Optional.** Treat blacklist and whitelist expressions as regexp.
1946 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.
1949 ## <a id="plugins-contrib-vmware-esx-dc-runtime-listhost"></a> vmware-esx-dc-runtime-listhost
1951 Check command object for the `check_vmware_esx` plugin. List of VMware ESX hosts and their power state.
1953 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
1956 ------------------------|--------------
1957 vmware_datacenter | **Required.** Datacenter/vCenter hostname.
1958 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
1959 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
1960 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
1961 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
1962 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
1963 vmware_sessionfile | **Optional.** Session file name enhancement.
1964 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
1965 vmware_nosession | **Optional.** No auth session - IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
1966 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
1967 vmware_password | **Optional.** The username's password. No value defined as default.
1968 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
1969 vmware_alertonly | **Optional.** List only alerting hosts. Important here to avoid masses of data.
1970 vmware_exclude | **Optional.** Blacklist VMware ESX hosts. No value defined as default.
1971 vmware_include | **Optional.** Whitelist VMware ESX hosts. No value defined as default.
1972 vmware_isregexp | **Optional.** Treat blacklist and whitelist expressions as regexp.
1973 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.
1976 ## <a id="plugins-contrib-vmware-esx-dc-runtime-listcluster"></a> vmware-esx-dc-runtime-listcluster
1978 Check command object for the `check_vmware_esx` plugin. List of VMware clusters and their states.
1980 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
1983 ------------------------|--------------
1984 vmware_datacenter | **Required.** Datacenter/vCenter hostname.
1985 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
1986 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
1987 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
1988 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
1989 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
1990 vmware_sessionfile | **Optional.** Session file name enhancement.
1991 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
1992 vmware_nosession | **Optional.** No auth session - IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
1993 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
1994 vmware_password | **Optional.** The username's password. No value defined as default.
1995 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
1996 vmware_alertonly | **Optional.** List only alerting hosts. Important here to avoid masses of data.
1997 vmware_exclude | **Optional.** Blacklist VMware cluster. No value defined as default.
1998 vmware_include | **Optional.** Whitelist VMware cluster. No value defined as default.
1999 vmware_isregexp | **Optional.** Treat blacklist and whitelist expressions as regexp.
2000 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.
2003 ## <a id="plugins-contrib-vmware-esx-dc-runtime-issues"></a> vmware-esx-dc-runtime-issues
2005 Check command object for the `check_vmware_esx` plugin. All issues for the host.
2007 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
2010 ------------------------|--------------
2011 vmware_datacenter | **Required.** Datacenter/vCenter hostname.
2012 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
2013 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
2014 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
2015 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
2016 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
2017 vmware_sessionfile | **Optional.** Session file name enhancement.
2018 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
2019 vmware_nosession | **Optional.** No auth session - IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
2020 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
2021 vmware_password | **Optional.** The username's password. No value defined as default.
2022 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
2023 vmware_exclude | **Optional.** Blacklist issues. No value defined as default.
2024 vmware_include | **Optional.** Whitelist issues. No value defined as default.
2025 vmware_isregexp | **Optional.** Treat blacklist and whitelist expressions as regexp.
2026 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.
2029 ## <a id="plugins-contrib-vmware-esx-dc-runtime-status"></a> vmware-esx-dc-runtime-status
2031 Check command object for the `check_vmware_esx` plugin. Overall object status (gray/green/red/yellow).
2033 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
2036 ------------------------|--------------
2037 vmware_datacenter | **Required.** Datacenter/vCenter hostname.
2038 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
2039 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
2040 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
2041 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
2042 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
2043 vmware_sessionfile | **Optional.** Session file name enhancement.
2044 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
2045 vmware_nosession | **Optional.** No auth session - IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
2046 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
2047 vmware_password | **Optional.** The username's password. No value defined as default.
2048 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
2051 ## <a id="plugins-contrib-vmware-esx-dc-runtime-tools"></a> vmware-esx-dc-runtime-tools
2053 Check command object for the `check_vmware_esx` plugin. Vmware Tools status.
2055 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
2058 ------------------------|--------------
2059 vmware_datacenter | **Required.** Datacenter/vCenter hostname.
2060 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
2061 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
2062 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
2063 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
2064 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
2065 vmware_sessionfile | **Optional.** Session file name enhancement.
2066 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
2067 vmware_nosession | **Optional.** No auth session - IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
2068 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
2069 vmware_password | **Optional.** The username's password. No value defined as default.
2070 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
2071 vmware_poweredonly | **Optional.** List only VMs which are powered on. No value defined as default.
2072 vmware_alertonly | **Optional.** List only alerting VMs. Important here to avoid masses of data.
2073 vmware_exclude | **Optional.** Blacklist VMs. No value defined as default.
2074 vmware_include | **Optional.** Whitelist VMs. No value defined as default.
2075 vmware_isregexp | **Optional.** Treat blacklist and whitelist expressions as regexp.
2076 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.
2079 ## <a id="plugins-contrib-vmware-esx-soap-host-check"></a> vmware-esx-soap-host-check
2081 Check command object for the `check_vmware_esx` plugin. Simple check to verify a successfull connection to VMware SOAP API.
2083 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
2086 ------------------------|--------------
2087 vmware_host | **Required.** ESX or ESXi hostname.
2088 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
2089 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
2090 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
2091 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
2092 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
2093 vmware_sessionfile | **Optional.** Session file name enhancement.
2094 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
2095 vmware_nosession | **Optional.** No auth session - IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
2096 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
2097 vmware_password | **Optional.** The username's password. No value defined as default.
2098 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
2101 ## <a id="plugins-contrib-vmware-esx-soap-host-uptime"></a> vmware-esx-soap-host-uptime
2103 Check command object for the `check_vmware_esx` plugin. Displays uptime of the VMware host.
2105 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
2108 ------------------------|--------------
2109 vmware_host | **Required.** ESX or ESXi hostname.
2110 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
2111 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
2112 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
2113 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
2114 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
2115 vmware_sessionfile | **Optional.** Session file name enhancement.
2116 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
2117 vmware_nosession | **Optional.** No auth session - IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
2118 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
2119 vmware_password | **Optional.** The username's password. No value defined as default.
2120 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
2123 ## <a id="plugins-contrib-vmware-esx-soap-host-cpu"></a> vmware-esx-soap-host-cpu
2125 Check command object for the `check_vmware_esx` plugin. CPU usage in percentage.
2127 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
2130 ------------------------|--------------
2131 vmware_host | **Required.** ESX or ESXi hostname.
2132 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
2133 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
2134 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
2135 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
2136 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
2137 vmware_sessionfile | **Optional.** Session file name enhancement.
2138 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
2139 vmware_nosession | **Optional.** No auth session - IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
2140 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
2141 vmware_password | **Optional.** The username's password. No value defined as default.
2142 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
2143 vmware_warn | **Optional.** The warning threshold in percent. Defaults to "80%".
2144 vmware_crit | **Optional.** The critical threshold in percent. Defaults to "90%".
2147 ## <a id="plugins-contrib-vmware-esx-soap-host-cpu-ready"></a> vmware-esx-soap-host-cpu-ready
2149 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.
2151 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
2154 ------------------------|--------------
2155 vmware_host | **Required.** ESX or ESXi hostname.
2156 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
2157 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
2158 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
2159 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
2160 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
2161 vmware_sessionfile | **Optional.** Session file name enhancement.
2162 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
2163 vmware_nosession | **Optional.** No auth session - IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
2164 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
2165 vmware_password | **Optional.** The username's password. No value defined as default.
2166 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
2169 ## <a id="plugins-contrib-vmware-esx-soap-host-cpu-wait"></a> vmware-esx-soap-host-cpu-wait
2171 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.
2173 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
2176 ------------------------|--------------
2177 vmware_host | **Required.** ESX or ESXi hostname.
2178 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
2179 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
2180 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
2181 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
2182 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
2183 vmware_sessionfile | **Optional.** Session file name enhancement.
2184 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
2185 vmware_nosession | **Optional.** No auth session - IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
2186 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
2187 vmware_password | **Optional.** The username's password. No value defined as default.
2188 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
2191 ## <a id="plugins-contrib-vmware-esx-soap-host-cpu-usage"></a> vmware-esx-soap-host-cpu-usage
2193 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.
2195 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
2198 ------------------------|--------------
2199 vmware_host | **Required.** ESX or ESXi hostname.
2200 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
2201 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
2202 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
2203 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
2204 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
2205 vmware_sessionfile | **Optional.** Session file name enhancement.
2206 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
2207 vmware_nosession | **Optional.** No auth session - IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
2208 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
2209 vmware_password | **Optional.** The username's password. No value defined as default.
2210 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
2211 vmware_warn | **Optional.** The warning threshold in percent. Defaults to "80%".
2212 vmware_crit | **Optional.** The critical threshold in percent. Defaults to "90%".
2215 ## <a id="plugins-contrib-vmware-esx-soap-host-mem"></a> vmware-esx-soap-host-mem
2217 Check command object for the `check_vmware_esx` plugin. All mem info(except overall and no thresholds).
2219 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
2222 ------------------------|--------------
2223 vmware_host | **Required.** ESX or ESXi hostname.
2224 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
2225 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
2226 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
2227 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
2228 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
2229 vmware_sessionfile | **Optional.** Session file name enhancement.
2230 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
2231 vmware_nosession | **Optional.** No auth session - IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
2232 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
2233 vmware_password | **Optional.** The username's password. No value defined as default.
2234 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
2237 ## <a id="plugins-contrib-vmware-esx-soap-host-mem-usage"></a> vmware-esx-soap-host-mem-usage
2239 Check command object for the `check_vmware_esx` plugin. Average mem usage in percentage.
2241 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
2244 ------------------------|--------------
2245 vmware_host | **Required.** ESX or ESXi hostname.
2246 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
2247 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
2248 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
2249 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
2250 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
2251 vmware_sessionfile | **Optional.** Session file name enhancement.
2252 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
2253 vmware_nosession | **Optional.** No auth session - IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
2254 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
2255 vmware_password | **Optional.** The username's password. No value defined as default.
2256 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
2257 vmware_warn | **Optional.** The warning threshold in percent. Defaults to "80%".
2258 vmware_crit | **Optional.** The critical threshold in percent. Defaults to "90%".
2261 ## <a id="plugins-contrib-vmware-esx-soap-host-mem-consumed"></a> vmware-esx-soap-host-mem-consumed
2263 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.
2265 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
2268 ------------------------|--------------
2269 vmware_host | **Required.** ESX or ESXi hostname.
2270 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
2271 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
2272 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
2273 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
2274 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
2275 vmware_sessionfile | **Optional.** Session file name enhancement.
2276 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
2277 vmware_nosession | **Optional.** No auth session - IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
2278 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
2279 vmware_password | **Optional.** The username's password. No value defined as default.
2280 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
2281 vmware_warn | **Optional.** The warning threshold in percent. No value defined as default.
2282 vmware_crit | **Optional.** The critical threshold in percent. No value defined as default.
2285 ## <a id="plugins-contrib-vmware-esx-soap-host-mem-swapused"></a> vmware-esx-soap-host-mem-swapused
2287 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.
2289 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
2292 ------------------------|--------------
2293 vmware_host | **Required.** ESX or ESXi hostname.
2294 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
2295 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
2296 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
2297 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
2298 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
2299 vmware_sessionfile | **Optional.** Session file name enhancement.
2300 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
2301 vmware_nosession | **Optional.** No auth session - IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
2302 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
2303 vmware_password | **Optional.** The username's password. No value defined as default.
2304 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
2305 vmware_warn | **Optional.** The warning threshold in percent. No value defined as default.
2306 vmware_crit | **Optional.** The critical threshold in percent. No value defined as default.
2307 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.
2310 ## <a id="plugins-contrib-vmware-esx-soap-host-mem-overhead"></a> vmware-esx-soap-host-mem-overhead
2312 Check command object for the `check_vmware_esx` plugin. Additional mem used by VM Server in MB.
2314 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
2317 ------------------------|--------------
2318 vmware_host | **Required.** ESX or ESXi hostname.
2319 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
2320 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
2321 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
2322 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
2323 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
2324 vmware_sessionfile | **Optional.** Session file name enhancement.
2325 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
2326 vmware_nosession | **Optional.** No auth session - IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
2327 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
2328 vmware_password | **Optional.** The username's password. No value defined as default.
2329 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
2330 vmware_warn | **Optional.** The warning threshold in percent. No value defined as default.
2331 vmware_crit | **Optional.** The critical threshold in percent. No value defined as default.
2334 ## <a id="plugins-contrib-vmware-esx-soap-host-mem-memctl"></a> vmware-esx-soap-host-mem-memctl
2336 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.
2338 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
2341 ------------------------|--------------
2342 vmware_host | **Required.** ESX or ESXi hostname.
2343 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
2344 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
2345 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
2346 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
2347 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
2348 vmware_sessionfile | **Optional.** Session file name enhancement.
2349 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
2350 vmware_nosession | **Optional.** No auth session - IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
2351 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
2352 vmware_password | **Optional.** The username's password. No value defined as default.
2353 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
2354 vmware_warn | **Optional.** The warning threshold in percent. No value defined as default.
2355 vmware_crit | **Optional.** The critical threshold in percent. No value defined as default.
2356 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.
2359 ## <a id="plugins-contrib-vmware-esx-soap-host-net"></a> vmware-esx-soap-host-net
2361 Check command object for the `check_vmware_esx` plugin. Shows net info.
2363 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
2366 ------------------------|--------------
2367 vmware_host | **Required.** ESX or ESXi hostname.
2368 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
2369 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
2370 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
2371 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
2372 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
2373 vmware_sessionfile | **Optional.** Session file name enhancement.
2374 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
2375 vmware_nosession | **Optional.** No auth session - IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
2376 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
2377 vmware_password | **Optional.** The username's password. No value defined as default.
2378 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
2379 vmware_exclude | **Optional.** Blacklist NICs. No value defined as default.
2380 vmware_isregexp | **Optional.** Treat blacklist expression as regexp.
2383 ## <a id="plugins-contrib-vmware-esx-soap-host-net-usage"></a> vmware-esx-soap-host-net-usage
2385 Check command object for the `check_vmware_esx` plugin. Overall network usage in KBps(Kilobytes per Second).
2387 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
2390 ------------------------|--------------
2391 vmware_host | **Required.** ESX or ESXi hostname.
2392 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
2393 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
2394 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
2395 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
2396 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
2397 vmware_sessionfile | **Optional.** Session file name enhancement.
2398 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
2399 vmware_nosession | **Optional.** No auth session - IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
2400 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
2401 vmware_password | **Optional.** The username's password. No value defined as default.
2402 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
2403 vmware_warn | **Optional.** The warning threshold in KBps(Kilobytes per Second). No value defined as default.
2404 vmware_crit | **Optional.** The critical threshold in KBps(Kilobytes per Second). No value defined as default.
2407 ## <a id="plugins-contrib-vmware-esx-soap-host-net-receive"></a> vmware-esx-soap-host-net-receive
2409 Check command object for the `check_vmware_esx` plugin. Data receive in KBps(Kilobytes per Second).
2411 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
2414 ------------------------|--------------
2415 vmware_host | **Required.** ESX or ESXi hostname.
2416 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
2417 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
2418 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
2419 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
2420 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
2421 vmware_sessionfile | **Optional.** Session file name enhancement.
2422 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
2423 vmware_nosession | **Optional.** No auth session - IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
2424 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
2425 vmware_password | **Optional.** The username's password. No value defined as default.
2426 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
2427 vmware_warn | **Optional.** The warning threshold in KBps(Kilobytes per Second). No value defined as default.
2428 vmware_crit | **Optional.** The critical threshold in KBps(Kilobytes per Second). No value defined as default.
2431 ## <a id="plugins-contrib-vmware-esx-soap-host-net-send"></a> vmware-esx-soap-host-net-send
2433 Check command object for the `check_vmware_esx` plugin. Data send in KBps(Kilobytes per Second).
2435 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
2438 ------------------------|--------------
2439 vmware_host | **Required.** ESX or ESXi hostname.
2440 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
2441 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
2442 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
2443 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
2444 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
2445 vmware_sessionfile | **Optional.** Session file name enhancement.
2446 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
2447 vmware_nosession | **Optional.** No auth session - IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
2448 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
2449 vmware_password | **Optional.** The username's password. No value defined as default.
2450 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
2451 vmware_warn | **Optional.** The warning threshold in KBps(Kilobytes per Second). No value defined as default.
2452 vmware_crit | **Optional.** The critical threshold in KBps(Kilobytes per Second). No value defined as default.
2455 ## <a id="plugins-contrib-vmware-esx-soap-host-net-nic"></a> vmware-esx-soap-host-net-nic
2457 Check command object for the `check_vmware_esx` plugin. Check all active NICs.
2459 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
2462 ------------------------|--------------
2463 vmware_host | **Required.** ESX or ESXi hostname.
2464 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
2465 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
2466 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
2467 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
2468 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
2469 vmware_sessionfile | **Optional.** Session file name enhancement.
2470 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
2471 vmware_nosession | **Optional.** No auth session - IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
2472 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
2473 vmware_password | **Optional.** The username's password. No value defined as default.
2474 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
2475 vmware_exclude | **Optional.** Blacklist NICs. No value defined as default.
2476 vmware_isregexp | **Optional.** Treat blacklist expression as regexp.
2479 ## <a id="plugins-contrib-vmware-esx-soap-host-volumes"></a> vmware-esx-soap-host-volumes
2481 Check command object for the `check_vmware_esx` plugin. Shows all datastore volumes info.
2483 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
2486 ------------------------|--------------
2487 vmware_host | **Required.** ESX or ESXi hostname.
2488 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
2489 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
2490 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
2491 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
2492 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
2493 vmware_sessionfile | **Optional.** Session file name enhancement.
2494 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
2495 vmware_nosession | **Optional.** No auth session - IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
2496 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
2497 vmware_password | **Optional.** The username's password. No value defined as default.
2498 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
2499 vmware_subselect | **Optional.** Volume name to be checked the free space.
2500 vmware_gigabyte | **Optional.** Output in GB instead of MB.
2501 vmware_usedspace | **Optional.** Output used space instead of free. Defaults to "false".
2502 vmware_alertonly | **Optional.** List only alerting volumes. Defaults to "false".
2503 vmware_exclude | **Optional.** Blacklist volumes name. No value defined as default.
2504 vmware_include | **Optional.** Whitelist volumes name. No value defined as default.
2505 vmware_isregexp | **Optional.** Treat blacklist and whitelist expressions as regexp.
2506 vmware_warn | **Optional.** The warning threshold for volumes. Defaults to "80%".
2507 vmware_crit | **Optional.** The critical threshold for volumes. Defaults to "90%".
2508 vmware_spaceleft | **Optional.** This has to be used in conjunction with thresholds as mentioned above.
2511 ## <a id="plugins-contrib-vmware-esx-soap-host-io"></a> vmware-esx-soap-host-io
2513 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.
2515 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
2518 ------------------------|--------------
2519 vmware_host | **Required.** ESX or ESXi hostname.
2520 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
2521 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
2522 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
2523 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
2524 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
2525 vmware_sessionfile | **Optional.** Session file name enhancement.
2526 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
2527 vmware_nosession | **Optional.** No auth session - IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
2528 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
2529 vmware_password | **Optional.** The username's password. No value defined as default.
2530 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
2533 ## <a id="plugins-contrib-vmware-esx-soap-host-io-aborted"></a> vmware-esx-soap-host-io-aborted
2535 Check command object for the `check_vmware_esx` plugin. Number of aborted SCSI commands.
2537 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
2540 ------------------------|--------------
2541 vmware_host | **Required.** ESX or ESXi hostname.
2542 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
2543 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
2544 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
2545 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
2546 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
2547 vmware_sessionfile | **Optional.** Session file name enhancement.
2548 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
2549 vmware_nosession | **Optional.** No auth session - IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
2550 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
2551 vmware_password | **Optional.** The username's password. No value defined as default.
2552 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
2553 vmware_warn | **Optional.** The warning threshold. No value defined as default.
2554 vmware_crit | **Optional.** The critical threshold. No value defined as default.
2557 ## <a id="plugins-contrib-vmware-esx-soap-host-io-resets"></a> vmware-esx-soap-host-io-resets
2559 Check command object for the `check_vmware_esx` plugin. Number of SCSI bus resets.
2561 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
2564 ------------------------|--------------
2565 vmware_host | **Required.** ESX or ESXi hostname.
2566 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
2567 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
2568 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
2569 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
2570 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
2571 vmware_sessionfile | **Optional.** Session file name enhancement.
2572 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
2573 vmware_nosession | **Optional.** No auth session - IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
2574 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
2575 vmware_password | **Optional.** The username's password. No value defined as default.
2576 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
2577 vmware_warn | **Optional.** The warning threshold. No value defined as default.
2578 vmware_crit | **Optional.** The critical threshold. No value defined as default.
2581 ## <a id="plugins-contrib-vmware-esx-soap-host-io-read"></a> vmware-esx-soap-host-io-read
2583 Check command object for the `check_vmware_esx` plugin. Average number of kilobytes read from the disk each second.
2585 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
2588 ------------------------|--------------
2589 vmware_host | **Required.** ESX or ESXi hostname.
2590 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
2591 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
2592 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
2593 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
2594 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
2595 vmware_sessionfile | **Optional.** Session file name enhancement.
2596 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
2597 vmware_nosession | **Optional.** No auth session - IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
2598 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
2599 vmware_password | **Optional.** The username's password. No value defined as default.
2600 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
2601 vmware_warn | **Optional.** The warning threshold. No value defined as default.
2602 vmware_crit | **Optional.** The critical threshold. No value defined as default.
2605 ## <a id="plugins-contrib-vmware-esx-soap-host-io-read-latency"></a> vmware-esx-soap-host-io-read-latency
2607 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.
2609 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
2612 ------------------------|--------------
2613 vmware_host | **Required.** ESX or ESXi hostname.
2614 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
2615 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
2616 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
2617 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
2618 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
2619 vmware_sessionfile | **Optional.** Session file name enhancement.
2620 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
2621 vmware_nosession | **Optional.** No auth session - IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
2622 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
2623 vmware_password | **Optional.** The username's password. No value defined as default.
2624 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
2625 vmware_warn | **Optional.** The warning threshold. No value defined as default.
2626 vmware_crit | **Optional.** The critical threshold. No value defined as default.
2629 ## <a id="plugins-contrib-vmware-esx-soap-host-io-write"></a> vmware-esx-soap-host-io-write
2631 Check command object for the `check_vmware_esx` plugin. Average number of kilobytes written to disk each second.
2633 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
2636 ------------------------|--------------
2637 vmware_host | **Required.** ESX or ESXi hostname.
2638 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
2639 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
2640 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
2641 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
2642 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
2643 vmware_sessionfile | **Optional.** Session file name enhancement.
2644 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
2645 vmware_nosession | **Optional.** No auth session - IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
2646 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
2647 vmware_password | **Optional.** The username's password. No value defined as default.
2648 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
2649 vmware_warn | **Optional.** The warning threshold. No value defined as default.
2650 vmware_crit | **Optional.** The critical threshold. No value defined as default.
2653 ## <a id="plugins-contrib-vmware-esx-soap-host-io-write-latency"></a> vmware-esx-soap-host-io-write-latency
2655 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.
2657 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
2660 ------------------------|--------------
2661 vmware_host | **Required.** ESX or ESXi hostname.
2662 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
2663 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
2664 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
2665 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
2666 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
2667 vmware_sessionfile | **Optional.** Session file name enhancement.
2668 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
2669 vmware_nosession | **Optional.** No auth session - IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
2670 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
2671 vmware_password | **Optional.** The username's password. No value defined as default.
2672 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
2673 vmware_warn | **Optional.** The warning threshold. No value defined as default.
2674 vmware_crit | **Optional.** The critical threshold. No value defined as default.
2677 ## <a id="plugins-contrib-vmware-esx-soap-host-io-usage"></a> vmware-esx-soap-host-io-usage
2679 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.
2681 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
2684 ------------------------|--------------
2685 vmware_host | **Required.** ESX or ESXi hostname.
2686 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
2687 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
2688 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
2689 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
2690 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
2691 vmware_sessionfile | **Optional.** Session file name enhancement.
2692 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
2693 vmware_nosession | **Optional.** No auth session - IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
2694 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
2695 vmware_password | **Optional.** The username's password. No value defined as default.
2696 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
2697 vmware_warn | **Optional.** The warning threshold. No value defined as default.
2698 vmware_crit | **Optional.** The critical threshold. No value defined as default.
2701 ## <a id="plugins-contrib-vmware-esx-soap-host-io-kernel-latency"></a> vmware-esx-soap-host-io-kernel-latency
2703 Check command object for the `check_vmware_esx` plugin. Average amount of time (ms) spent by VMkernel processing each SCSI command.
2705 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
2708 ------------------------|--------------
2709 vmware_host | **Required.** ESX or ESXi hostname.
2710 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
2711 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
2712 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
2713 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
2714 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
2715 vmware_sessionfile | **Optional.** Session file name enhancement.
2716 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
2717 vmware_nosession | **Optional.** No auth session - IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
2718 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
2719 vmware_password | **Optional.** The username's password. No value defined as default.
2720 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
2721 vmware_warn | **Optional.** The warning threshold. No value defined as default.
2722 vmware_crit | **Optional.** The critical threshold. No value defined as default.
2725 ## <a id="plugins-contrib-vmware-esx-soap-host-io-device-latency"></a> vmware-esx-soap-host-io-device-latency
2727 Check command object for the `check_vmware_esx` plugin. Average amount of time (ms) to complete a SCSI command from the physical device.
2729 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
2732 ------------------------|--------------
2733 vmware_host | **Required.** ESX or ESXi hostname.
2734 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
2735 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
2736 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
2737 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
2738 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
2739 vmware_sessionfile | **Optional.** Session file name enhancement.
2740 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
2741 vmware_nosession | **Optional.** No auth session - IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
2742 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
2743 vmware_password | **Optional.** The username's password. No value defined as default.
2744 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
2745 vmware_warn | **Optional.** The warning threshold. No value defined as default.
2746 vmware_crit | **Optional.** The critical threshold. No value defined as default.
2749 ## <a id="plugins-contrib-vmware-esx-soap-host-io-queue-latency"></a> vmware-esx-soap-host-io-queue-latency
2751 Check command object for the `check_vmware_esx` plugin. Average amount of time (ms) spent in the VMkernel queue.
2753 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
2756 ------------------------|--------------
2757 vmware_host | **Required.** ESX or ESXi hostname.
2758 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
2759 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
2760 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
2761 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
2762 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
2763 vmware_sessionfile | **Optional.** Session file name enhancement.
2764 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
2765 vmware_nosession | **Optional.** No auth session - IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
2766 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
2767 vmware_password | **Optional.** The username's password. No value defined as default.
2768 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
2769 vmware_warn | **Optional.** The warning threshold. No value defined as default.
2770 vmware_crit | **Optional.** The critical threshold. No value defined as default.
2773 ## <a id="plugins-contrib-vmware-esx-soap-host-io-total-latency"></a> vmware-esx-soap-host-io-total-latency
2775 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.
2777 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
2780 ------------------------|--------------
2781 vmware_host | **Required.** ESX or ESXi hostname.
2782 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
2783 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
2784 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
2785 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
2786 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
2787 vmware_sessionfile | **Optional.** Session file name enhancement.
2788 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
2789 vmware_nosession | **Optional.** No auth session - IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
2790 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
2791 vmware_password | **Optional.** The username's password. No value defined as default.
2792 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
2793 vmware_warn | **Optional.** The warning threshold. No value defined as default.
2794 vmware_crit | **Optional.** The critical threshold. No value defined as default.
2797 ## <a id="plugins-contrib-vmware-esx-soap-host-media"></a> vmware-esx-soap-host-media
2799 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.
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 VMs name. No value defined as default.
2818 vmware_include | **Optional.** Whitelist VMs 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-service"></a> vmware-esx-soap-host-service
2825 Check command object for the `check_vmware_esx` plugin. Shows host service info.
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 services name. No value defined as default.
2844 vmware_include | **Optional.** Whitelist services 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"></a> vmware-esx-soap-host-runtime
2851 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.
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
2871 ## <a id="plugins-contrib-vmware-esx-soap-host-runtime-con"></a> vmware-esx-soap-host-runtime-con
2873 Check command object for the `check_vmware_esx` plugin. Shows connection state.
2875 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
2878 ------------------------|--------------
2879 vmware_host | **Required.** ESX or ESXi hostname.
2880 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
2881 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
2882 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
2883 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
2884 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
2885 vmware_sessionfile | **Optional.** Session file name enhancement.
2886 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
2887 vmware_nosession | **Optional.** No auth session - IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
2888 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
2889 vmware_password | **Optional.** The username's password. No value defined as default.
2890 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
2893 ## <a id="plugins-contrib-vmware-esx-soap-host-runtime-listvms"></a> vmware-esx-soap-host-runtime-listvms
2895 Check command object for the `check_vmware_esx` plugin. List of VMware machines and their status.
2897 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
2900 ------------------------|--------------
2901 vmware_host | **Required.** ESX or ESXi hostname.
2902 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
2903 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
2904 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
2905 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
2906 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
2907 vmware_sessionfile | **Optional.** Session file name enhancement.
2908 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
2909 vmware_nosession | **Optional.** No auth session - IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
2910 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
2911 vmware_password | **Optional.** The username's password. No value defined as default.
2912 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
2913 vmware_exclude | **Optional.** Blacklist VMs name. No value defined as default.
2914 vmware_include | **Optional.** Whitelist VMs name. No value defined as default.
2915 vmware_isregexp | **Optional.** Treat blacklist and whitelist expressions as regexp.
2916 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.
2919 ## <a id="plugins-contrib-vmware-esx-soap-host-runtime-status"></a> vmware-esx-soap-host-runtime-status
2921 Check command object for the `check_vmware_esx` plugin. Overall object status (gray/green/red/yellow).
2923 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
2926 ------------------------|--------------
2927 vmware_host | **Required.** ESX or ESXi hostname.
2928 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
2929 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
2930 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
2931 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
2932 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
2933 vmware_sessionfile | **Optional.** Session file name enhancement.
2934 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
2935 vmware_nosession | **Optional.** No auth session - IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
2936 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
2937 vmware_password | **Optional.** The username's password. No value defined as default.
2938 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
2941 ## <a id="plugins-contrib-vmware-esx-soap-host-runtime-health"></a> vmware-esx-soap-host-runtime-health
2943 Check command object for the `check_vmware_esx` plugin. Checks cpu/storage/memory/sensor status.
2945 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
2948 ------------------------|--------------
2949 vmware_host | **Required.** ESX or ESXi hostname.
2950 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
2951 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
2952 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
2953 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
2954 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
2955 vmware_sessionfile | **Optional.** Session file name enhancement.
2956 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
2957 vmware_nosession | **Optional.** No auth session - IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
2958 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
2959 vmware_password | **Optional.** The username's password. No value defined as default.
2960 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
2961 vmware_exclude | **Optional.** Blacklist status name. No value defined as default.
2962 vmware_include | **Optional.** Whitelist status name. No value defined as default.
2963 vmware_isregexp | **Optional.** Treat blacklist and whitelist expressions as regexp.
2966 ## <a id="plugins-contrib-vmware-esx-soap-host-runtime-health-listsensors"></a> vmware-esx-soap-host-runtime-health-listsensors
2968 Check command object for the `check_vmware_esx` plugin. List all available sensors(use for listing purpose only).
2970 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
2973 ------------------------|--------------
2974 vmware_host | **Required.** ESX or ESXi hostname.
2975 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
2976 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
2977 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
2978 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
2979 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
2980 vmware_sessionfile | **Optional.** Session file name enhancement.
2981 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
2982 vmware_nosession | **Optional.** No auth session - IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
2983 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
2984 vmware_password | **Optional.** The username's password. No value defined as default.
2985 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
2986 vmware_exclude | **Optional.** Blacklist status name. No value defined as default.
2987 vmware_include | **Optional.** Whitelist status name. No value defined as default.
2988 vmware_isregexp | **Optional.** Treat blacklist and whitelist expressions as regexp.
2991 ## <a id="plugins-contrib-vmware-esx-soap-host-runtime-health-nostoragestatus"></a> vmware-esx-soap-host-runtime-health-nostoragestatus
2993 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**.
2995 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
2998 ------------------------|--------------
2999 vmware_host | **Required.** ESX or ESXi hostname.
3000 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
3001 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
3002 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
3003 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
3004 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
3005 vmware_sessionfile | **Optional.** Session file name enhancement.
3006 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
3007 vmware_nosession | **Optional.** No auth session - IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
3008 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
3009 vmware_password | **Optional.** The username's password. No value defined as default.
3010 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
3011 vmware_exclude | **Optional.** Blacklist status name. No value defined as default.
3012 vmware_include | **Optional.** Whitelist status name. No value defined as default.
3013 vmware_isregexp | **Optional.** Treat blacklist and whitelist expressions as regexp.
3016 ## <a id="plugins-contrib-vmware-esx-soap-host-runtime-storagehealth"></a> vmware-esx-soap-host-runtime-storagehealth
3018 Check command object for the `check_vmware_esx` plugin. Local storage status check.
3020 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
3023 ------------------------|--------------
3024 vmware_host | **Required.** ESX or ESXi hostname.
3025 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
3026 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
3027 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
3028 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
3029 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
3030 vmware_sessionfile | **Optional.** Session file name enhancement.
3031 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
3032 vmware_nosession | **Optional.** No auth session - IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
3033 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
3034 vmware_password | **Optional.** The username's password. No value defined as default.
3035 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
3036 vmware_exclude | **Optional.** Blacklist storage name. No value defined as default.
3037 vmware_include | **Optional.** Whitelist storage name. No value defined as default.
3038 vmware_isregexp | **Optional.** Treat blacklist and whitelist expressions as regexp.
3039 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.
3042 ## <a id="plugins-contrib-vmware-esx-soap-host-runtime-temp"></a> vmware-esx-soap-host-runtime-temp
3044 Check command object for the `check_vmware_esx` plugin. Lists all temperature sensors.
3046 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
3049 ------------------------|--------------
3050 vmware_host | **Required.** ESX or ESXi hostname.
3051 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
3052 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
3053 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
3054 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
3055 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
3056 vmware_sessionfile | **Optional.** Session file name enhancement.
3057 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
3058 vmware_nosession | **Optional.** No auth session - IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
3059 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
3060 vmware_password | **Optional.** The username's password. No value defined as default.
3061 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
3062 vmware_exclude | **Optional.** Blacklist sensor name. No value defined as default.
3063 vmware_include | **Optional.** Whitelist sensor name. No value defined as default.
3064 vmware_isregexp | **Optional.** Treat blacklist and whitelist expressions as regexp.
3065 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.
3068 ## <a id="plugins-contrib-vmware-esx-soap-host-runtime-issues"></a> vmware-esx-soap-host-runtime-issues
3070 Check command object for the `check_vmware_esx` plugin. Lists all configuration issues for the host.
3072 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
3075 ------------------------|--------------
3076 vmware_host | **Required.** ESX or ESXi hostname.
3077 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
3078 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
3079 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
3080 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
3081 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
3082 vmware_sessionfile | **Optional.** Session file name enhancement.
3083 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
3084 vmware_nosession | **Optional.** No auth session - IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
3085 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
3086 vmware_password | **Optional.** The username's password. No value defined as default.
3087 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
3088 vmware_exclude | **Optional.** Blacklist configuration issues. No value defined as default.
3089 vmware_include | **Optional.** Whitelist configuration issues. No value defined as default.
3090 vmware_isregexp | **Optional.** Treat blacklist and whitelist expressions as regexp.
3091 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.
3094 ## <a id="plugins-contrib-vmware-esx-soap-host-storage"></a> vmware-esx-soap-host-storage
3096 Check command object for the `check_vmware_esx` plugin. Shows Host storage info.
3098 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
3101 ------------------------|--------------
3102 vmware_host | **Required.** ESX or ESXi hostname.
3103 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
3104 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
3105 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
3106 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
3107 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
3108 vmware_sessionfile | **Optional.** Session file name enhancement.
3109 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
3110 vmware_nosession | **Optional.** No auth session - IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
3111 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
3112 vmware_password | **Optional.** The username's password. No value defined as default.
3113 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
3114 vmware_exclude | **Optional.** Blacklist adapters, luns and paths. No value defined as default.
3115 vmware_include | **Optional.** Whitelist adapters, luns and paths. No value defined as default.
3116 vmware_isregexp | **Optional.** Treat blacklist and whitelist expressions as regexp.
3119 ## <a id="plugins-contrib-vmware-esx-soap-host-storage-adapter"></a> vmware-esx-soap-host-storage-adapter
3121 Check command object for the `check_vmware_esx` plugin. List host bus adapters.
3123 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
3126 ------------------------|--------------
3127 vmware_host | **Required.** ESX or ESXi hostname.
3128 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
3129 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
3130 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
3131 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
3132 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
3133 vmware_sessionfile | **Optional.** Session file name enhancement.
3134 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
3135 vmware_nosession | **Optional.** No auth session - IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
3136 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
3137 vmware_password | **Optional.** The username's password. No value defined as default.
3138 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
3139 vmware_exclude | **Optional.** Blacklist adapters. No value defined as default.
3140 vmware_include | **Optional.** Whitelist adapters. No value defined as default.
3141 vmware_isregexp | **Optional.** Treat blacklist and whitelist expressions as regexp.
3142 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.
3145 ## <a id="plugins-contrib-vmware-esx-soap-host-storage-lun"></a> vmware-esx-soap-host-storage-lun
3147 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.
3149 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
3152 ------------------------|--------------
3153 vmware_host | **Required.** ESX or ESXi hostname.
3154 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
3155 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
3156 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
3157 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
3158 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
3159 vmware_sessionfile | **Optional.** Session file name enhancement.
3160 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
3161 vmware_nosession | **Optional.** No auth session - IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
3162 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
3163 vmware_password | **Optional.** The username's password. No value defined as default.
3164 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
3165 vmware_exclude | **Optional.** Blacklist luns. No value defined as default.
3166 vmware_include | **Optional.** Whitelist luns. No value defined as default.
3167 vmware_isregexp | **Optional.** Treat blacklist and whitelist expressions as regexp.
3168 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.
3171 ## <a id="plugins-contrib-vmware-esx-soap-host-storage-path"></a> vmware-esx-soap-host-storage-path
3173 Check command object for the `check_vmware_esx` plugin. List multipaths and the associated paths.
3175 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
3178 ------------------------|--------------
3179 vmware_host | **Required.** ESX or ESXi hostname.
3180 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
3181 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
3182 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
3183 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
3184 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
3185 vmware_sessionfile | **Optional.** Session file name enhancement.
3186 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
3187 vmware_nosession | **Optional.** No auth session - IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
3188 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
3189 vmware_password | **Optional.** The username's password. No value defined as default.
3190 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
3191 vmware_alertonly | **Optional.** List only alerting units. Important here to avoid masses of data. Defaults to "false".
3192 vmware_exclude | **Optional.** Blacklist paths. No value defined as default.
3193 vmware_include | **Optional.** Whitelist paths. No value defined as default.
3194 vmware_isregexp | **Optional.** Treat blacklist and whitelist expressions as regexp.
3195 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.
3198 ## <a id="plugins-contrib-vmware-esx-soap-vm-cpu"></a> vmware-esx-soap-vm-cpu
3200 Check command object for the `check_vmware_esx` plugin. Shows all CPU usage info.
3202 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
3205 ------------------------|--------------
3206 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. Conflicts with **vmware_host**.
3207 vmware_host | **Optional.** ESX or ESXi hostname. Conflicts with **vmware_datacenter**.
3208 vmware_vmname | **Required.** Virtual machine name.
3209 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
3210 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
3211 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
3212 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
3213 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
3214 vmware_sessionfile | **Optional.** Session file name enhancement.
3215 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
3216 vmware_nosession | **Optional.** No auth session - IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
3217 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
3218 vmware_password | **Optional.** The username's password. No value defined as default.
3219 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
3223 ## <a id="plugins-contrib-vmware-esx-soap-vm-cpu-ready"></a> vmware-esx-soap-vm-cpu-ready
3225 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.
3227 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
3230 ------------------------|--------------
3231 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. Conflicts with **vmware_host**.
3232 vmware_host | **Optional.** ESX or ESXi hostname. Conflicts with **vmware_datacenter**.
3233 vmware_vmname | **Required.** Virtual machine name.
3234 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
3235 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
3236 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
3237 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
3238 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
3239 vmware_sessionfile | **Optional.** Session file name enhancement.
3240 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
3241 vmware_nosession | **Optional.** No auth session - IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
3242 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
3243 vmware_password | **Optional.** The username's password. No value defined as default.
3244 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
3245 vmware_warn | **Optional.** The warning threshold. No value defined as default.
3246 vmware_crit | **Optional.** The critical threshold. No value defined as default.
3249 ## <a id="plugins-contrib-vmware-esx-soap-vm-cpu-wait"></a> vmware-esx-soap-vm-cpu-wait
3251 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.
3253 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
3256 ------------------------|--------------
3257 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. Conflicts with **vmware_host**.
3258 vmware_host | **Optional.** ESX or ESXi hostname. Conflicts with **vmware_datacenter**.
3259 vmware_vmname | **Required.** Virtual machine name.
3260 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
3261 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
3262 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
3263 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
3264 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
3265 vmware_sessionfile | **Optional.** Session file name enhancement.
3266 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
3267 vmware_nosession | **Optional.** No auth session - IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
3268 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
3269 vmware_password | **Optional.** The username's password. No value defined as default.
3270 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
3271 vmware_warn | **Optional.** The warning threshold. No value defined as default.
3272 vmware_crit | **Optional.** The critical threshold. No value defined as default.
3275 ## <a id="plugins-contrib-vmware-esx-soap-vm-cpu-usage"></a> vmware-esx-soap-vm-cpu-usage
3277 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.
3279 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
3282 ------------------------|--------------
3283 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. Conflicts with **vmware_host**.
3284 vmware_host | **Optional.** ESX or ESXi hostname. Conflicts with **vmware_datacenter**.
3285 vmware_vmname | **Required.** Virtual machine name.
3286 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
3287 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
3288 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
3289 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
3290 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
3291 vmware_sessionfile | **Optional.** Session file name enhancement.
3292 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
3293 vmware_nosession | **Optional.** No auth session - IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
3294 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
3295 vmware_password | **Optional.** The username's password. No value defined as default.
3296 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
3297 vmware_warn | **Optional.** Warning threshold in percent. Defaults to "80%".
3298 vmware_crit | **Optional.** Critical threshold in percent. Defaults to "90%".
3301 ## <a id="plugins-contrib-vmware-esx-soap-vm-mem"></a> vmware-esx-soap-vm-mem
3303 Check command object for the `check_vmware_esx` plugin. Shows all memory info, except overall.
3305 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
3308 ------------------------|--------------
3309 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. Conflicts with **vmware_host**.
3310 vmware_host | **Optional.** ESX or ESXi hostname. Conflicts with **vmware_datacenter**.
3311 vmware_vmname | **Required.** Virtual machine name.
3312 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
3313 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
3314 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
3315 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
3316 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
3317 vmware_sessionfile | **Optional.** Session file name enhancement.
3318 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
3319 vmware_nosession | **Optional.** No auth session - IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
3320 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
3321 vmware_password | **Optional.** The username's password. No value defined as default.
3322 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
3325 ## <a id="plugins-contrib-vmware-esx-soap-vm-mem-usage"></a> vmware-esx-soap-vm-mem-usage
3327 Check command object for the `check_vmware_esx` plugin. Average mem usage in percentage of configured virtual machine "physical" memory.
3329 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
3332 ------------------------|--------------
3333 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. Conflicts with **vmware_host**.
3334 vmware_host | **Optional.** ESX or ESXi hostname. Conflicts with **vmware_datacenter**.
3335 vmware_vmname | **Required.** Virtual machine name.
3336 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
3337 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
3338 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
3339 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
3340 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
3341 vmware_sessionfile | **Optional.** Session file name enhancement.
3342 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
3343 vmware_nosession | **Optional.** No auth session - IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
3344 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
3345 vmware_password | **Optional.** The username's password. No value defined as default.
3346 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
3347 vmware_warn | **Optional.** Warning threshold in percent. Defaults to "80%".
3348 vmware_crit | **Optional.** Critical threshold in percent. Defaults to "90%".
3351 ## <a id="plugins-contrib-vmware-esx-soap-vm-mem-consumed"></a> vmware-esx-soap-vm-mem-consumed
3353 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>
3354 **vm consumed memory = memory granted - memory saved**
3356 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
3359 ------------------------|--------------
3360 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. Conflicts with **vmware_host**.
3361 vmware_host | **Optional.** ESX or ESXi hostname. Conflicts with **vmware_datacenter**.
3362 vmware_vmname | **Required.** Virtual machine name.
3363 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
3364 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
3365 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
3366 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
3367 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
3368 vmware_sessionfile | **Optional.** Session file name enhancement.
3369 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
3370 vmware_nosession | **Optional.** No auth session - IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
3371 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
3372 vmware_password | **Optional.** The username's password. No value defined as default.
3373 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
3374 vmware_warn | **Optional.** The warning threshold. No value defined as default.
3375 vmware_crit | **Optional.** The critical threshold. No value defined as default.
3378 ## <a id="plugins-contrib-vmware-esx-soap-vm-mem-memctl"></a> vmware-esx-soap-vm-mem-memctl
3380 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.
3382 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
3385 ------------------------|--------------
3386 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. Conflicts with **vmware_host**.
3387 vmware_host | **Optional.** ESX or ESXi hostname. Conflicts with **vmware_datacenter**.
3388 vmware_vmname | **Required.** Virtual machine name.
3389 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
3390 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
3391 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
3392 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
3393 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
3394 vmware_sessionfile | **Optional.** Session file name enhancement.
3395 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
3396 vmware_nosession | **Optional.** No auth session - IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
3397 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
3398 vmware_password | **Optional.** The username's password. No value defined as default.
3399 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
3400 vmware_warn | **Optional.** The warning threshold. No value defined as default.
3401 vmware_crit | **Optional.** The critical threshold. No value defined as default.
3405 ## <a id="plugins-contrib-vmware-esx-soap-vm-net"></a> vmware-esx-soap-vm-net
3407 Check command object for the `check_vmware_esx` plugin. Shows net info.
3409 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
3412 ------------------------|--------------
3413 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. Conflicts with **vmware_host**.
3414 vmware_host | **Optional.** ESX or ESXi hostname. Conflicts with **vmware_datacenter**.
3415 vmware_vmname | **Required.** Virtual machine name.
3416 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
3417 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
3418 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
3419 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
3420 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
3421 vmware_sessionfile | **Optional.** Session file name enhancement.
3422 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
3423 vmware_nosession | **Optional.** No auth session - IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
3424 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
3425 vmware_password | **Optional.** The username's password. No value defined as default.
3426 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
3429 ## <a id="plugins-contrib-vmware-esx-soap-vm-net-usage"></a> vmware-esx-soap-vm-net-usage
3431 Check command object for the `check_vmware_esx` plugin. Overall network usage in KBps(Kilobytes per Second).
3433 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
3436 ------------------------|--------------
3437 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. Conflicts with **vmware_host**.
3438 vmware_host | **Optional.** ESX or ESXi hostname. Conflicts with **vmware_datacenter**.
3439 vmware_vmname | **Required.** Virtual machine name.
3440 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
3441 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
3442 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
3443 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
3444 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
3445 vmware_sessionfile | **Optional.** Session file name enhancement.
3446 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
3447 vmware_nosession | **Optional.** No auth session - IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
3448 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
3449 vmware_password | **Optional.** The username's password. No value defined as default.
3450 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
3451 vmware_warn | **Optional.** The warning threshold. No value defined as default.
3452 vmware_crit | **Optional.** The critical threshold. No value defined as default.
3455 ## <a id="plugins-contrib-vmware-esx-soap-vm-net-receive"></a> vmware-esx-soap-vm-net-receive
3457 Check command object for the `check_vmware_esx` plugin. Receive in KBps(Kilobytes per Second).
3459 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
3462 ------------------------|--------------
3463 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. Conflicts with **vmware_host**.
3464 vmware_host | **Optional.** ESX or ESXi hostname. Conflicts with **vmware_datacenter**.
3465 vmware_vmname | **Required.** Virtual machine name.
3466 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
3467 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
3468 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
3469 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
3470 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
3471 vmware_sessionfile | **Optional.** Session file name enhancement.
3472 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
3473 vmware_nosession | **Optional.** No auth session - IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
3474 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
3475 vmware_password | **Optional.** The username's password. No value defined as default.
3476 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
3477 vmware_warn | **Optional.** The warning threshold. No value defined as default.
3478 vmware_crit | **Optional.** The critical threshold. No value defined as default.
3481 ## <a id="plugins-contrib-vmware-esx-soap-vm-net-send"></a> vmware-esx-soap-vm-net-send
3483 Check command object for the `check_vmware_esx` plugin. Send in KBps(Kilobytes per Second).
3485 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
3488 ------------------------|--------------
3489 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. Conflicts with **vmware_host**.
3490 vmware_host | **Optional.** ESX or ESXi hostname. Conflicts with **vmware_datacenter**.
3491 vmware_vmname | **Required.** Virtual machine name.
3492 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
3493 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
3494 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
3495 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
3496 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
3497 vmware_sessionfile | **Optional.** Session file name enhancement.
3498 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
3499 vmware_nosession | **Optional.** No auth session - IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
3500 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
3501 vmware_password | **Optional.** The username's password. No value defined as default.
3502 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
3503 vmware_warn | **Optional.** The warning threshold. No value defined as default.
3504 vmware_crit | **Optional.** The critical threshold. No value defined as default.
3507 ## <a id="plugins-contrib-vmware-esx-soap-vm-io"></a> vmware-esx-soap-vm-io
3509 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.
3511 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
3514 ------------------------|--------------
3515 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. Conflicts with **vmware_host**.
3516 vmware_host | **Optional.** ESX or ESXi hostname. Conflicts with **vmware_datacenter**.
3517 vmware_vmname | **Required.** Virtual machine name.
3518 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
3519 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
3520 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
3521 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
3522 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
3523 vmware_sessionfile | **Optional.** Session file name enhancement.
3524 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
3525 vmware_nosession | **Optional.** No auth session - IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
3526 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
3527 vmware_password | **Optional.** The username's password. No value defined as default.
3528 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
3531 ## <a id="plugins-contrib-vmware-esx-soap-vm-io-read"></a> vmware-esx-soap-vm-io-read
3533 Check command object for the `check_vmware_esx` plugin. Average number of kilobytes read from the disk each second.
3535 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
3538 ------------------------|--------------
3539 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. Conflicts with **vmware_host**.
3540 vmware_host | **Optional.** ESX or ESXi hostname. Conflicts with **vmware_datacenter**.
3541 vmware_vmname | **Required.** Virtual machine name.
3542 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
3543 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
3544 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
3545 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
3546 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
3547 vmware_sessionfile | **Optional.** Session file name enhancement.
3548 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
3549 vmware_nosession | **Optional.** No auth session - IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
3550 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
3551 vmware_password | **Optional.** The username's password. No value defined as default.
3552 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
3553 vmware_warn | **Optional.** The warning threshold. No value defined as default.
3554 vmware_crit | **Optional.** The critical threshold. No value defined as default.
3557 ## <a id="plugins-contrib-vmware-esx-soap-vm-io-write"></a> vmware-esx-soap-vm-io-write
3559 Check command object for the `check_vmware_esx` plugin. Average number of kilobytes written to disk each second.
3561 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
3564 ------------------------|--------------
3565 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. Conflicts with **vmware_host**.
3566 vmware_host | **Optional.** ESX or ESXi hostname. Conflicts with **vmware_datacenter**.
3567 vmware_vmname | **Required.** Virtual machine name.
3568 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
3569 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
3570 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
3571 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
3572 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
3573 vmware_sessionfile | **Optional.** Session file name enhancement.
3574 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
3575 vmware_nosession | **Optional.** No auth session - IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
3576 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
3577 vmware_password | **Optional.** The username's password. No value defined as default.
3578 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
3579 vmware_warn | **Optional.** The warning threshold. No value defined as default.
3580 vmware_crit | **Optional.** The critical threshold. No value defined as default.
3583 ## <a id="plugins-contrib-vmware-esx-soap-vm-io-usage"></a> vmware-esx-soap-vm-io-usage
3585 Check command object for the `check_vmware_esx` plugin. Aggregated disk I/O rate.
3587 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
3590 ------------------------|--------------
3591 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. Conflicts with **vmware_host**.
3592 vmware_host | **Optional.** ESX or ESXi hostname. Conflicts with **vmware_datacenter**.
3593 vmware_vmname | **Required.** Virtual machine name.
3594 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
3595 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
3596 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
3597 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
3598 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
3599 vmware_sessionfile | **Optional.** Session file name enhancement.
3600 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
3601 vmware_nosession | **Optional.** No auth session - IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
3602 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
3603 vmware_password | **Optional.** The username's password. No value defined as default.
3604 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
3605 vmware_warn | **Optional.** The warning threshold. No value defined as default.
3606 vmware_crit | **Optional.** The critical threshold. No value defined as default.
3609 ## <a id="plugins-contrib-vmware-esx-soap-vm-runtime"></a> vmware-esx-soap-vm-runtime
3611 Check command object for the `check_vmware_esx` plugin. Shows virtual machine runtime info.
3613 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
3616 ------------------------|--------------
3617 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. Conflicts with **vmware_host**.
3618 vmware_host | **Optional.** ESX or ESXi hostname. Conflicts with **vmware_datacenter**.
3619 vmware_vmname | **Required.** Virtual machine name.
3620 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
3621 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
3622 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
3623 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
3624 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
3625 vmware_sessionfile | **Optional.** Session file name enhancement.
3626 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
3627 vmware_nosession | **Optional.** No auth session - IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
3628 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
3629 vmware_password | **Optional.** The username's password. No value defined as default.
3630 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
3633 ## <a id="plugins-contrib-vmware-esx-soap-vm-runtime-con"></a> vmware-esx-soap-vm-runtime-con
3635 Check command object for the `check_vmware_esx` plugin. Shows the connection state.
3637 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
3640 ------------------------|--------------
3641 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. Conflicts with **vmware_host**.
3642 vmware_host | **Optional.** ESX or ESXi hostname. Conflicts with **vmware_datacenter**.
3643 vmware_vmname | **Required.** Virtual machine name.
3644 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
3645 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
3646 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
3647 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
3648 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
3649 vmware_sessionfile | **Optional.** Session file name enhancement.
3650 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
3651 vmware_nosession | **Optional.** No auth session - IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
3652 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
3653 vmware_password | **Optional.** The username's password. No value defined as default.
3654 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
3657 ## <a id="plugins-contrib-vmware-esx-soap-vm-runtime-powerstate"></a> vmware-esx-soap-vm-runtime-powerstate
3659 Check command object for the `check_vmware_esx` plugin. Shows virtual machine power state: poweredOn, poweredOff or suspended.
3661 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
3664 ------------------------|--------------
3665 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. Conflicts with **vmware_host**.
3666 vmware_host | **Optional.** ESX or ESXi hostname. Conflicts with **vmware_datacenter**.
3667 vmware_vmname | **Required.** Virtual machine name.
3668 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
3669 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
3670 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
3671 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
3672 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
3673 vmware_sessionfile | **Optional.** Session file name enhancement.
3674 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
3675 vmware_nosession | **Optional.** No auth session - IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
3676 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
3677 vmware_password | **Optional.** The username's password. No value defined as default.
3678 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
3681 ## <a id="plugins-contrib-vmware-esx-soap-vm-runtime-status"></a> vmware-esx-soap-vm-runtime-status
3683 Check command object for the `check_vmware_esx` plugin. Overall object status (gray/green/red/yellow).
3685 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
3688 ------------------------|--------------
3689 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. Conflicts with **vmware_host**.
3690 vmware_host | **Optional.** ESX or ESXi hostname. Conflicts with **vmware_datacenter**.
3691 vmware_vmname | **Required.** Virtual machine name.
3692 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
3693 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
3694 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
3695 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
3696 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
3697 vmware_sessionfile | **Optional.** Session file name enhancement.
3698 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
3699 vmware_nosession | **Optional.** No auth session - IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
3700 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
3701 vmware_password | **Optional.** The username's password. No value defined as default.
3702 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
3705 ## <a id="plugins-contrib-vmware-esx-soap-vm-runtime-consoleconnections"></a> vmware-esx-soap-vm-runtime-consoleconnections
3707 Check command object for the `check_vmware_esx` plugin. Console connections to virtual machine.
3709 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
3712 ------------------------|--------------
3713 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. Conflicts with **vmware_host**.
3714 vmware_host | **Optional.** ESX or ESXi hostname. Conflicts with **vmware_datacenter**.
3715 vmware_vmname | **Required.** Virtual machine name.
3716 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
3717 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
3718 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
3719 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
3720 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
3721 vmware_sessionfile | **Optional.** Session file name enhancement.
3722 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
3723 vmware_nosession | **Optional.** No auth session - IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
3724 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
3725 vmware_password | **Optional.** The username's password. No value defined as default.
3726 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
3727 vmware_warn | **Optional.** The warning threshold. No value defined as default.
3728 vmware_crit | **Optional.** The critical threshold. No value defined as default.
3731 ## <a id="plugins-contrib-vmware-esx-soap-vm-runtime-gueststate"></a> vmware-esx-soap-vm-runtime-gueststate
3733 Check command object for the `check_vmware_esx` plugin. Guest OS status. Needs VMware Tools installed and running.
3735 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
3738 ------------------------|--------------
3739 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. Conflicts with **vmware_host**.
3740 vmware_host | **Optional.** ESX or ESXi hostname. Conflicts with **vmware_datacenter**.
3741 vmware_vmname | **Required.** Virtual machine name.
3742 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
3743 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
3744 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
3745 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
3746 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
3747 vmware_sessionfile | **Optional.** Session file name enhancement.
3748 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
3749 vmware_nosession | **Optional.** No auth session - IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
3750 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
3751 vmware_password | **Optional.** The username's password. No value defined as default.
3752 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
3754 ## <a id="plugins-contrib-vmware-esx-soap-vm-runtime-tools"></a> vmware-esx-soap-vm-runtime-tools
3756 Check command object for the `check_vmware_esx` plugin. Guest OS status. VMware tools status.
3758 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
3761 ------------------------|--------------
3762 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. Conflicts with **vmware_host**.
3763 vmware_host | **Optional.** ESX or ESXi hostname. Conflicts with **vmware_datacenter**.
3764 vmware_vmname | **Required.** Virtual machine name.
3765 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
3766 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
3767 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
3768 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
3769 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
3770 vmware_sessionfile | **Optional.** Session file name enhancement.
3771 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
3772 vmware_nosession | **Optional.** No auth session - IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
3773 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
3774 vmware_password | **Optional.** The username's password. No value defined as default.
3775 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
3778 ## <a id="plugins-contrib-vmware-esx-soap-vm-runtime-issues"></a> vmware-esx-soap-vm-runtime-issues
3780 Check command object for the `check_vmware_esx` plugin. All issues for the virtual machine.
3782 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
3785 ------------------------|--------------
3786 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. Conflicts with **vmware_host**.
3787 vmware_host | **Optional.** ESX or ESXi hostname. Conflicts with **vmware_datacenter**.
3788 vmware_vmname | **Required.** Virtual machine name.
3789 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
3790 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
3791 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
3792 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
3793 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
3794 vmware_sessionfile | **Optional.** Session file name enhancement.
3795 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
3796 vmware_nosession | **Optional.** No auth session - IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
3797 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
3798 vmware_password | **Optional.** The username's password. No value defined as default.
3799 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
3800 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.
projects / icinga2 / blob