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 | **Required.** The command that should be executed. Can be an array if multiple arguments should be passed to `check_by_ssh`.
111 by_ssh_arguments| **Optional.** A dictionary with arguments for the command. This works exactly like the 'arguments' dictionary for ordinary CheckCommands.
112 by_ssh_logname | **Optional.** The SSH username.
113 by_ssh_identity | **Optional.** The SSH identity.
114 by_ssh_quiet | **Optional.** Whether to suppress SSH warnings. Defaults to false.
115 by_ssh_warn | **Optional.** The warning threshold.
116 by_ssh_crit | **Optional.** The critical threshold.
117 by_ssh_timeout | **Optional.** The timeout in seconds.
120 ## <a id="plugin-check-command-dhcp"></a> dhcp
122 Check command object for the `check_dhcp` plugin.
124 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
127 ----------------|--------------
128 dhcp_serverip | **Optional.** The IP address of the DHCP server which we should get a response from.
129 dhcp_requestedip| **Optional.** The IP address which we should be offered by a DHCP server.
130 dhcp_timeout | **Optional.** The timeout in seconds.
131 dhcp_interface | **Optional.** The interface to use.
132 dhcp_mac | **Optional.** The MAC address to use in the DHCP request.
133 dhcp_unicast | **Optional.** Whether to use unicast requests. Defaults to false.
136 ## <a id="plugin-check-command-dig"></a> dig
138 Check command object for the `check_dig` plugin.
140 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
143 ---------------------|--------------
144 dig_server | **Optional.** The DNS server to query. Defaults to "127.0.0.1".
145 dig_port | **Optional.** Port number (default: 53).
146 dig_lookup | **Optional.** The address that should be looked up.
147 dig_record_type | **Optional.** Record type to lookup (default: A).
148 dig_expected_address | **Optional.** An address expected to be in the answer section. If not set, uses whatever was in -l.
149 dig_arguments | **Optional.** Pass STRING as argument(s) to dig.
150 dig_retries | **Optional.** Number of retries passed to dig, timeout is divided by this value (Default: 3).
151 dig_warning | **Optional.** Response time to result in warning status (seconds).
152 dig_critical | **Optional.** Response time to result in critical status (seconds).
153 dig_timeout | **Optional.** Seconds before connection times out (default: 10).
156 ## <a id="plugin-check-command-disk"></a> disk
158 Check command object for the `check_disk` plugin.
162 > `disk_wfree` and `disk_cfree` require the percent sign compared to older versions.
163 > If omitted, disk units can be used. This has been changed in **2.3.0**.
165 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
168 ------------------------|------------------------
169 disk_wfree | **Optional.** The free space warning threshold. Defaults to "20%". If the percent sign is omitted, units from `disk_units` are used.
170 disk_cfree | **Optional.** The free space critical threshold. Defaults to "10%". If the percent sign is omitted, units from `disk_units` are used.
171 disk_inode_wfree | **Optional.** The free inode warning threshold.
172 disk_inode_cfree | **Optional.** The free inode critical threshold.
173 disk_partition | **Optional.** The partition. **Deprecated in 2.3.**
174 disk_partition_excluded | **Optional.** The excluded partition. **Deprecated in 2.3.**
175 disk_partitions | **Optional.** The partition(s). Multiple partitions must be defined as array.
176 disk_partitions_excluded | **Optional.** The excluded partition(s). Multiple partitions must be defined as array.
177 disk_clear | **Optional.** Clear thresholds.
178 disk_exact_match | **Optional.** For paths or partitions specified with -p, only check for exact paths.
179 disk_errors_only | **Optional.** Display only devices/mountpoints with errors. May be true or false.
180 disk_group | **Optional.** Group paths. Thresholds apply to (free-)space of all partitions together
181 disk_kilobytes | **Optional.** Same as --units kB. May be true or false.
182 disk_local | **Optional.** Only check local filesystems. May be true or false.
183 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
184 disk_mountpoint | **Optional.** Display the mountpoint instead of the partition. May be true or false.
185 disk_megabytes | **Optional.** Same as --units MB. May be true or false.
186 disk_all | **Optional.** Explicitly select all paths. This is equivalent to -R '.*'. May be true or false.
187 disk_eregi_path | **Optional.** Case insensitive regular expression for path/partition (may be repeated).
188 disk_ereg_path | **Optional.** Regular expression for path or partition (may be repeated).
189 disk_ignore_eregi_path | **Optional.** Regular expression to ignore selected path/partition (case insensitive) (may be repeated).
190 disk_ignore_ereg_path | **Optional.** Regular expression to ignore selected path or partition (may be repeated).
191 disk_timeout | **Optional.** Seconds before connection times out (default: 10).
192 disk_units | **Optional.** Choose bytes, kB, MB, GB, TB (default: MB).
193 disk_exclude_type | **Optional.** Ignore all filesystems of indicated type (may be repeated).
195 ## <a id="plugin-check-command-disk-smb"></a> disk_smb
197 Check command object for the `check_disk_smb` plugin.
201 > `disk_smb_wused` and `disk_smb_cused` require the percent sign. If omitted, disk units can be used.
203 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
206 ------------------------|------------------------
207 disk_smb_hostname | **Required.** NetBIOS name of the server.
208 disk_smb_share | **Required.** Share name being queried.
209 disk_smb_workgroup | **Optional.** Workgroup or Domain used (defaults to 'WORKGROUP' if omitted).
210 disk_smb_address | **Optional.** IP address of the host (only necessary if host belongs to another network).
211 disk_smb_username | **Optional.** Username for server log-in (defaults to 'guest' if omitted).
212 disk_smb_password | **Optional.** Password for server log-in (defaults to an empty password if omitted).
213 disk_smb_wused | **Optional.** The used space warning threshold. Defaults to "85%". If the percent sign is omitted, use optional disk units.
214 disk_smb_cused | **Optional.** The used space critical threshold. Defaults to "95%". If the percent sign is omitted, use optional disk units.
215 disk_smb_port | **Optional.** Connection port, e.g. `139` or `445`. Defaults to `smbclient` default if omitted.
217 ## <a id="plugin-check-command-dns"></a> dns
219 Check command object for the `check_dns` plugin.
221 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
224 ---------------------|--------------
225 dns_lookup | **Optional.** The hostname or IP to query the DNS for. Defaults to "$host_name$".
226 dns_server | **Optional.** The DNS server to query. Defaults to the server configured in the OS.
227 dns_expected_answer | **Optional.** The answer to look for. A hostname must end with a dot. **Deprecated in 2.3.**
228 dns_expected_answers | **Optional.** The answer(s) to look for. A hostname must end with a dot. Multiple answers must be defined as array.
229 dns_authoritative | **Optional.** Expect the server to send an authoritative answer.
230 dns_wtime | **Optional.** Return warning if elapsed time exceeds value.
231 dns_ctime | **Optional.** Return critical if elapsed time exceeds value.
232 dns_timeout | **Optional.** Seconds before connection times out. Defaults to 10.
235 ## <a id="plugin-check-command-dummy"></a> dummy
237 Check command object for the `check_dummy` plugin.
239 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
242 ----------------|--------------
243 dummy_state | **Optional.** The state. Can be one of 0 (ok), 1 (warning), 2 (critical) and 3 (unknown). Defaults to 0.
244 dummy_text | **Optional.** Plugin output. Defaults to "Check was successful.".
247 ## <a id="plugin-check-command-fping4"></a> fping4
249 Check command object for the `check_fping` plugin.
251 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
254 ----------------|--------------
255 fping_address | **Optional.** The host's IPv4 address. Defaults to "$address$".
256 fping_wrta | **Optional.** The RTA warning threshold in milliseconds. Defaults to 100.
257 fping_wpl | **Optional.** The packet loss warning threshold in %. Defaults to 5.
258 fping_crta | **Optional.** The RTA critical threshold in milliseconds. Defaults to 200.
259 fping_cpl | **Optional.** The packet loss critical threshold in %. Defaults to 15.
260 fping_number | **Optional.** The number of packets to send. Defaults to 5.
261 fping_interval | **Optional.** The interval between packets in milli-seconds. Defaults to 500.
262 fping_bytes | **Optional.** The size of ICMP packet.
263 fping_target_timeout | **Optional.** The target timeout in milli-seconds.
264 fping_source_ip | **Optional.** The name or ip address of the source ip.
265 fping_source_interface | **Optional.** The source interface name.
268 ## <a id="plugin-check-command-fping6"></a> fping6
270 Check command object for the `check_fping` plugin.
272 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
275 ----------------|--------------
276 fping_address | **Optional.** The host's IPv6 address. Defaults to "$address6$".
277 fping_wrta | **Optional.** The RTA warning threshold in milliseconds. Defaults to 100.
278 fping_wpl | **Optional.** The packet loss warning threshold in %. Defaults to 5.
279 fping_crta | **Optional.** The RTA critical threshold in milliseconds. Defaults to 200.
280 fping_cpl | **Optional.** The packet loss critical threshold in %. Defaults to 15.
281 fping_number | **Optional.** The number of packets to send. Defaults to 5.
282 fping_interval | **Optional.** The interval between packets in milli-seconds. Defaults to 500.
283 fping_bytes | **Optional.** The size of ICMP packet.
284 fping_target_timeout | **Optional.** The target timeout in milli-seconds.
285 fping_source_ip | **Optional.** The name or ip address of the source ip.
286 fping_source_interface | **Optional.** The source interface name.
289 ## <a id="plugin-check-command-ftp"></a> ftp
291 Check command object for the `check_ftp` plugin.
293 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
296 -------------------|--------------
297 ftp_address | **Optional.** The host's address. Defaults to "$address$" if the host's `address` attribute is set, "$address6$" otherwise.
298 ftp_port | **Optional.** The FTP port number.
299 ftp_expect | **Optional.** String to expect in server response (may be repeated).
300 ftp_all | **Optional.** All expect strings need to occur in server response. Defaults to false.
301 ftp_escape_send | **Optional.** Enable usage of \n, \r, \t or \\\\ in send string.
302 ftp_send | **Optional.** String to send to the server.
303 ftp_escape_quit | **Optional.** Enable usage of \n, \r, \t or \\\\ in quit string.
304 ftp_quit | **Optional.** String to send server to initiate a clean close of the connection.
305 ftp_refuse | **Optional.** Accept TCP refusals with states ok, warn, crit. Defaults to crit.
306 ftp_mismatch | **Optional.** Accept expected string mismatches with states ok, warn, crit. Defaults to warn.
307 ftp_jail | **Optional.** Hide output from TCP socket.
308 ftp_maxbytes | **Optional.** Close connection once more than this number of bytes are received.
309 ftp_delay | **Optional.** Seconds to wait between sending string and polling for response.
310 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.
311 ftp_ssl | **Optional.** Use SSL for the connection. Defaults to false.
312 ftp_wtime | **Optional.** Response time to result in warning status (seconds).
313 ftp_ctime | **Optional.** Response time to result in critical status (seconds).
314 ftp_timeout | **Optional.** Seconds before connection times out. Defaults to 10.
317 ## <a id="plugin-check-command-hostalive"></a> hostalive
319 Check command object for the `check_ping` plugin with host check default values. This variant
320 uses the host's `address` attribute if available and falls back to using the `address6` attribute
321 if the `address` attribute is not set.
323 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
326 ----------------|--------------
327 ping_address | **Optional.** The host's address. Defaults to "$address$" if the host's `address` attribute is set, "$address6$" otherwise.
328 ping_wrta | **Optional.** The RTA warning threshold in milliseconds. Defaults to 3000.
329 ping_wpl | **Optional.** The packet loss warning threshold in %. Defaults to 80.
330 ping_crta | **Optional.** The RTA critical threshold in milliseconds. Defaults to 5000.
331 ping_cpl | **Optional.** The packet loss critical threshold in %. Defaults to 100.
332 ping_packets | **Optional.** The number of packets to send. Defaults to 5.
333 ping_timeout | **Optional.** The plugin timeout in seconds. Defaults to 0 (no timeout).
336 ## <a id="plugin-check-command-hostalive4"></a> hostalive4
338 Check command object for the `check_ping` plugin with host check default values. This variant
339 uses the host's `address` attribute.
341 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
344 ----------------|--------------
345 ping_address | **Optional.** The host's IPv4 address. Defaults to "$address$".
346 ping_wrta | **Optional.** The RTA warning threshold in milliseconds. Defaults to 3000.
347 ping_wpl | **Optional.** The packet loss warning threshold in %. Defaults to 80.
348 ping_crta | **Optional.** The RTA critical threshold in milliseconds. Defaults to 5000.
349 ping_cpl | **Optional.** The packet loss critical threshold in %. Defaults to 100.
350 ping_packets | **Optional.** The number of packets to send. Defaults to 5.
351 ping_timeout | **Optional.** The plugin timeout in seconds. Defaults to 0 (no timeout).
354 ## <a id="plugin-check-command-hostalive6"></a> hostalive6
356 Check command object for the `check_ping` plugin with host check default values. This variant
357 uses the host's `address6` attribute.
359 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
362 ----------------|--------------
363 ping_address | **Optional.** The host's IPv6 address. Defaults to "$address6$".
364 ping_wrta | **Optional.** The RTA warning threshold in milliseconds. Defaults to 3000.
365 ping_wpl | **Optional.** The packet loss warning threshold in %. Defaults to 80.
366 ping_crta | **Optional.** The RTA critical threshold in milliseconds. Defaults to 5000.
367 ping_cpl | **Optional.** The packet loss critical threshold in %. Defaults to 100.
368 ping_packets | **Optional.** The number of packets to send. Defaults to 5.
369 ping_timeout | **Optional.** The plugin timeout in seconds. Defaults to 0 (no timeout).
372 ## <a id="plugin-check-command-hpjd"></a> hpjd
374 Check command object for the `check_hpjd` plugin.
376 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
379 ----------------|--------------
380 hpjd_address | **Optional.** The host's address. Defaults to "$address$" if the host's `address` attribute is set, "$address6$" otherwise.
381 hpjd_port | **Optional.** The host's SNMP port. Defaults to 161.
382 hpjd_community | **Optional.** The SNMP community. Defaults to "public".
385 ## <a id="plugin-check-command-http"></a> http
387 Check command object for the `check_http` plugin.
389 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
392 -------------------------|--------------
393 http_address | **Optional.** The host's address. Defaults to "$address$" if the host's `address` attribute is set, "$address6$" otherwise.
394 http_vhost | **Optional.** The virtual host that should be sent in the "Host" header.
395 http_uri | **Optional.** The request URI.
396 http_port | **Optional.** The TCP port. Defaults to 80 when not using SSL, 443 otherwise.
397 http_ssl | **Optional.** Whether to use SSL. Defaults to false.
398 http_sni | **Optional.** Whether to use SNI. Defaults to false.
399 http_auth_pair | **Optional.** Add 'username:password' authorization pair.
400 http_proxy_auth_pair | **Optional.** Add 'username:password' authorization pair for proxy.
401 http_ignore_body | **Optional.** Don't download the body, just the headers.
402 http_linespan | **Optional.** Allow regex to span newline.
403 http_expect_body_regex | **Optional.** A regular expression which the body must match against. Incompatible with http_ignore_body.
404 http_expect_body_eregi | **Optional.** A case-insensitive expression which the body must match against. Incompatible with http_ignore_body.
405 http_invertregex | **Optional.** Changes behaviour of http_expect_body_regex and http_expect_body_eregi to return CRITICAL if found, OK if not.
406 http_warn_time | **Optional.** The warning threshold.
407 http_critical_time | **Optional.** The critical threshold.
408 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.
409 http_certificate | **Optional.** Minimum number of days a certificate has to be valid. Port defaults to 443.
410 http_clientcert | **Optional.** Name of file contains the client certificate (PEM format).
411 http_privatekey | **Optional.** Name of file contains the private key (PEM format).
412 http_headerstring | **Optional.** String to expect in the response headers.
413 http_string | **Optional.** String to expect in the content.
414 http_post | **Optional.** URL encoded http POST data.
415 http_method | **Optional.** Set http method (for example: HEAD, OPTIONS, TRACE, PUT, DELETE).
416 http_maxage | **Optional.** Warn if document is more than seconds old.
417 http_contenttype | **Optional.** Specify Content-Type header when POSTing.
418 http_useragent | **Optional.** String to be sent in http header as User Agent.
419 http_header | **Optional.** Any other tags to be sent in http header.
420 http_extendedperfdata | **Optional.** Print additional perfdata. Defaults to false.
421 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)
422 http_pagesize | **Optional.** Minimum page size required:Maximum page size required.
423 http_timeout | **Optional.** Seconds before connection times out.
426 ## <a id="plugin-check-command-icmp"></a> icmp
428 Check command object for the `check_icmp` plugin.
430 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
433 ----------------|--------------
434 icmp_address | **Optional.** The host's address. This can either be a single address or an array of addresses. Defaults to "$address$".
435 icmp_wrta | **Optional.** The RTA warning threshold in milliseconds. Defaults to 100.
436 icmp_wpl | **Optional.** The packet loss warning threshold in %. Defaults to 5.
437 icmp_crta | **Optional.** The RTA critical threshold in milliseconds. Defaults to 200.
438 icmp_cpl | **Optional.** The packet loss critical threshold in %. Defaults to 15.
439 icmp_source | **Optional.** The source IP address to send packets from.
440 icmp_packets | **Optional.** The number of packets to send. Defaults to 5.
441 icmp_packet_interval | **Optional** The maximum packet interval. Defaults to 80 (milliseconds).
442 icmp_target_interval | **Optional.** The maximum target interval.
443 icmp_hosts_alive | **Optional.** The number of hosts which have to be alive for the check to succeed.
444 icmp_data_bytes | **Optional.** Payload size for each ICMP request. Defaults to 8.
445 icmp_timeout | **Optional.** The plugin timeout in seconds. Defaults to 10 (seconds).
448 ## <a id="plugin-check-command-imap"></a> imap
450 Check command object for the `check_imap` plugin.
452 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
455 ----------------|--------------
456 imap_address | **Optional.** The host's address. Defaults to "$address$" if the host's `address` attribute is set, "$address6$" otherwise.
457 imap_port | **Optional.** The port that should be checked. Defaults to 143.
460 ## <a id="plugin-check-command-ldap"></a> ldap
462 Check command object for the `check_ldap` plugin.
464 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
467 ----------------|--------------
468 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.
469 ldap_port | **Optional.** Port number. Defaults to 389.
470 ldap_attr | **Optional.** LDAP attribute to search for (default: "(objectclass=*)"
471 ldap_base | **Required.** LDAP base (eg. ou=myunit,o=myorg,c=at).
472 ldap_bind | **Optional.** LDAP bind DN (if required).
473 ldap_pass | **Optional.** LDAP password (if required).
474 ldap_starttls | **Optional.** Use STARTSSL mechanism introduced in protocol version 3.
475 ldap_ssl | **Optional.** Use LDAPS (LDAP v2 SSL method). This also sets the default port to 636.
476 ldap_v2 | **Optional.** Use LDAP protocol version 2 (enabled by default).
477 ldap_v3 | **Optional.** Use LDAP protocol version 3 (disabled by default)
478 ldap_warning | **Optional.** Response time to result in warning status (seconds).
479 ldap_critical | **Optional.** Response time to result in critical status (seconds).
480 ldap_timeout | **Optional.** Seconds before connection times out (default: 10).
481 ldap_verbose | **Optional.** Show details for command-line debugging (disabled by default)
483 ## <a id="plugin-check-command-load"></a> load
485 Check command object for the `check_load` plugin.
487 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
490 ----------------|--------------
491 load_wload1 | **Optional.** The 1-minute warning threshold. Defaults to 5.
492 load_wload5 | **Optional.** The 5-minute warning threshold. Defaults to 4.
493 load_wload15 | **Optional.** The 15-minute warning threshold. Defaults to 3.
494 load_cload1 | **Optional.** The 1-minute critical threshold. Defaults to 10.
495 load_cload5 | **Optional.** The 5-minute critical threshold. Defaults to 6.
496 load_cload15 | **Optional.** The 15-minute critical threshold. Defaults to 4.
497 load_percpu | **Optional.** Divide the load averages by the number of CPUs (when possible). Defaults to false.
500 ## <a id="plugin-check-command-nrpe"></a> nrpe
502 Check command object for the `check_nrpe` plugin.
504 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
507 ----------------|--------------
508 nrpe_address | **Optional.** The host's address. Defaults to "$address$" if the host's `address` attribute is set, "$address6$" otherwise.
509 nrpe_port | **Optional.** The NRPE port. Defaults to 5666.
510 nrpe_command | **Optional.** The command that should be executed.
511 nrpe_no_ssl | **Optional.** Whether to disable SSL or not. Defaults to `false`.
512 nrpe_timeout_unknown | **Optional.** Whether to set timeouts to unknown instead of critical state. Defaults to `false`.
513 nrpe_timeout | **Optional.** The timeout in seconds.
514 nrpe_arguments | **Optional.** Arguments that should be passed to the command. Multiple arguments must be defined as array.
515 nrpe_ipv4 | **Optional.** Use IPv4 only.
516 nrpe_ipv6 | **Optional.** Use IPv6 only.
519 ## <a id="plugin-check-command-nscp"></a> nscp
521 Check command object for the `check_nt` plugin.
523 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
526 ----------------|--------------
527 nscp_address | **Optional.** The host's address. Defaults to "$address$" if the host's `address` attribute is set, "$address6$" otherwise.
528 nscp_port | **Optional.** The NSClient++ port. Defaults to 12489.
529 nscp_password | **Optional.** The NSClient++ password.
530 nscp_variable | **Required.** The variable that should be checked.
531 nscp_params | **Optional.** Parameters for the query. Multiple parameters must be defined as array.
532 nscp_warn | **Optional.** The warning threshold.
533 nscp_crit | **Optional.** The critical threshold.
534 nscp_timeout | **Optional.** The query timeout in seconds.
535 nscp_showall | **Optional.** Use with SERVICESTATE to see working services or PROCSTATE for running processes. Defaults to false.
538 ## <a id="plugin-check-command-ntp-time"></a> ntp_time
540 Check command object for the `check_ntp_time` plugin.
542 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
545 ----------------|--------------
546 ntp_address | **Optional.** The host's address. Defaults to "$address$" if the host's `address` attribute is set, "$address6$" otherwise.
547 ntp_port | **Optional.** Port number (default: 123).
548 ntp_quit | **Optional.** Returns UNKNOWN instead of CRITICAL if offset cannot be found.
549 ntp_warning | **Optional.** Offset to result in warning status (seconds).
550 ntp_critical | **Optional.** Offset to result in critical status (seconds).
551 ntp_timeoffset | **Optional.** Expected offset of the ntp server relative to local server (seconds).
552 ntp_timeout | **Optional.** Seconds before connection times out (default: 10).
555 ## <a id="plugin-check-command-ntp-peer"></a> ntp_peer
557 Check command object for the `check_ntp_peer` plugin.
559 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
562 ----------------|--------------
563 ntp_address | **Optional.** The host's address. Defaults to "$address$" if the host's `address` attribute is set, "$address6$" otherwise.
564 ntp_port | **Optional.** The port to use. Default to 123.
565 ntp_warning | **Optional.** Offset to result in warning status (seconds).
566 ntp_critical | **Optional.** Offset to result in critical status (seconds).
567 ntp_wstratum | **Optional.** Warning threshold for stratum of server's synchronization peer.
568 ntp_cstratum | **Optional.** Critical threshold for stratum of server's synchronization peer.
569 ntp_wjitter | **Optional.** Warning threshold for jitter.
570 ntp_cjitter | **Optional.** Critical threshold for jitter.
571 ntp_wsource | **Optional.** Warning threshold for number of usable time sources.
572 ntp_csource | **Optional.** Critical threshold for number of usable time sources.
573 ntp_timeout | **Optional.** Seconds before connection times out (default: 10).
576 ## <a id="plugin-check-command-passive"></a> passive
578 Specialised check command object for passive checks executing the `check_dummy` plugin with appropriate default values.
580 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
583 ----------------|--------------
584 dummy_state | **Optional.** The state. Can be one of 0 (ok), 1 (warning), 2 (critical) and 3 (unknown). Defaults to 3.
585 dummy_text | **Optional.** Plugin output. Defaults to "No Passive Check Result Received.".
588 ## <a id="plugin-check-command-ping"></a> ping
590 Check command object for the `check_ping` plugin. This command uses the host's `address` attribute
591 if available and falls back to using the `address6` attribute if the `address` attribute is not set.
594 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
597 ----------------|--------------
598 ping_address | **Optional.** The host's address. Defaults to "$address$" if the host's `address` attribute is set, "$address6$" otherwise.
599 ping_wrta | **Optional.** The RTA warning threshold in milliseconds. Defaults to 100.
600 ping_wpl | **Optional.** The packet loss warning threshold in %. Defaults to 5.
601 ping_crta | **Optional.** The RTA critical threshold in milliseconds. Defaults to 200.
602 ping_cpl | **Optional.** The packet loss critical threshold in %. Defaults to 15.
603 ping_packets | **Optional.** The number of packets to send. Defaults to 5.
604 ping_timeout | **Optional.** The plugin timeout in seconds. Defaults to 0 (no timeout).
607 ## <a id="plugin-check-command-ping4"></a> ping4
609 Check command object for the `check_ping` plugin.
611 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
614 ----------------|--------------
615 ping_address | **Optional.** The host's IPv4 address. Defaults to "$address$".
616 ping_wrta | **Optional.** The RTA warning threshold in milliseconds. Defaults to 100.
617 ping_wpl | **Optional.** The packet loss warning threshold in %. Defaults to 5.
618 ping_crta | **Optional.** The RTA critical threshold in milliseconds. Defaults to 200.
619 ping_cpl | **Optional.** The packet loss critical threshold in %. Defaults to 15.
620 ping_packets | **Optional.** The number of packets to send. Defaults to 5.
621 ping_timeout | **Optional.** The plugin timeout in seconds. Defaults to 0 (no timeout).
623 ## <a id="plugin-check-command-ping6"></a> ping6
625 Check command object for the `check_ping` plugin.
627 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
630 ----------------|--------------
631 ping_address | **Optional.** The host's IPv6 address. Defaults to "$address6$".
632 ping_wrta | **Optional.** The RTA warning threshold in milliseconds. Defaults to 100.
633 ping_wpl | **Optional.** The packet loss warning threshold in %. Defaults to 5.
634 ping_crta | **Optional.** The RTA critical threshold in milliseconds. Defaults to 200.
635 ping_cpl | **Optional.** The packet loss critical threshold in %. Defaults to 15.
636 ping_packets | **Optional.** The number of packets to send. Defaults to 5.
637 ping_timeout | **Optional.** The plugin timeout in seconds. Defaults to 0 (no timeout).
640 ## <a id="plugin-check-command-pop"></a> pop
642 Check command object for the `check_pop` plugin.
644 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
647 ----------------|--------------
648 pop_address | **Optional.** The host's address. Defaults to "$address$" if the host's `address` attribute is set, "$address6$" otherwise.
649 pop_port | **Optional.** The port that should be checked. Defaults to 110.
652 ## <a id="plugin-check-command-processes"></a> procs
654 Check command object for the `check_procs` plugin.
656 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
659 ---------------------|--------------
660 procs_warning | **Optional.** The process count warning threshold. Defaults to 250.
661 procs_critical | **Optional.** The process count critical threshold. Defaults to 400.
662 procs_metric | **Optional.** Check thresholds against metric.
663 procs_timeout | **Optional.** Seconds before plugin times out.
664 procs_traditional | **Optional.** Filter own process the traditional way by PID instead of /proc/pid/exe. Defaults to false.
665 procs_state | **Optional.** Only scan for processes that have one or more of the status flags you specify.
666 procs_ppid | **Optional.** Only scan for children of the parent process ID indicated.
667 procs_vsz | **Optional.** Only scan for processes with VSZ higher than indicated.
668 procs_rss | **Optional.** Only scan for processes with RSS higher than indicated.
669 procs_pcpu | **Optional.** Only scan for processes with PCPU higher than indicated.
670 procs_user | **Optional.** Only scan for processes with user name or ID indicated.
671 procs_argument | **Optional.** Only scan for processes with args that contain STRING.
672 procs_argument_regex | **Optional.** Only scan for processes with args that contain the regex STRING.
673 procs_command | **Optional.** Only scan for exact matches of COMMAND (without path).
674 procs_nokthreads | **Optional.** Only scan for non kernel threads. Defaults to false.
677 ## <a id="plugin-check-command-simap"></a> simap
679 Check command object for the `check_simap` plugin.
681 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
684 ----------------|--------------
685 simap_address | **Optional.** The host's address. Defaults to "$address$" if the host's `address` attribute is set, "$address6$" otherwise.
686 simap_port | **Optional.** The host's port.
689 ## <a id="plugin-check-command-smtp"></a> smtp
691 Check command object for the `check_smtp` plugin.
693 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
696 ----------------------|--------------
697 smtp_address | **Optional.** The host's address. Defaults to "$address$" if the host's `address` attribute is set, "$address6$" otherwise.
698 smtp_port | **Optional.** The port that should be checked. Defaults to 25.
699 smtp_mail_from | **Optional.** Test a MAIL FROM command with the given email address.
700 smtp_expect | **Optional.** String to expect in first line of server response (default: '220').
701 smtp_command | **Optional.** SMTP command (may be used repeatedly).
702 smtp_response | **Optional.** Expected response to command (may be used repeatedly).
703 smtp_helo_fqdn | **Optional.** FQDN used for HELO
704 smtp_certificate_age | **Optional.** Minimum number of days a certificate has to be valid.
705 smtp_starttls | **Optional.** Use STARTTLS for the connection.
706 smtp_authtype | **Optional.** SMTP AUTH type to check (default none, only LOGIN supported).
707 smtp_authuser | **Optional.** SMTP AUTH username.
708 smtp_authpass | **Optional.** SMTP AUTH password.
709 smtp_ignore_quit | **Optional.** Ignore failure when sending QUIT command to server.
710 smtp_warning | **Optional.** Response time to result in warning status (seconds).
711 smtp_critical | **Optional.** Response time to result in critical status (seconds).
712 smtp_timeout | **Optional.** Seconds before connection times out (default: 10).
715 ## <a id="plugin-check-command-snmp"></a> snmp
717 Check command object for the `check_snmp` plugin.
719 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
722 --------------------|--------------
723 snmp_address | **Optional.** The host's address. Defaults to "$address$" if the host's `address` attribute is set, "$address6$" otherwise.
724 snmp_oid | **Required.** The SNMP OID.
725 snmp_community | **Optional.** The SNMP community. Defaults to "public".
726 snmp_warn | **Optional.** The warning threshold.
727 snmp_crit | **Optional.** The critical threshold.
728 snmp_string | **Optional.** Return OK state if the string matches exactly with the output value
729 snmp_ereg | **Optional.** Return OK state if extended regular expression REGEX matches with the output value
730 snmp_eregi | **Optional.** Return OK state if case-insensitive extended REGEX matches with the output value
731 snmp_label | **Optional.** Prefix label for output value
732 snmp_invert_search | **Optional.** Invert search result and return CRITICAL state if found
733 snmp_units | **Optional.** Units label(s) for output value (e.g., 'sec.').
734 snmp_version | **Optional.** Version to use. E.g. 1, 2, 2c or 3.
735 snmp_miblist | **Optional.** MIB's to use, comma separated. Defaults to "ALL".
736 snmp_rate_multiplier | **Optional.** Converts rate per second. For example, set to 60 to convert to per minute.
737 snmp_rate | **Optional.** Boolean. Enable rate calculation.
738 snmp_getnext | **Optional.** Boolean. Use SNMP GETNEXT. Defaults to false.
739 snmp_timeout | **Optional.** The command timeout in seconds. Defaults to 10 seconds.
741 ## <a id="plugin-check-command-snmpv3"></a> snmpv3
743 Check command object for the `check_snmp` plugin, using SNMPv3 authentication and encryption options.
745 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
748 ---------------------|--------------
749 snmpv3_address | **Optional.** The host's address. Defaults to "$address$" if the host's `address` attribute is set, "$address6$" otherwise.
750 snmpv3_getnext | **Optional.** Use SNMP GETNEXT instead of SNMP GET.
751 snmpv3_seclevel | **Optional.** The security level. Defaults to authPriv.
752 snmpv3_auth_alg | **Optional.** The authentication algorithm. Defaults to SHA.
753 snmpv3_user | **Required.** The username to log in with.
754 snmpv3_auth_key | **Required,** The authentication key. Required if `snmpv3_seclevel` is set to `authPriv` otherwise optional.
755 snmpv3_priv_key | **Required.** The encryption key.
756 snmpv3_oid | **Required.** The SNMP OID.
757 snmpv3_priv_alg | **Optional.** The encryption algorithm. Defaults to AES.
758 snmpv3_warn | **Optional.** The warning threshold.
759 snmpv3_crit | **Optional.** The critical threshold.
760 snmpv3_string | **Optional.** Return OK state (for that OID) if STRING is an exact match.
761 snmpv3_ereg | **Optional.** Return OK state (for that OID) if extended regular expression REGEX matches.
762 snmpv3_eregi | **Optional.** Return OK state (for that OID) if case-insensitive extended REGEX matches.
763 snmpv3_invert_search | **Optional.** Invert search result and return CRITICAL if found
764 snmpv3_label | **Optional.** Prefix label for output value.
766 ## <a id="plugin-check-command-snmp-uptime"></a> snmp-uptime
768 Check command object for the `check_snmp` plugin.
770 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
773 ----------------|--------------
774 snmp_address | **Optional.** The host's address. Defaults to "$address$" if the host's `address` attribute is set, "$address6$" otherwise.
775 snmp_oid | **Optional.** The SNMP OID. Defaults to "1.3.6.1.2.1.1.3.0".
776 snmp_community | **Optional.** The SNMP community. Defaults to "public".
779 ## <a id="plugin-check-command-spop"></a> spop
781 Check command object for the `check_spop` plugin.
783 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
786 ----------------|--------------
787 spop_address | **Optional.** The host's address. Defaults to "$address$" if the host's `address` attribute is set, "$address6$" otherwise.
788 spop_port | **Optional.** The host's port.
791 ## <a id="plugin-check-command-ssh"></a> ssh
793 Check command object for the `check_ssh` plugin.
795 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
798 ----------------|--------------
799 ssh_address | **Optional.** The host's address. Defaults to "$address$" if the host's `address` attribute is set, "$address6$" otherwise.
800 ssh_port | **Optional.** The port that should be checked. Defaults to 22.
801 ssh_timeout | **Optional.** Seconds before connection times out. Defaults to 10.
804 ## <a id="plugin-check-command-ssl"></a> ssl
806 Check command object for the `check_tcp` plugin, using ssl-related options.
808 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
811 ------------------------------|--------------
812 ssl_address | **Optional.** The host's address. Defaults to "$address$" if the host's `address` attribute is set, "$address6$" otherwise.
813 ssl_port | **Required.** The port that should be checked.
814 ssl_timeout | **Optional.** Timeout in seconds for the connect and handshake. The plugin default is 10 seconds.
815 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.
816 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.
819 ## <a id="plugin-check-command-ssmtp"></a> ssmtp
821 Check command object for the `check_ssmtp` plugin.
823 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
826 ----------------|--------------
827 ssmtp_address | **Required.** The host's address. Defaults to "$address$" if the host's `address` attribute is set, "$address6$" otherwise.
828 ssmtp_port | **Optional.** The port that should be checked. Defaults to 465.
831 ## <a id="plugin-check-command-swap"></a> swap
833 Check command object for the `check_swap` plugin.
835 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
838 ----------------|--------------
839 swap_wfree | **Optional.** The free swap space warning threshold in %. Defaults to 50.
840 swap_cfree | **Optional.** The free swap space critical threshold in %. Defaults to 25.
843 ## <a id="plugin-check-command-tcp"></a> tcp
845 Check command object for the `check_tcp` plugin.
847 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
850 ----------------|--------------
851 tcp_address | **Optional.** The host's address. Defaults to "$address$" if the host's `address` attribute is set, "$address6$" otherwise.
852 tcp_port | **Required.** The port that should be checked.
853 tcp_expect | **Optional.** String to expect in server response (may be repeated).
854 tcp_all | **Optional.** All expect strings need to occur in server response. Defaults to false.
855 tcp_escape_send | **Optional.** Enable usage of \n, \r, \t or \\\\ in send string.
856 tcp_send | **Optional.** String to send to the server.
857 tcp_escape_quit | **Optional.** Enable usage of \n, \r, \t or \\\\ in quit string.
858 tcp_quit | **Optional.** String to send server to initiate a clean close of the connection.
859 tcp_refuse | **Optional.** Accept TCP refusals with states ok, warn, crit. Defaults to crit.
860 tcp_mismatch | **Optional.** Accept expected string mismatches with states ok, warn, crit. Defaults to warn.
861 tcp_jail | **Optional.** Hide output from TCP socket.
862 tcp_maxbytes | **Optional.** Close connection once more than this number of bytes are received.
863 tcp_delay | **Optional.** Seconds to wait between sending string and polling for response.
864 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.
865 tcp_ssl | **Optional.** Use SSL for the connection. Defaults to false.
866 tcp_wtime | **Optional.** Response time to result in warning status (seconds).
867 tcp_ctime | **Optional.** Response time to result in critical status (seconds).
868 tcp_timeout | **Optional.** Seconds before connection times out. Defaults to 10.
871 ## <a id="plugin-check-command-udp"></a> udp
873 Check command object for the `check_udp` plugin.
875 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
878 ----------------|--------------
879 udp_address | **Optional.** The host's address. Defaults to "$address$" if the host's `address` attribute is set, "$address6$" otherwise.
880 udp_port | **Required.** The port that should be checked.
881 udp_send | **Required.** The payload to send in the UDP datagram.
882 udp_expect | **Required.** The payload to expect in the response datagram.
883 udp_quit | **Optional.** The payload to send to 'close' the session.
886 ## <a id="plugin-check-command-ups"></a> ups
888 Check command object for the `check_ups` plugin.
890 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
893 ----------------|--------------
894 ups_address | **Required.** The address of the host running upsd. Defaults to "$address$" if the host's `address` attribute is set, "$address6$" otherwise.
895 ups_name | **Required.** The UPS name. Defaults to `ups`.
896 ups_port | **Optional.** The port to which to connect. Defaults to 3493.
897 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`.
898 ups_warning | **Optional.** The warning threshold for the selected variable.
899 ups_critical | **Optional.** The critical threshold for the selected variable.
900 ups_celsius | **Optional.** Display the temperature in degrees Celsius instead of Fahrenheit. Defaults to `false`.
901 ups_timeout | **Optional.** The number of seconds before the connection times out. Defaults to 10.
904 ## <a id="plugin-check-command-users"></a> users
906 Check command object for the `check_users` plugin.
908 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
911 ----------------|--------------
912 users_wgreater | **Optional.** The user count warning threshold. Defaults to 20.
913 users_cgreater | **Optional.** The user count critical threshold. Defaults to 50.
916 ## <a id="plugin-check-command-clamd"></a> clamd
918 Check command object for the `check_clamd` plugin.
920 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
923 -------------------|--------------
924 clamd_address | **Required.** The host's address or unix socket (must be an absolute path).
925 clamd_port | **Optional.** Port number (default: none).
926 clamd_expect | **Optional.** String to expect in server response (may be repeated).
927 clamd_all | **Optional.** All expect strings need to occur in server response. Defaults to false.
928 clamd_escape_send | **Optional.** Enable usage of \n, \r, \t or \\\\ in send string.
929 clamd_send | **Optional.** String to send to the server.
930 clamd_escape_quit | **Optional.** Enable usage of \n, \r, \t or \\\\ in quit string.
931 clamd_quit | **Optional.** String to send server to initiate a clean close of the connection.
932 clamd_refuse | **Optional.** Accept TCP refusals with states ok, warn, crit. Defaults to crit.
933 clamd_mismatch | **Optional.** Accept expected string mismatches with states ok, warn, crit. Defaults to warn.
934 clamd_jail | **Optional.** Hide output from TCP socket.
935 clamd_maxbytes | **Optional.** Close connection once more than this number of bytes are received.
936 clamd_delay | **Optional.** Seconds to wait between sending string and polling for response.
937 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.
938 clamd_ssl | **Optional.** Use SSL for the connection. Defaults to false.
939 clamd_wtime | **Optional.** Response time to result in warning status (seconds).
940 clamd_ctime | **Optional.** Response time to result in critical status (seconds).
941 clamd_timeout | **Optional.** Seconds before connection times out. Defaults to 10.
944 ## <a id="plugin-check-command-mailq"></a> mailq
946 Check command object for the `check_mailq` plugin.
948 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
951 ------------------------|--------------
952 mailq_warning | **Required.** Min. number of messages in queue to generate warning.
953 mailq_critical | **Required.** Min. number of messages in queue to generate critical alert ( w < c ).
954 mailq_domain_warning | **Optional.** Min. number of messages for same domain in queue to generate warning
955 mailq_domain_critical | **Optional.** Min. number of messages for same domain in queue to generate critical alert ( W < C ).
956 mailq_timeout | **Optional.** Plugin timeout in seconds (default = 15).
957 mailq_servertype | **Optional.** [ sendmail | qmail | postfix | exim | nullmailer ] (default = autodetect).
960 ## <a id="plugin-check-command-pgsql"></a> pgsql
962 Check command object for the `check_pgsql` plugin.
964 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
967 ------------------------|---------------------------------------------------------------
968 pgsql_hostname | **Optional.** Host name, IP Address, or unix socket (must be an absolute path).
969 pgsql_port | **Optional.** Port number (default: 5432).
970 pgsql_database | **Optional.** Database to check (default: template1).
971 pgsql_username | **Optional.** Login name of user.
972 pgsql_password | **Optional.** Password (BIG SECURITY ISSUE).
973 pgsql_options | **Optional.** Connection parameters (keyword = value), see below.
974 pgsql_warning | **Optional.** Response time to result in warning status (seconds).
975 pgsql_critical | **Optional.** Response time to result in critical status (seconds).
976 pgsql_timeout | **Optional.** Seconds before connection times out (default: 10).
977 pgsql_query | **Optional.** SQL query to run. Only first column in first row will be read.
978 pgsql_query_warning | **Optional.** SQL query value to result in warning status (double).
979 pgsql_query_critical | **Optional.** SQL query value to result in critical status (double).
982 # <a id="windows-plugins"></a>Icinga 2 Windows plugins
984 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.
986 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:
988 include <windows-plugins>
990 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.
993 ## <a id="windows-plugins-thresholds"></a>Threshold syntax
995 So not specified differently the thresholds for the plugins all follow the same pattern
998 :------------|:----------
999 "29" | The threshold is 29.
1000 "!29" | The threshold is 29, but the negative of the result is returned.
1001 "[10-40]" | The threshold is a range from (including) 20 to 40, a value inside means the threshold has been exceeded.
1002 "![10-40]" | Same as above, but the result is inverted.
1005 ## <a id="windows-plugins-disk-windows"></a>disk-windows
1007 Check command object for the `check_disk.exe` plugin.
1008 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.).
1013 :---------------|:------------
1014 disk\_win\_warn | **Optional**. The warning threshold.
1015 disk\_win\_crit | **Optional**. The critical threshold.
1016 disk\_win\_path | **Optional**. Check only these paths, default checks all.
1017 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.
1020 ## <a id="windows-plugins-load-windows"></a>load-windows
1022 Check command object for the `check_load.exe` plugin.
1023 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).
1028 :---------------|:------------
1029 load\_win\_warn | **Optional**. The warning threshold.
1030 load\_win\_crit | **Optional**. The critical threshold.
1033 ## <a id="windows-plugins-memory-windows"></a>memory-windows
1035 Check command object for the `check_memory.exe` plugin.
1036 The memory collection is instant.
1041 :-----------------|:------------
1042 memory\_win\_warn | **Optional**. The warning threshold.
1043 memory\_win\_crit | **Optional**. The critical threshold.
1044 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.
1047 ## <a id="windows-plugins-network-windows"></a>network-windows
1049 Check command object for the `check_network.exe` plugin.
1050 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).
1055 :------------------|:------------
1056 network\_win\_warn | **Optional**. The warning threshold.
1057 network\_win\_crit | **Optional**. The critical threshold.
1060 ## <a id="windows-plugins-permon-windows"></a>perfmon-windows
1062 Check command object for the `check_perfmon.exe` plugin.
1063 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`.
1065 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"`
1070 :---------------------|:------------
1071 perfmon\_win\_warn | **Optional**. The warning threshold.
1072 perfmon\_win\_crit | **Optional**. The critical threshold.
1073 perfmon\_win\_counter | **Required**. The Performance Counter to use. Ex. `\Processor(_Total)\% Idle Time`.
1074 perfmon\_win\_wait | **Optional**. Time in milliseconds to wait between data collection (default: 1000).
1075 perfmon\_win\_type | **Optional**. Format in which to expect perfomance values. Possible are: long, int64 and double (default).
1078 ## <a id="windows-plugins-ping-windows"></a>ping-windows
1080 Check command object for the `check_ping.exe` plugin.
1081 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.
1086 :------------------|:------------
1087 ping\_win\_warn | **Optional**. The warning threshold. RTA and package loss seperated by comma.
1088 ping\_win\_crit | **Optional**. The critical threshold. RTA and package loss seperated by comma.
1089 ping\_win\_address | **Required**. An IPv4 or IPv6 address
1090 ping\_win\_packets | **Optional**. Number of packages to send. Default: 5.
1091 ping\_win\_timeout | **Optional**. The timeout in milliseconds. Default: 1000
1094 ## <a id="windows-plugins-procs-windows"></a>procs-windows
1096 Check command object for `check_procs.exe` plugin.
1097 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.
1102 :----------------|:------------
1103 procs\_win\_warn | **Optional**. The warning threshold.
1104 procs\_win\_crit | **Optional**. The critical threshold.
1105 procs\_win\_user | **Optional**. Count this useres processes.
1108 ## <a id="windows-plugins-service-windows"></a>service-windows
1110 Check command object for `check_service.exe` plugin.
1111 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.
1116 :---------------------|:------------
1117 service\_win\_warn | **Optional**. Warn when service is not running.
1118 service\_win\_service | **Required**. The critical threshold.
1121 ## <a id="windows-plugins-swap-windows"></a>swap-windows
1123 Check command object for `check_swap.exe` plugin.
1124 The data collection is instant.
1129 :---------------|:------------
1130 swap\_win\_warn | **Optional**. The warning threshold.
1131 swap\_win\_crit | **Optional**. The critical threshold.
1132 swap\_win\_unit | **Optional**. The unit to display the received value in, thresholds are interpreted in this unit. Defaults to "mb" (megabyte).
1135 ## <a id="windows-plugins-update-windows"></a>update-windows
1137 Check command object for `check_update.exe` plugin.
1138 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.
1142 > The Network Services Account which runs Icinga 2 by default does not have the required
1143 > permissions to run this check.
1148 :-------------------|:------------
1149 update\_win\_warn | If set returns warning when important updates are available
1150 update\_win\_crit | If set return critical when important updates that require a reboot are available.
1151 update\_win\_reboot | Set to treat 'may need update' as 'definitely needs update'
1154 ## <a id="windows-plugins-uptime-windows"></a>uptime-windows
1156 Check command opject for `check_uptime.exe` plugin.
1157 Uses GetTickCount64 to get the uptime, so boot time is not included.
1162 :-----------------|:------------
1163 uptime\_win\_warn | **Optional**. The warning threshold.
1164 uptime\_win\_crit | **Optional**. The critical threshold.
1165 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).
1168 ## <a id="windows-plugins-users-windows"></a>users-windows
1170 Check command object for `check_users.exe` plugin.
1175 :----------------|:------------
1176 users\_win\_warn | **Optional**. The warning threshold.
1177 users\_win\_crit | **Optional**. The critical threshold.
1180 # <a id="nscp-plugin-check-commands"></a> NSClient++ Check Commands
1182 Icinga 2 can use the `nscp client` command to run arbitrary NSClient++ checks.
1184 You can enable these check commands by adding the following the include directive in your
1185 [icinga2.conf](4-configuring-icinga-2.md#icinga2-conf) configuration file:
1189 You can also optionally specify an alternative installation directory for NSClient++ by adding
1190 the NscpPath constant in your [constants.conf](4-configuring-icinga-2.md#constants-conf) configuration
1193 const NscpPath = "C:\\Program Files (x86)\\NSClient++"
1195 By default Icinga 2 uses the Microsoft Installer API to determine where NSClient++ is installed. It should
1196 not be necessary to manually set this constant.
1198 Note that it is not necessary to run NSClient++ as a Windows service for these commands to work.
1200 ## <a id="nscp-check-local"></a> nscp-local
1202 Check command object for NSClient++
1204 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
1207 ----------------|--------------
1208 nscp_log_level | **Optional.** The log level. Defaults to "critical".
1209 nscp_load_all | **Optional.** Whether to load all modules. Defaults to true.
1210 nscp_boot | **Optional.** Whether to use the --boot option. Defaults to true.
1211 nscp_query | **Required.** The NSClient++ query. Try `nscp client -q x` for a list.
1212 nscp_arguments | **Optional.** An array of query arguments.
1214 ## <a id="nscp-check-local-cpu"></a> nscp-local-cpu
1216 Check command object for the `check_cpu` NSClient++ plugin.
1218 This command has the same custom attributes like the `nscp-local` check command.
1220 ## <a id="nscp-check-local-memory"></a> nscp-local-memory
1222 Check command object for the `check_memory` NSClient++ plugin.
1224 This command has the same custom attributes like the `nscp-local` check command.
1226 ## <a id="nscp-check-local-os-version"></a> nscp-local-os-version
1228 Check command object for the `check_os_version` NSClient++ plugin.
1230 This command has the same custom attributes like the `nscp-local` check command.
1232 ## <a id="nscp-check-local-pagefile"></a> nscp-local-pagefile
1234 Check command object for the `check_pagefile` NSClient++ plugin.
1236 This command has the same custom attributes like the `nscp-local` check command.
1238 ## <a id="nscp-check-local-process"></a> nscp-local-process
1240 Check command object for the `check_process` NSClient++ plugin.
1242 This command has the same custom attributes like the `nscp-local` check command.
1244 ## <a id="nscp-check-local-service"></a> nscp-local-service
1246 Check command object for the `check_service` NSClient++ plugin.
1248 This command has the same custom attributes like the `nscp-local` check command.
1250 ## <a id="nscp-check-local-uptime"></a> nscp-local-uptime
1252 Check command object for the `check_uptime` NSClient++ plugin.
1254 This command has the same custom attributes like the `nscp-local` check command.
1256 ## <a id="nscp-check-local-version"></a> nscp-local-version
1258 Check command object for the `check_version` NSClient++ plugin.
1260 This command has the same custom attributes like the `nscp-local` check command.
1262 ## <a id="nscp-check-local-disk"></a> nscp-local-disk
1264 Check command object for the `check_drivesize` NSClient++ plugin.
1266 This command has the same custom attributes like the `nscp-local` check command.
1268 ## <a id="nscp-check-local-counter"></a> nscp-local-counter
1270 Check command object for the `check_pdh` NSClient++ plugin.
1272 This command has the same custom attributes like the `nscp-local` check command.
1274 # <a id="snmp-manubulon-plugin-check-commands"></a> SNMP Manubulon Plugin Check Commands
1276 The `SNMP Manubulon Plugin Check Commands` provide example configuration for plugin check
1277 commands provided by the [SNMP Manubulon project](http://nagios.manubulon.com/index_snmp.html).
1279 The SNMP manubulon plugin check commands assume that the global constant named `ManubulonPluginDir`
1280 is set to the path where the Manubublon SNMP plugins are installed.
1282 You can enable these plugin check commands by adding the following the include directive in your
1283 [icinga2.conf](4-configuring-icinga-2.md#icinga2-conf) configuration file:
1287 ## Checks by Host Type
1289 **N/A** : Not available for this type.
1291 **SNMP** : Available for simple SNMP query.
1295 **Specific** : Script name for platform specific checks.
1298 Host type | Interface | storage | load/cpu | mem | process | env | specific
1299 ------------------------|------------|----------|-----------|-----|----------|-----|-------------------------
1300 Linux | Yes | Yes | Yes | Yes | Yes | No |
1301 Windows | Yes | Yes | Yes | Yes | Yes | No | check_snmp_win.pl
1302 Cisco router/switch | Yes | N/A | Yes | Yes | N/A | Yes |
1303 HP router/switch | Yes | N/A | Yes | Yes | N/A | No |
1304 Bluecoat proxy | Yes | SNMP | Yes | SNMP| No | Yes |
1305 CheckPoint on SPLAT | Yes | Yes | Yes | Yes | Yes | No | check_snmp_cpfw.pl
1306 CheckPoint on Nokia IP | Yes | Yes | Yes | No | ?? | No | check_snmp_vrrp.pl
1307 Boostedge | Yes | Yes | Yes | Yes | ?? | No | check_snmp_boostedge.pl
1308 AS400 | Yes | Yes | Yes | Yes | No | No |
1309 NetsecureOne Netbox | Yes | Yes | Yes | ?? | Yes | No |
1310 Radware Linkproof | Yes | N/A | SNMP | SNMP| No | No | check_snmp_linkproof_nhr <br> check_snmp_vrrp.pl
1311 IronPort | Yes | SNMP | SNMP | SNMP| No | Yes |
1312 Cisco CSS | Yes | ?? | Yes | Yes | No | ?? | check_snmp_css.pl
1315 ## <a id="plugin-check-command-snmp-load"></a> snmp-load
1317 Check command object for the [check_snmp_load.pl](http://nagios.manubulon.com/snmp_load.html) plugin.
1319 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
1323 ------------------------|--------------
1324 snmp_address | **Optional.** The host's address. Defaults to "$address$" if the host's `address` attribute is set, "$address6$" otherwise.
1325 snmp_nocrypt | **Optional.** Define SNMP encryption. If set **snmp_v3** needs to be set. Defaults to false.
1326 snmp_community | **Optional.** The SNMP community. Defaults to "public".
1327 snmp_port | **Optional.** The SNMP port connection.
1328 snmp_v2 | **Optional.** SNMP version to 2c. Defaults to false.
1329 snmp_v3 | **Optional.** SNMP version to 3. Defaults to false.
1330 snmp_login | **Optional.** SNMP version 3 username. Defaults to "snmpuser".
1331 snmp_password | **Required.** SNMP version 3 password. No value defined as default.
1332 snmp_v3_use_privpass | **Optional.** Define to use SNMP version 3 priv password. Defaults to false.
1333 snmp_authprotocol | **Optional.** SNMP version 3 authentication protocol. Defaults to "md5,des".
1334 snmp_privpass | **Required.** SNMP version 3 priv password. No value defined as default.
1335 snmp_warn | **Optional.** The warning threshold. Change the `snmp_load_type` var to "netsl" for using 3 values.
1336 snmp_crit | **Optional.** The critical threshold. Change the `snmp_load_type` var to "netsl" for using 3 values.
1337 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.
1338 snmp_perf | **Optional.** Enable perfdata values. Defaults to true.
1339 snmp_timeout | **Optional.** The command timeout in seconds. Defaults to 5 seconds.
1341 ## <a id="plugin-check-command-snmp-memory"></a> snmp-memory
1343 Check command object for the [check_snmp_mem.pl](http://nagios.manubulon.com/snmp_mem.html) plugin.
1345 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
1348 ------------------------|--------------
1349 snmp_address | **Optional.** The host's address. Defaults to "$address$" if the host's `address` attribute is set, "$address6$" otherwise.
1350 snmp_nocrypt | **Optional.** Define SNMP encryption. If set **snmp_v3** needs to be set. Defaults to false.
1351 snmp_community | **Optional.** The SNMP community. Defaults to "public".
1352 snmp_port | **Optional.** The SNMP port connection.
1353 snmp_v2 | **Optional.** SNMP version to 2c. Defaults to false.
1354 snmp_v3 | **Optional.** SNMP version to 3. Defaults to false.
1355 snmp_login | **Optional.** SNMP version 3 username. Defaults to "snmpuser".
1356 snmp_password | **Required.** SNMP version 3 password. No value defined as default.
1357 snmp_v3_use_privpass | **Optional.** Define to use SNMP version 3 priv password. Defaults to false.
1358 snmp_authprotocol | **Optional.** SNMP version 3 authentication protocol. Defaults to "md5,des".
1359 snmp_privpass | **Required.** SNMP version 3 priv password. No value defined as default.
1360 snmp_warn | **Optional.** The warning threshold.
1361 snmp_crit | **Optional.** The critical threshold.
1362 snmp_is_cisco | **Optional.** Change OIDs for Cisco switches. Defaults to false.
1363 snmp_perf | **Optional.** Enable perfdata values. Defaults to true.
1364 snmp_timeout | **Optional.** The command timeout in seconds. Defaults to 5 seconds.
1366 ## <a id="plugin-check-command-snmp-storage"></a> snmp-storage
1368 Check command object for the [check_snmp_storage.pl](http://nagios.manubulon.com/snmp_storage.html) plugin.
1370 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
1373 ------------------------|--------------
1374 snmp_address | **Optional.** The host's address. Defaults to "$address$" if the host's `address` attribute is set, "$address6$" otherwise.
1375 snmp_nocrypt | **Optional.** Define SNMP encryption. If set **snmp_v3** needs to be set. Defaults to false.
1376 snmp_community | **Optional.** The SNMP community. Defaults to "public".
1377 snmp_port | **Optional.** The SNMP port connection.
1378 snmp_v2 | **Optional.** SNMP version to 2c. Defaults to false.
1379 snmp_v3 | **Optional.** SNMP version to 3. Defaults to false.
1380 snmp_login | **Optional.** SNMP version 3 username. Defaults to "snmpuser".
1381 snmp_password | **Required.** SNMP version 3 password. No value defined as default.
1382 snmp_v3_use_privpass | **Optional.** Define to use SNMP version 3 priv password. Defaults to false.
1383 snmp_authprotocol | **Optional.** SNMP version 3 authentication protocol. Defaults to "md5,des".
1384 snmp_privpass | **Required.** SNMP version 3 priv password. No value defined as default.
1385 snmp_warn | **Optional.** The warning threshold.
1386 snmp_crit | **Optional.** The critical threshold.
1387 snmp_storage_name | **Optional.** Storage name. Default to regex "^/$$". More options available in the [snmp storage](http://nagios.manubulon.com/snmp_storage.html) documentation.
1388 snmp_perf | **Optional.** Enable perfdata values. Defaults to true.
1389 snmp_timeout | **Optional.** The command timeout in seconds. Defaults to 5 seconds.
1391 ## <a id="plugin-check-command-snmp-interface"></a> snmp-interface
1393 Check command object for the [check_snmp_int.pl](http://nagios.manubulon.com/snmp_int.html) plugin.
1395 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
1398 ----------------------------|--------------
1399 snmp_address | **Optional.** The host's address. Defaults to "$address$" if the host's `address` attribute is set, "$address6$" otherwise.
1400 snmp_nocrypt | **Optional.** Define SNMP encryption. If set **snmp_v3** needs to be set. Defaults to false.
1401 snmp_community | **Optional.** The SNMP community. Defaults to "public".
1402 snmp_port | **Optional.** The SNMP port connection.
1403 snmp_v2 | **Optional.** SNMP version to 2c. Defaults to false.
1404 snmp_v3 | **Optional.** SNMP version to 3. Defaults to false.
1405 snmp_login | **Optional.** SNMP version 3 username. Defaults to "snmpuser".
1406 snmp_password | **Required.** SNMP version 3 password. No value defined as default.
1407 snmp_v3_use_privpass | **Optional.** Define to use SNMP version 3 priv password. Defaults to false.
1408 snmp_authprotocol | **Optional.** SNMP version 3 authentication protocol. Defaults to "md5,des".
1409 snmp_privpass | **Required.** SNMP version 3 priv password. No value defined as default.
1410 snmp_warn | **Optional.** The warning threshold.
1411 snmp_crit | **Optional.** The critical threshold.
1412 snmp_interface | **Optional.** Network interface name. Default to regex "eth0".
1413 snmp_interface_perf | **Optional.** Check the input/ouput bandwidth of the interface. Defaults to true.
1414 snmp_interface_label | **Optional.** Add label before speed in output: in=, out=, errors-out=, etc...
1415 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.
1416 snmp_interface_percent | **Optional.** Output performance data in % of max speed. Defaults to false.
1417 snmp_interface_kbits | **Optional.** Make the warning and critical levels in KBits/s. Defaults to true.
1418 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.
1419 snmp_interface_64bit | **Optional.** Use 64 bits counters instead of the standard counters when checking bandwidth & performance data for interface >= 1Gbps. Defaults to false.
1420 snmp_interface_errors | **Optional.** Add error & discard to Perfparse output. Defaults to true.
1421 snmp_interface_noregexp | **Optional.** Do not use regexp to match interface name in description OID. Defaults to false.
1422 snmp_interface_delta | **Optional.** Delta time of perfcheck. Defaults to "300" (5 min).
1423 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.
1424 snmp_perf | **Optional.** Enable perfdata values. Defaults to true.
1425 snmp_timeout | **Optional.** The command timeout in seconds. Defaults to 5 seconds.
1427 ## <a id="plugin-check-command-snmp-process"></a> snmp-process
1429 Check command object for the [check_snmp_process.pl](http://nagios.manubulon.com/snmp_process.html) plugin.
1431 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
1434 ------------------------|--------------
1435 snmp_address | **Optional.** The host's address. Defaults to "$address$" if the host's `address` attribute is set, "$address6$" otherwise.
1436 snmp_nocrypt | **Optional.** Define SNMP encryption. If set **snmp_v3** needs to be set. Defaults to false.
1437 snmp_community | **Optional.** The SNMP community. Defaults to "public".
1438 snmp_port | **Optional.** The SNMP port connection.
1439 snmp_v2 | **Optional.** SNMP version to 2c. Defaults to false.
1440 snmp_v3 | **Optional.** SNMP version to 3. Defaults to false.
1441 snmp_login | **Optional.** SNMP version 3 username. Defaults to "snmpuser".
1442 snmp_password | **Required.** SNMP version 3 password. No value defined as default.
1443 snmp_v3_use_privpass | **Optional.** Define to use SNMP version 3 priv password. Defaults to false.
1444 snmp_authprotocol | **Optional.** SNMP version 3 authentication protocol. Defaults to "md5,des".
1445 snmp_privpass | **Required.** SNMP version 3 priv password. No value defined as default..
1446 snmp_warn | **Optional.** The warning threshold.
1447 snmp_crit | **Optional.** The critical threshold.
1448 snmp_process_name | **Optional.** Name of the process (regexp). No trailing slash!. Defaults to ".*".
1449 snmp_perf | **Optional.** Enable perfdata values. Defaults to true.
1450 snmp_timeout | **Optional.** The command timeout in seconds. Defaults to 5 seconds.
1452 # <a id="plugins-contrib"></a> Plugins Contrib
1454 The Plugins contrib collects various contributed command definitions.
1456 These check commands assume that the global constant named `PluginContribDir`
1457 is set to the path where the user installs custom plugins and can be enabled by uncommenting the corresponding line in icinga2.conf.
1459 ## <a id="plugins-contrib-databases"></a> Databases
1461 All database plugins go in this category.
1463 ### <a id="plugins-contrib-command-mssql_health"></a> mssql_health
1465 The plugin `mssql_health` utilises Perl DBD::Sybase based on FreeTDS to connect to MSSQL databases for monitoring.
1466 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).
1468 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
1471 ---------------------------------|------------------------------------------------------------------------------------------------------------------------------
1472 mssql_health_hostname | **Optional.** Specifies the database hostname or address. No default because you typically use "mssql_health_server".
1473 mssql_health_port | **Optional.** Specifies the database port. No default because you typically use "mssql_health_server".
1474 mssql_health_server | **Optional.** The name of a predefined connection (in freetds.conf).
1475 mssql_health_currentdb | **Optional.** The name of a database which is used as the current database for the connection.
1476 mssql_health_username | **Optional.** The username for the database connection.
1477 mssql_health_password | **Optional.** The password for the database connection.
1478 mssql_health_warning | **Optional.** The warning threshold depending on the mode.
1479 mssql_health_critical | **Optional.** The critical threshold depending on the mode.
1480 mssql_health_mode | **Required.** The mode uses predefined keywords for the different checks. For example "connection-time", "database-free" or "sql".
1481 mssql_health_name | **Optional.** Depending on the mode this could be the database name or a SQL statement.
1482 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.
1483 mssql_health_regexp | **Optional.** If set to true, "mssql_health_name" will be interpreted as a regular expression. Defaults to false.
1484 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".
1485 mssql_health_offlineok | **Optional.** Set this to true, if offline databases are perfectly ok for you. Defaults to false.
1486 mssql_health_commit | **Optional.** Set this to true to turn on autocommit for the dbd::sybase module. Defaults to false.
1488 ### <a id="plugins-contrib-command-mysql_health"></a> mysql_health
1490 The plugin `mysql_health` utilises Perl DBD::MySQL to connect to MySQL databases for monitoring.
1491 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).
1493 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
1496 ---------------------------------|------------------------------------------------------------------------------------------------------------------------------
1497 mysql_health_hostname | **Required.** Specifies the database hostname or address. Defaults to "$address$" or "$address6$" if the `address` attribute is not set.
1498 mysql_health_port | **Optional.** Specifies the database port. Defaults to 3306 (or 1186 for "mysql_health_mode" cluster).
1499 mysql_health_socket | **Optional.** Specifies the database unix socket. No default.
1500 mysql_health_username | **Optional.** The username for the database connection.
1501 mysql_health_password | **Optional.** The password for the database connection.
1502 mysql_health_database | **Optional.** The database to connect to. Defaults to information_schema.
1503 mysql_health_warning | **Optional.** The warning threshold depending on the mode.
1504 mysql_health_critical | **Optional.** The critical threshold depending on the mode.
1505 mysql_health_mode | **Required.** The mode uses predefined keywords for the different checks. For example "connection-time", "slave-lag" or "sql".
1506 mysql_health_name | **Optional.** The SQL statement to be executed with "mysql_health_mode" sql.
1507 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.
1508 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".
1509 mysql_health_labelformat | **Optional.** One of those formats pnp4nagios or groundwork. Defaults to pnp4nagios.
1511 ### <a id="plugins-contrib-command-oracle_health"></a> oracle_health
1513 The plugin `oracle_health` utilises Perl DBD::Oracle based on oracle-instantclient-sdk or sqlplus to connect to Oracle databases for monitoring.
1514 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).
1516 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
1519 ---------------------------------|------------------------------------------------------------------------------------------------------------------------------
1520 oracle_health_connect | **Required.** Specifies the database connection string (from tnsnames.ora).
1521 oracle_health_username | **Optional.** The username for the database connection.
1522 oracle_health_password | **Optional.** The password for the database connection.
1523 oracle_health_warning | **Optional.** The warning threshold depending on the mode.
1524 oracle_health_critical | **Optional.** The critical threshold depending on the mode.
1525 oracle_health_mode | **Required.** The mode uses predefined keywords for the different checks. For example "connection-time", "flash-recovery-area-usage" or "sql".
1526 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.
1527 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.
1528 oracle_health_regexp | **Optional.** If set to true, "oracle_health_name" will be interpreted as a regular expression. Defaults to false.
1529 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".
1530 oracle_health_ident | **Optional.** If set to true outputs instance and database names. Defaults to false.
1531 oracle_health_commit | **Optional.** Set this to true to turn on autocommit for the dbd::oracle module. Defaults to false.
1532 oracle_health_noperfdata | **Optional.** Set this to true if you want to disable perfdata. Defaults to false.
1537 --------------------|------------------------------------------------------------------------------------------------------------------------------------------
1538 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".
1539 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".
1541 ### <a id="plugins-contrib-command-postgres"></a> postgres
1543 The plugin `postgres` utilises the psql binary to connect to PostgreSQL databases for monitoring.
1544 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).
1546 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
1549 ---------------------------------|------------------------------------------------------------------------------------------------------------------------------
1550 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.
1551 postgres_port | **Optional.** Specifies the database port. Defaults to 5432.
1552 postgres_dbname | **Optional.** Specifies the database name to connect to. Defaults to "postgres" or "template1".
1553 postgres_dbuser | **Optional.** The username for the database connection. Defaults to "postgres".
1554 postgres_dbpass | **Optional.** The password for the database connection. You can use a .pgpass file instead.
1555 postgres_dbservice | **Optional.** Specifies the service name to use inside of pg_service.conf.
1556 postgres_warning | **Optional.** Specifies the warning threshold, range depends on the action.
1557 postgres_critical | **Optional.** Specifies the critical threshold, range depends on the action.
1558 postgres_include | **Optional.** Specifies name(s) items to specifically include (e.g. tables), depends on the action.
1559 postgres_exclude | **Optional.** Specifies name(s) items to specifically exclude (e.g. tables), depends on the action.
1560 postgres_includeuser | **Optional.** Include objects owned by certain users.
1561 postgres_excludeuser | **Optional.** Exclude objects owned by certain users.
1562 postgres_standby | **Optional.** Assume that the server is in continious WAL recovery mode if set to true. Defaults to false.
1563 postgres_production | **Optional.** Assume that the server is in production mode if set to true. Defaults to false.
1564 postgres_action | **Required.** Determines the test executed.
1565 postgres_unixsocket | **Optional.** If "postgres_unixsocket" is set to true the unix socket is used instead of an address. Defaults to false.
1567 ### <a id="plugins-contrib-command-mongodb"></a> mongodb
1569 The plugin `mongodb` utilises Python PyMongo.
1570 For development check [https://github.com](https://github.com/mzupan/nagios-plugin-mongodb).
1572 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
1575 ---------------------------------|------------------------------------------------------------------------------------------------------------------------------
1576 mongodb_host | **Required.** Specifies the hostname or address.
1577 mongodb_port | **Required.** The port mongodb is runnung on.
1578 mongodb_user | **Optional.** The username you want to login as
1579 mongodb_passwd | **Optional.** The password you want to use for that user
1580 mongodb_warning | **Optional.** The warning threshold we want to set
1581 mongodb_critical | **Optional.** The critical threshold we want to set
1582 mongodb_action | **Required.** The action you want to take
1583 mongodb_maxlag | **Optional.** Get max replication lag (for replication_lag action only)
1584 mongodb_mappedmemory | **Optional.** Get mapped memory instead of resident (if resident memory can not be read)
1585 mongodb_perfdata | **Optional.** Enable output of Nagios performance data
1586 mongodb_database | **Optional.** Specify the database to check
1587 mongodb_alldatabases | **Optional.** Check all databases (action database_size)
1588 mongodb_ssl | **Optional.** Connect using SSL
1589 mongodb_replicaset | **Optional.** Connect to replicaset
1590 mongodb_querytype | **Optional.** The query type to check [query|insert|update|delete|getmore|command] from queries_per_second
1591 mongodb_collection | **Optional.** Specify the collection to check
1592 mongodb_sampletime | **Optional.** Time used to sample number of pages faults
1594 ### <a id="plugins-contrib-command-elasticsearch"></a> elasticsearch
1596 An [ElasticSearch](https://www.elastic.co/products/elasticsearch) availability
1597 and performance monitoring plugin available for download at [GitHub](https://github.com/anchor/nagios-plugin-elasticsearch).
1598 The plugin requires the HTTP API enabled on your ElasticSearch node.
1601 -----------------------------|-------------------------------------------------------------------------------------------------------
1602 elasticsearch_failuredomain | **Optional.** A comma-separated list of ElasticSearch attributes that make up your cluster's failure domain.
1603 elasticsearch_host | **Optional.** Hostname or network address to probe. Defaults to 'localhost'.
1604 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.
1605 elasticsearch_port | **Optional.** TCP port to probe. The ElasticSearch API should be listening here. Defaults to 9200.
1606 elasticsearch_prefix | **Optional.** Optional prefix (e.g. 'es') for the ElasticSearch API. Defaults to ''.
1607 elasticsearch_yellowcritical | **Optional.** Instead of issuing a 'warning' for a yellow cluster state, issue a 'critical' alert. Defaults to false.
1609 ### <a id="plugins-contrib-command-redis"></a> redis
1611 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).
1612 It is provided by `William Leibzon` at [https://github.com](https://github.com/willixix/naglio-plugins/blob/master/check_redis.pl).
1615 -------------------------|--------------------------------------------------------------------------------------------------------------
1616 redis_hostname | **Required.** Hostname or IP Address to check. Defaults to "127.0.0.1".
1617 redis_port | **Optional.** Port number to query. Default to "6379".
1618 redis_database | **Optional.** Database name (usually a number) to query, needed for **redis_query**.
1619 redis_password | **Optional.** Password for Redis authentication. Safer alternative is to put them in a file and use **redis_credentials**.
1620 redis_credentials | **Optional.** Credentials file to read for Redis authentication.
1621 redis_timeout | **Optional.** Allows to set timeout for execution of this plugin.
1622 redis_variables | **Optional.** List of variables from info data to do threshold checks on.
1623 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.
1624 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.
1625 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.
1626 redis_perfvars | **Optional.** This allows to list variables which values will go only into perfparse output (and not for threshold checking).
1627 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.
1628 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".
1629 redis_query | **Optional.** Option specifies key to query and optional variable name to assign the results to after.
1630 redis_option | **Optional.** Specifiers are separated by "," and must include NAME or PATTERN.
1631 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.
1632 redis_hitrate | **Optional.** Calculates Hitrate and specify values are interpreted as WARNING and CRITICAL thresholds.
1633 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.
1634 redis_total_memory | **Optional.** Amount of memory on a system for memory utilization calculation. Use system memory or max_memory setting of redis.
1635 redis_replication_delay | **Optional.** Allows to set threshold on replication delay info.
1637 ## <a id="plugins-contrib-ipmi"></a> IPMI Devices
1639 This category includes all plugins for IPMI devices.
1641 ### <a id="plugins-contrib-command-ipmi-sensor"></a> ipmi-sensor
1643 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.
1645 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
1648 ---------------------------------|-----------------------------------------------------------------------------------------------------
1649 ipmi_address | **Required.** Specifies the remote host (IPMI device) to check. Defaults to "$address$".
1650 ipmi_config_file | **Optional.** Path to the FreeIPMI configuration file. It should contain IPMI username, IPMI password, and IPMI privilege-level.
1651 ipmi_username | **Optional.** The IPMI username.
1652 ipmi_password | **Optional.** The IPMI password.
1653 ipmi_privilege_level | **Optional.** The IPMI privilege level of the IPMI user.
1654 ipmi_backward_compatibility_mode | **Optional.** Enable backward compatibility mode, useful for FreeIPMI 0.5.* (this omits FreeIPMI options "--quiet-cache" and "--sdr-cache-recreate").
1655 ipmi_sensor_type | **Optional.** Limit sensors to query based on IPMI sensor type. Examples for IPMI sensor types are 'Fan', 'Temperature' and 'Voltage'.
1656 ipmi_exclude_sensor_id | **Optional.** Exclude sensor matching ipmi_sensor_id.
1657 ipmi_sensor_id | **Optional.** Include sensor matching ipmi_sensor_id.
1658 ipmi_protocal_lan_version | **Optional.** Change the protocol LAN version. Defaults to "LAN_2_0".
1659 ipmi_number_of_active_fans | **Optional.** Number of fans that should be active. Otherwise a WARNING state is returned.
1660 ipmi_show_fru | **Optional.** Print the product serial number if it is available in the IPMI FRU data.
1661 ipmi_no_sel_checking | **Optional.** Turn off system event log checking via ipmi-sel.
1663 ## <a id="plugins-contrib-network-components"></a> Network Components
1665 This category includes all plugins for various network components like routers, switches and firewalls.
1667 ### <a id="plugins-contrib-command-interfacetable"></a> interfacetable
1669 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).
1671 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
1674 ------------------------------------|-----------------------------------------------------------------------------------------------------
1675 interfacetable_hostquery | **Required.** Specifies the remote host to poll. Defaults to "$address$".
1676 interfacetable_hostdisplay | **Optional.** Specifies the hostname to display in the HTML link. Defaults to "$host.display_name$".
1677 interfacetable_regex | **Optional.** Interface names and property names for some other options will be interpreted as regular expressions. Defaults to false.
1678 interfacetable_outputshort | **Optional.** Reduce the verbosity of the plugin output. Defaults to false.
1679 interfacetable_exclude | **Optional.** Comma separated list of interfaces globally excluded from the monitoring.
1680 interfacetable_include | **Optional.** Comma separated list of interfaces globally included in the monitoring.
1681 interfacetable_aliasmatching | **Optional.** Allow you to specify alias in addition to interface names. Defaults to false.
1682 interfacetable_excludetraffic | **Optional.** Comma separated list of interfaces excluded from traffic checks.
1683 interfacetable_includetraffic | **Optional.** Comma separated list of interfaces included for traffic checks.
1684 interfacetable_warningtraffic | **Optional.** Interface traffic load percentage leading to a warning alert.
1685 interfacetable_criticaltraffic | **Optional.** Interface traffic load percentage leading to a critical alert.
1686 interfacetable_pkt | **Optional.** Add unicast/non-unicast pkt stats for each interface.
1687 interfacetable_trackproperty | **Optional.** List of tracked properties.
1688 interfacetable_excludeproperty | **Optional.** Comma separated list of interfaces excluded from the property tracking.
1689 interfacetable_includeproperty | **Optional.** Comma separated list of interfaces included in the property tracking.
1690 interfacetable_community | **Optional.** Specifies the snmp v1/v2c community string. Defaults to "public" if using snmp v1/v2c, ignored using v3.
1691 interfacetable_snmpv2 | **Optional.** Use snmp v2c. Defaults to false.
1692 interfacetable_login | **Optional.** Login for snmpv3 authentication.
1693 interfacetable_passwd | **Optional.** Auth password for snmpv3 authentication.
1694 interfacetable_privpass | **Optional.** Priv password for snmpv3 authentication.
1695 interfacetable_protocols | **Optional.** Authentication protocol,Priv protocol for snmpv3 authentication.
1696 interfacetable_domain | **Optional.** SNMP transport domain.
1697 interfacetable_contextname | **Optional.** Context name for the snmp requests.
1698 interfacetable_port | **Optional.** SNMP port. Defaults to standard port.
1699 interfacetable_64bits | **Optional.** Use SNMP 64-bits counters. Defaults to false.
1700 interfacetable_maxrepetitions | **Optional.** Increasing this value may enhance snmp query performances by gathering more results at one time.
1701 interfacetable_snmptimeout | **Optional.** Define the Transport Layer timeout for the snmp queries.
1702 interfacetable_snmpretries | **Optional.** Define the number of times to retry sending a SNMP message.
1703 interfacetable_unixsnmp | **Optional.** Use unix snmp utilities for snmp requests. Defaults to false, which means use the perl bindings.
1704 interfacetable_enableperfdata | **Optional.** Enable port performance data. Defaults to false.
1705 interfacetable_perfdataformat | **Optional.** Define which performance data will be generated. Possible values are "full" (default), "loadonly", "globalonly".
1706 interfacetable_perfdatathreshold | **Optional.** Define which thresholds are printed in the generated performance data. Possible values are "full" (default), "loadonly", "globalonly".
1707 interfacetable_perfdatadir | **Optional.** When specified, the performance data are also written directly to a file, in the specified location.
1708 interfacetable_perfdataservicedesc | **Optional.** Specify additional parameters for output performance data to PNP. Defaults to "$service.name$", only affects **interfacetable_perfdatadir**.
1709 interfacetable_grapher | **Optional.** Specify the used graphing solution. Possible values are "pnp4nagios" (default), "nagiosgrapher", "netwaysgrapherv2" and "ingraph".
1710 interfacetable_grapherurl | **Optional.** Graphing system url. Default depends on **interfacetable_grapher**.
1711 interfacetable_portperfunit | **Optional.** Traffic could be reported in bits (counters) or in bps (calculated value).
1712 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".
1713 interfacetable_duplex | **Optional.** Add the duplex mode property for each interface in the interface table. Defaults to false.
1714 interfacetable_stp | **Optional.** Add the stp state property for each interface in the interface table. Defaults to false.
1715 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"
1716 interfacetable_noipinfo | **Optional.** Remove the ip information for each interface from the interface table. Defaults to false.
1717 interfacetable_alias | **Optional.** Add the alias information for each interface in the interface table. Defaults to false.
1718 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.
1719 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.
1720 interfacetable_delta | **Optional.** Set the delta used for interface throuput calculation in seconds.
1721 interfacetable_ifs | **Optional.** Input field separator. Defaults to ",".
1722 interfacetable_cache | **Optional.** Define the retention time of the cached data in seconds.
1723 interfacetable_noifloadgradient | **Optional.** Disable color gradient from green over yellow to red for the load percentage. Defaults to false.
1724 interfacetable_nohuman | **Optional.** Do not translate bandwidth usage in human readable format. Defaults to false.
1725 interfacetable_snapshot | **Optional.** Force the plugin to run like if it was the first launch. Defaults to false.
1726 interfacetable_timeout | **Optional.** Define the global timeout limit of the plugin in seconds. Defaults to "15s".
1727 interfacetable_css | **Optional.** Define the css stylesheet used by the generated html files. Possible values are "classic", "icinga", "icinga-alternate1" or "nagiosxi".
1728 interfacetable_config | **Optional.** Specify a config file to load.
1729 interfacetable_noconfigtable | **Optional.** Disable configuration table on the generated HTML page. Defaults to false.
1730 interfacetable_notips | **Optional.** Disable the tips in the generated html tables. Defaults to false.
1731 interfacetable_defaulttablesorting | **Optional.** Default table sorting can be "index" (default) or "name".
1732 interfacetable_tablesplit | **Optional.** Generate multiple interface tables, one per interface type. Defaults to false.
1733 interfacetable_notype | **Optional.** Remove the interface type for each interface. Defaults to false.
1735 ### <a id="plugins-contrib-command-iftraffic"></a> iftraffic
1737 The plugin [check_iftraffic](https://exchange.icinga.org/exchange/iftraffic)
1738 checks the utilization of a given interface name using the SNMP protocol.
1740 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
1743 ------------------------|---------------------------------------------------------
1744 iftraffic_address | **Required.** Specifies the remote host. Defaults to "$address$".
1745 iftraffic_community | **Optional.** SNMP community. Defaults to "public'" if omitted.
1746 iftraffic_interface | **Required.** Queried interface name.
1747 iftraffic_bandwidth | **Required.** Interface maximum speed in kilo/mega/giga/bits per second.
1748 iftraffic_units | **Optional.** Interface units can be one of these values: `g` (gigabits/s),`m` (megabits/s), `k` (kilobits/s),`b` (bits/s)
1749 iftraffic_warn | **Optional.** Percent of bandwidth usage necessary to result in warning status (defaults to `85%`).
1750 iftraffic_crit | **Optional.** Percent of bandwidth usage necessary to result in critical status (defaults to `98%`).
1751 iftraffic_max_counter | **Optional.** Maximum counter value of net devices in kilo/mega/giga/bytes.
1753 ### <a id="plugins-contrib-command-interfaces"></a> interfaces
1755 The plugin [check_interfaces](https://www.netways.org/projects/check-interfaces)
1756 Check interfaces and utilization.
1758 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
1761 --------------------------|---------------------------------------------------------
1762 interfaces_address | **Optional.** The host's address. Defaults to "$address$" if the host's `address` attribute is set, "$address6$" otherwise.
1763 interfaces_regex | **Optional.** Interface list regexp.
1764 interfaces_exclude_regex | **Optional.** Interface list negative regexp.
1765 interfaces_errors | **Optional.** Number of in errors (CRC errors for cisco) to consider a warning (default 50).
1766 interface_out_errors | **Optional.** Number of out errors (collisions for cisco) to consider a warning (default same as in errors).
1767 interfaces_perfdata | **Optional.** perfdata from last check result.
1768 interfaces_prefix | **Optional.** Prefix interface names with this label.
1769 interfaces_lastcheck | **Optional.** Last checktime (unixtime).
1770 interfaces_bandwidth | **Optional.** Bandwidth warn level in percent.
1771 interfaces_speed | **Optional.** Override speed detection with this value (bits per sec).
1772 interfaces_trim | **Optional.** Cut this number of characters from the start of interface descriptions.
1773 interfaces_mode | **Optional.** Special operating mode (default,cisco,nonbulk,bintec).
1774 interfaces_auth_proto | **Optional.** SNMPv3 Auth Protocol (SHA|MD5)
1775 interfaces_auth_phrase | **Optional.** SNMPv3 Auth Phrase
1776 interfaces_priv_proto | **Optional.** SNMPv3 Privacy Protocol (AES|DES)
1777 interfaces_priv_phrase | **Optional.** SNMPv3 Privacy Phrase
1778 interfaces_user | **Optional.** SNMPv3 User
1779 interfaces_down_is_ok | **Optional.** Disables critical alerts for down interfaces.
1780 interfaces_aliases | **Optional.** Retrieves the interface description.
1781 interfaces_match_aliases | **Optional.** Also match against aliases (Option --aliases automatically enabled).
1782 interfaces_timeout | **Optional.** Sets the SNMP timeout (in ms).
1783 interfaces_sleep | **Optional.** Sleep between every SNMP query (in ms).
1785 ### <a id="plugins-contrib-command-nwc_health"></a> nwc_health
1787 The plugin [check_nwc_health](https://labs.consol.de/de/nagios/check_nwc_health/index.html)
1788 Check switches, router, there interfaces and utilization.
1790 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
1793 --------------------------------|---------------------------------------------------------
1794 nwc_health_timeout | **Optional.** Seconds before plugin times out (default: 15)
1795 nwc_health_blacklist | **Optional.** Blacklist some (missing/failed) components.
1796 nwc_health_hostname | **Optional.** The host's address. Defaults to "$address$" if the host's `address` attribute is set, "$address6$" otherwise.
1797 nwc_health_port | **Optional.** The SNMP port to use (default: 161).
1798 nwc_health_domain | **Optional.** The transport domain to use (default: udp/ipv4, other possible values: udp6, udp/ipv6, tcp, tcp4, tcp/ipv4, tcp6, tcp/ipv6).
1799 nwc_health_protocol | **Optional.** The SNMP protocol to use (default: 2c, other possibilities: 1,3).
1800 nwc_health_community | **Optional.** SNMP community of the server (SNMP v1/2 only).
1801 nwc_health_username | **Optional.** The securityName for the USM security model (SNMPv3 only).
1802 nwc_health_authpassword | **Optional.** The authentication password for SNMPv3.
1803 nwc_health_authprotocol | **Optional.** The authentication protocol for SNMPv3 (md5|sha).
1804 nwc_health_privpassword | **Optional.** The password for authPriv security level.
1805 nwc_health_privprotocol | **Optional.** The private protocol for SNMPv3 (des|aes|aes128|3des|3desde).
1806 nwc_health_contextengineid | **Optional.** The context engine id for SNMPv3 (10 to 64 hex characters).
1807 nwc_health_contextname | **Optional.** The context name for SNMPv3 (empty represents the default context).
1808 nwc_health_name | **Optional.** The name of an interface (ifDescr).
1809 nwc_health_drecksptkdb | **Optional.** This parameter must be used instead of --name, because Devel::ptkdb is stealing the latter from the command line.
1810 nwc_health_alias | **Optional.** The alias name of a 64bit-interface (ifAlias)
1811 nwc_health_regexp | **Optional.** A flag indicating that --name is a regular expression
1812 nwc_health_ifspeedin | **Optional.** Override the ifspeed oid of an interface (only inbound)
1813 nwc_health_ifspeedout | **Optional.** Override the ifspeed oid of an interface (only outbound)
1814 nwc_health_ifspeed | **Optional.** Override the ifspeed oid of an interface
1815 nwc_health_units | **Optional.** One of %, B, KB, MB, GB, Bit, KBi, MBi, GBi. (used for e.g. mode interface-usage)
1816 nwc_health_name2 | **Optional.** The secondary name of a component.
1817 nwc_health_role | **Optional.** The role of this device in a hsrp group (active/standby/listen).
1818 nwc_health_report | **Optional.** Can be used to shorten the output.
1819 nwc_health_lookback | **Optional.** The amount of time you want to look back when calculating average rates. Use it for mode interface-errors or interface-usage. Without --lookback the time between two runs of check_nwc_health is the base for calculations. If you want your checkresult to be based for example on the past hour, use --lookback 3600.
1820 nwc_health_warning | **Optional.** The warning threshold
1821 nwc_health_critical | **Optional.** The critical threshold
1822 nwc_health_warningx | **Optional.** The extended warning thresholds
1823 nwc_health_criticalx | **Optional.** The extended critical thresholds
1824 nwc_health_mitigation | **Optional.** The parameter allows you to change a critical error to a warning.
1825 nwc_health_selectedperfdata | **Optional.** The parameter allows you to limit the list of performance data. It's a perl regexp. Only matching perfdata show up in the output.
1826 nwc_health_morphperfdata | **Optional.** The parameter allows you to change performance data labels. It's a perl regexp and a substitution. --morphperfdata '(.*)ISATAP(.*)'='$1patasi$2'
1827 nwc_health_negate | **Optional.** The parameter allows you to map exit levels, such as warning=critical.
1828 nwc_health_mymodules-dyn-dir | **Optional.** A directory where own extensions can be found.
1829 nwc_health_servertype | **Optional.** The type of the network device: cisco (default). Use it if auto-detection is not possible.
1830 nwc_health_statefilesdir | **Optional.** An alternate directory where the plugin can save files.
1831 nwc_health_oids | **Optional.** A list of oids which are downloaded and written to a cache file. Use it together with --mode oidcache.
1832 nwc_health_offline | **Optional.** The maximum number of seconds since the last update of cache file before it is considered too old.
1833 nwc_health_multiline | **Optional.** Multiline output
1836 ## <a id="plugins-contrib-web"></a> Web
1838 This category includes all plugins for web-based checks.
1840 ### <a id="plugin-check-command-webinject"></a> webinject
1842 Check command object for the [check_webinject](http://http://www.webinject.org/manual.html) plugin.
1844 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
1847 ------------------------|--------------
1848 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.
1849 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.
1850 webinject_no_output | **Optional.** Suppresses all output to STDOUT except the results summary.
1851 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.
1852 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.
1853 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.
1855 ### <a id="plugin-check-command-jmx4perl"></a> jmx4perl
1857 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.
1859 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
1862 -----------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------
1863 jmx4perl_url | **Required.** URL to agent web application. Defaults to "http://$address$:8080/jolokia".
1864 jmx4perl_product | **Optional.** Name of app server product (e.g. jboss), by default is uses an autodetection facility.
1865 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.
1866 jmx4perl_mbean | **Optional.** MBean name (e.g. java.lang:type=Memory).
1867 jmx4perl_attribute | **Optional.** Attribute name (e.g. HeapMemoryUsage).
1868 jmx4perl_operation | **Optional.** Operation to execute.
1869 jmx4perl_value | **Optional.** Shortcut for specifying mbean/attribute/path. Slashes within names must be escaped with backslash.
1870 jmx4perl_delta | **Optional.** Switches on incremental mode. Optional argument are seconds used for normalizing.
1871 jmx4perl_path | **Optional.** Inner path for extracting a single value from a complex attribute or return value (e.g. used).
1872 jmx4perl_target | **Optional.** JSR-160 Service URL specifing the target server.
1873 jmx4perl_target_user | **Optional.** Username to use for JSR-160 connection.
1874 jmx4perl_target_password | **Optional.** Password to use for JSR-160 connection.
1875 jmx4perl_proxy | **Optional.** Proxy to use.
1876 jmx4perl_user | **Optional.** User for HTTP authentication.
1877 jmx4perl_password | **Optional.** Password for HTTP authentication.
1878 jmx4perl_name | **Optional.** Name to use for output, by default a standard value based on the MBean and attribute will be used.
1879 jmx4perl_method | **Optional.** HTTP method to use, either get or post. By default a method is determined automatically based on the request type.
1880 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.
1881 jmx4perl_base_mbean | **Optional.** Base MBean name, interprets critical and warning values as relative in the range 0 .. 100%. Requires "jmx4perl_base_attribute".
1882 jmx4perl_base_attribute | **Optional.** Base attribute for a relative check. Requires "jmx4perl_base_mbean".
1883 jmx4perl_base_path | **Optional.** Base path for relative checks, where this path is used on the base attribute's value.
1884 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.
1885 jmx4perl_null | **Optional.** Value which should be used in case of a null return value of an operation or attribute. Defaults to null.
1886 jmx4perl_string | **Optional.** Force string comparison for critical and warning checks. Defaults to false.
1887 jmx4perl_numeric | **Optional.** Force numeric comparison for critical and warning checks. Defaults to false.
1888 jmx4perl_critical | **Optional.** Critical threshold for value.
1889 jmx4perl_warning | **Optional.** Warning threshold for value.
1890 jmx4perl_label | **Optional.** Label to be used for printing out the result of the check. For placeholders which can be used see the documentation.
1891 jmx4perl_perfdata | **Optional.** Whether performance data should be omitted, which are included by default. Defaults to "on" for numeric values, to "off" for strings.
1892 jmx4perl_unknown_is_critical | **Optional.** Map UNKNOWN errors to errors with a CRITICAL status. Defaults to false.
1893 jmx4perl_timeout | **Optional.** Seconds before plugin times out. Defaults to "15".
1896 ### <a id="plugins-contrib-squid"></a> squid
1898 Plugin for monitoring [Squid](https://exchange.icinga.org/exchange/check_squid).
1900 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
1903 ------------------------|----------------------------------------------------------------------------------
1904 squid_hostname | **Optional.** The host's address. Defaults to "$address$" if the host's `address` attribute is set, "$address6$" otherwise.
1905 squid_data | **Optional.** Data to fetch (default: Connections) available data: Connections Cache Resources Memory FileDescriptors.
1906 squid_port | **Optional.** Port number (default: 3128).
1907 squid_user | **Optional.** WWW user
1908 squid_password | **Optional.** WWW password
1909 squid_warning | **Optional.** Warning threshold. See http://nagiosplug.sourceforge.net/developer-guidelines.html#THRESHOLDFORMAT for the threshold format.
1910 squid_critical | **Optional.** Critical threshold. See http://nagiosplug.sourceforge.net/developer-guidelines.html#THRESHOLDFORMAT for the threshold format.
1911 squid_client | **Optional.** Path of squidclient (default: /usr/bin/squidclient).
1912 squid_timeout | **Optional.** Seconds before plugin times out (default: 15).
1915 ## <a id="plugins-contrib-operating-system"></a> Operating System
1917 In this category you can find plugins for gathering information about your operating system or the system beneath like memory usage.
1919 ### <a id="plugins-contrib-command-mem"></a> mem
1921 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).
1923 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
1926 -------------|-----------------------------------------------------------------------------------------------------------------------
1927 mem_used | **Optional.** Tell the plugin to check for used memory in opposite of **mem_free**. Must specify one of these as true.
1928 mem_free | **Optional.** Tell the plugin to check for free memory in opposite of **mem_used**. Must specify one of these as true.
1929 mem_cache | **Optional.** If set to true plugin will count cache as free memory. Defaults to false.
1930 mem_warning | **Required.** Specifiy the warning threshold as number interpreted as percent.
1931 mem_critical | **Required.** Specifiy the critical threshold as number interpreted as percent.
1933 ### <a id="plugin-contrib-command-running-kernel"></a> running_kernel
1935 Check command object for the `check_running_kernel` plugin
1936 provided by the `nagios-plugins-contrib` package on Debian.
1938 The `running_kernel` check command does not support any vars.
1940 ### <a id="plugin-contrib-command-yum"></a> yum
1942 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).
1944 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
1947 ------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
1948 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.
1949 yum_warn_on_any_update | **Optional.** Set to true to warn if there are any (non-security) package updates available. Defaults to false.
1950 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.
1951 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.
1952 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.
1953 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.
1954 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.
1955 yum_installroot | **Optional.** Specifies another installation root directory (for example a chroot).
1956 yum_timeout | **Optional.** Set a timeout in seconds after which the plugin will exit (defaults to 55 seconds).
1958 ## <a id="plugins-contrib-virtualization"></a> Virtualization
1960 This category includes all plugins for various virtualization technologies.
1962 ### <a id="plugins-contrib-command-esxi-hardware"></a> esxi_hardware
1964 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.
1966 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
1969 ------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
1970 esxi_hardware_host | **Required.** Specifies the host to monitor. Defaults to "$address$".
1971 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.
1972 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.
1973 esxi_hardware_vendor | **Optional.** Defines the vendor of the server: "auto", "dell", "hp", "ibm", "intel", "unknown" (default).
1974 esxi_hardware_html | **Optional.** Add web-links to hardware manuals for Dell servers (use your country extension). Only useful with **esxi_hardware_vendor** = dell.
1975 esxi_hardware_ignore | **Optional.** Comma separated list of elements to ignore.
1976 esxi_hardware_perfdata | **Optional.** Add performcedata for graphers like PNP4Nagios to the output. Defaults to false.
1977 esxi_hardware_nopower | **Optional.** Do not collect power performance data, when **esxi_hardware_perfdata** is set to true. Defaults to false.
1978 esxi_hardware_novolts | **Optional.** Do not collect voltage performance data, when **esxi_hardware_perfdata** is set to true. Defaults to false.
1979 esxi_hardware_nocurrent | **Optional.** Do not collect current performance data, when **esxi_hardware_perfdata** is set to true. Defaults to false.
1980 esxi_hardware_notemp | **Optional.** Do not collect temperature performance data, when **esxi_hardware_perfdata** is set to true. Defaults to false.
1981 esxi_hardware_nofan | **Optional.** Do not collect fan performance data, when **esxi_hardware_perfdata** is set to true. Defaults to false.
1983 # <a id="plugins-contrib-vmware"></a> VMware
1985 Check commands for the [check_vmware_esx](https://github.com/BaldMansMojo/check_vmware_esx) plugin.
1987 ## <a id="plugins-contrib-vmware-esx-dc-volumes"></a> vmware-esx-dc-volumes
1989 Check command object for the `check_vmware_esx` plugin. Shows all datastore volumes info.
1991 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
1994 ------------------------|--------------
1995 vmware_datacenter | **Required.** Datacenter/vCenter hostname.
1996 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
1997 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
1998 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
1999 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
2000 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
2001 vmware_sessionfile | **Optional.** Session file name enhancement.
2002 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
2003 vmware_nosession | **Optional.** No auth session - IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
2004 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
2005 vmware_password | **Optional.** The username's password. No value defined as default.
2006 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
2007 vmware_subselect | **Optional.** Volume name to be checked the free space.
2008 vmware_gigabyte | **Optional.** Output in GB instead of MB.
2009 vmware_usedspace | **Optional.** Output used space instead of free. Defaults to "false".
2010 vmware_alertonly | **Optional.** List only alerting volumes. Defaults to "false".
2011 vmware_exclude | **Optional.** Blacklist volumes name. No value defined as default.
2012 vmware_include | **Optional.** Whitelist volumes name. No value defined as default.
2013 vmware_isregexp | **Optional.** Treat blacklist and whitelist expressions as regexp.
2014 vmware_dc_volume_used | **Optional.** Output used space instead of free. Defaults to "true".
2015 vmware_warn | **Optional.** The warning threshold for volumes. Defaults to "80%".
2016 vmware_crit | **Optional.** The critical threshold for volumes. Defaults to "90%".
2019 ## <a id="plugins-contrib-vmware-esx-dc-runtime-info"></a> vmware-esx-dc-runtime-info
2021 Check command object for the `check_vmware_esx` plugin. Shows all runtime info for the datacenter/Vcenter.
2023 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
2026 ------------------------|--------------
2027 vmware_datacenter | **Required.** Datacenter/vCenter hostname.
2028 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
2029 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
2030 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
2031 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
2032 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
2033 vmware_sessionfile | **Optional.** Session file name enhancement.
2034 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
2035 vmware_nosession | **Optional.** No auth session - IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
2036 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
2037 vmware_password | **Optional.** The username's password. No value defined as default.
2038 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
2041 ## <a id="plugins-contrib-vmware-esx-dc-runtime-listvms"></a> vmware-esx-dc-runtime-listvms
2043 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.
2045 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
2048 ------------------------|--------------
2049 vmware_datacenter | **Required.** Datacenter/vCenter hostname.
2050 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
2051 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
2052 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
2053 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
2054 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
2055 vmware_sessionfile | **Optional.** Session file name enhancement.
2056 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
2057 vmware_nosession | **Optional.** No auth session - IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
2058 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
2059 vmware_password | **Optional.** The username's password. No value defined as default.
2060 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
2061 vmware_alertonly | **Optional.** List only alerting VMs. Important here to avoid masses of data.
2062 vmware_exclude | **Optional.** Blacklist VMs name. No value defined as default.
2063 vmware_include | **Optional.** Whitelist VMs name. No value defined as default.
2064 vmware_isregexp | **Optional.** Treat blacklist and whitelist expressions as regexp.
2065 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.
2068 ## <a id="plugins-contrib-vmware-esx-dc-runtime-listhost"></a> vmware-esx-dc-runtime-listhost
2070 Check command object for the `check_vmware_esx` plugin. List of VMware ESX hosts and their power state.
2072 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
2075 ------------------------|--------------
2076 vmware_datacenter | **Required.** Datacenter/vCenter hostname.
2077 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
2078 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
2079 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
2080 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
2081 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
2082 vmware_sessionfile | **Optional.** Session file name enhancement.
2083 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
2084 vmware_nosession | **Optional.** No auth session - IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
2085 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
2086 vmware_password | **Optional.** The username's password. No value defined as default.
2087 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
2088 vmware_alertonly | **Optional.** List only alerting hosts. Important here to avoid masses of data.
2089 vmware_exclude | **Optional.** Blacklist VMware ESX hosts. No value defined as default.
2090 vmware_include | **Optional.** Whitelist VMware ESX hosts. No value defined as default.
2091 vmware_isregexp | **Optional.** Treat blacklist and whitelist expressions as regexp.
2092 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.
2095 ## <a id="plugins-contrib-vmware-esx-dc-runtime-listcluster"></a> vmware-esx-dc-runtime-listcluster
2097 Check command object for the `check_vmware_esx` plugin. List of VMware clusters and their states.
2099 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
2102 ------------------------|--------------
2103 vmware_datacenter | **Required.** Datacenter/vCenter hostname.
2104 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
2105 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
2106 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
2107 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
2108 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
2109 vmware_sessionfile | **Optional.** Session file name enhancement.
2110 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
2111 vmware_nosession | **Optional.** No auth session - IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
2112 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
2113 vmware_password | **Optional.** The username's password. No value defined as default.
2114 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
2115 vmware_alertonly | **Optional.** List only alerting hosts. Important here to avoid masses of data.
2116 vmware_exclude | **Optional.** Blacklist VMware cluster. No value defined as default.
2117 vmware_include | **Optional.** Whitelist VMware cluster. No value defined as default.
2118 vmware_isregexp | **Optional.** Treat blacklist and whitelist expressions as regexp.
2119 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.
2122 ## <a id="plugins-contrib-vmware-esx-dc-runtime-issues"></a> vmware-esx-dc-runtime-issues
2124 Check command object for the `check_vmware_esx` plugin. All issues for the host.
2126 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
2129 ------------------------|--------------
2130 vmware_datacenter | **Required.** Datacenter/vCenter hostname.
2131 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
2132 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
2133 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
2134 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
2135 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
2136 vmware_sessionfile | **Optional.** Session file name enhancement.
2137 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
2138 vmware_nosession | **Optional.** No auth session - IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
2139 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
2140 vmware_password | **Optional.** The username's password. No value defined as default.
2141 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
2142 vmware_exclude | **Optional.** Blacklist issues. No value defined as default.
2143 vmware_include | **Optional.** Whitelist issues. No value defined as default.
2144 vmware_isregexp | **Optional.** Treat blacklist and whitelist expressions as regexp.
2145 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.
2148 ## <a id="plugins-contrib-vmware-esx-dc-runtime-status"></a> vmware-esx-dc-runtime-status
2150 Check command object for the `check_vmware_esx` plugin. Overall object status (gray/green/red/yellow).
2152 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
2155 ------------------------|--------------
2156 vmware_datacenter | **Required.** Datacenter/vCenter hostname.
2157 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
2158 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
2159 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
2160 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
2161 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
2162 vmware_sessionfile | **Optional.** Session file name enhancement.
2163 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
2164 vmware_nosession | **Optional.** No auth session - IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
2165 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
2166 vmware_password | **Optional.** The username's password. No value defined as default.
2167 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
2170 ## <a id="plugins-contrib-vmware-esx-dc-runtime-tools"></a> vmware-esx-dc-runtime-tools
2172 Check command object for the `check_vmware_esx` plugin. Vmware Tools status.
2174 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
2177 ------------------------|--------------
2178 vmware_datacenter | **Required.** Datacenter/vCenter hostname.
2179 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
2180 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
2181 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
2182 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
2183 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
2184 vmware_sessionfile | **Optional.** Session file name enhancement.
2185 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
2186 vmware_nosession | **Optional.** No auth session - IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
2187 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
2188 vmware_password | **Optional.** The username's password. No value defined as default.
2189 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
2190 vmware_poweredonly | **Optional.** List only VMs which are powered on. No value defined as default.
2191 vmware_alertonly | **Optional.** List only alerting VMs. Important here to avoid masses of data.
2192 vmware_exclude | **Optional.** Blacklist VMs. No value defined as default.
2193 vmware_include | **Optional.** Whitelist VMs. No value defined as default.
2194 vmware_isregexp | **Optional.** Treat blacklist and whitelist expressions as regexp.
2195 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.
2196 vmware_openvmtools | **Optional** Prevent CRITICAL state for installed and running Open VM Tools.
2199 ## <a id="plugins-contrib-vmware-esx-soap-host-check"></a> vmware-esx-soap-host-check
2201 Check command object for the `check_vmware_esx` plugin. Simple check to verify a successfull connection to VMware SOAP API.
2203 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
2206 ------------------------|--------------
2207 vmware_host | **Required.** ESX or ESXi hostname.
2208 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
2209 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
2210 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
2211 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
2212 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
2213 vmware_sessionfile | **Optional.** Session file name enhancement.
2214 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
2215 vmware_nosession | **Optional.** No auth session - IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
2216 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
2217 vmware_password | **Optional.** The username's password. No value defined as default.
2218 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
2221 ## <a id="plugins-contrib-vmware-esx-soap-host-uptime"></a> vmware-esx-soap-host-uptime
2223 Check command object for the `check_vmware_esx` plugin. Displays uptime of the VMware host.
2225 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
2228 ------------------------|--------------
2229 vmware_host | **Required.** ESX or ESXi hostname.
2230 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
2231 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
2232 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
2233 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
2234 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
2235 vmware_sessionfile | **Optional.** Session file name enhancement.
2236 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
2237 vmware_nosession | **Optional.** No auth session - IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
2238 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
2239 vmware_password | **Optional.** The username's password. No value defined as default.
2240 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
2243 ## <a id="plugins-contrib-vmware-esx-soap-host-cpu"></a> vmware-esx-soap-host-cpu
2245 Check command object for the `check_vmware_esx` plugin. CPU usage in percentage.
2247 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
2250 ------------------------|--------------
2251 vmware_host | **Required.** ESX or ESXi hostname.
2252 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
2253 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
2254 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
2255 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
2256 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
2257 vmware_sessionfile | **Optional.** Session file name enhancement.
2258 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
2259 vmware_nosession | **Optional.** No auth session - IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
2260 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
2261 vmware_password | **Optional.** The username's password. No value defined as default.
2262 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
2263 vmware_warn | **Optional.** The warning threshold in percent. Defaults to "80%".
2264 vmware_crit | **Optional.** The critical threshold in percent. Defaults to "90%".
2267 ## <a id="plugins-contrib-vmware-esx-soap-host-cpu-ready"></a> vmware-esx-soap-host-cpu-ready
2269 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.
2271 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
2274 ------------------------|--------------
2275 vmware_host | **Required.** ESX or ESXi hostname.
2276 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
2277 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
2278 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
2279 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
2280 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
2281 vmware_sessionfile | **Optional.** Session file name enhancement.
2282 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
2283 vmware_nosession | **Optional.** No auth session - IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
2284 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
2285 vmware_password | **Optional.** The username's password. No value defined as default.
2286 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
2289 ## <a id="plugins-contrib-vmware-esx-soap-host-cpu-wait"></a> vmware-esx-soap-host-cpu-wait
2291 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.
2293 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
2296 ------------------------|--------------
2297 vmware_host | **Required.** ESX or ESXi hostname.
2298 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
2299 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
2300 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
2301 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
2302 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
2303 vmware_sessionfile | **Optional.** Session file name enhancement.
2304 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
2305 vmware_nosession | **Optional.** No auth session - IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
2306 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
2307 vmware_password | **Optional.** The username's password. No value defined as default.
2308 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
2311 ## <a id="plugins-contrib-vmware-esx-soap-host-cpu-usage"></a> vmware-esx-soap-host-cpu-usage
2313 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.
2315 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
2318 ------------------------|--------------
2319 vmware_host | **Required.** ESX or ESXi hostname.
2320 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
2321 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
2322 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
2323 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
2324 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
2325 vmware_sessionfile | **Optional.** Session file name enhancement.
2326 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
2327 vmware_nosession | **Optional.** No auth session - IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
2328 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
2329 vmware_password | **Optional.** The username's password. No value defined as default.
2330 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
2331 vmware_warn | **Optional.** The warning threshold in percent. Defaults to "80%".
2332 vmware_crit | **Optional.** The critical threshold in percent. Defaults to "90%".
2335 ## <a id="plugins-contrib-vmware-esx-soap-host-mem"></a> vmware-esx-soap-host-mem
2337 Check command object for the `check_vmware_esx` plugin. All mem info(except overall and no thresholds).
2339 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
2342 ------------------------|--------------
2343 vmware_host | **Required.** ESX or ESXi hostname.
2344 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
2345 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
2346 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
2347 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
2348 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
2349 vmware_sessionfile | **Optional.** Session file name enhancement.
2350 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
2351 vmware_nosession | **Optional.** No auth session - IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
2352 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
2353 vmware_password | **Optional.** The username's password. No value defined as default.
2354 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
2357 ## <a id="plugins-contrib-vmware-esx-soap-host-mem-usage"></a> vmware-esx-soap-host-mem-usage
2359 Check command object for the `check_vmware_esx` plugin. Average mem usage in percentage.
2361 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
2364 ------------------------|--------------
2365 vmware_host | **Required.** ESX or ESXi hostname.
2366 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
2367 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
2368 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
2369 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
2370 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
2371 vmware_sessionfile | **Optional.** Session file name enhancement.
2372 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
2373 vmware_nosession | **Optional.** No auth session - IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
2374 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
2375 vmware_password | **Optional.** The username's password. No value defined as default.
2376 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
2377 vmware_warn | **Optional.** The warning threshold in percent. Defaults to "80%".
2378 vmware_crit | **Optional.** The critical threshold in percent. Defaults to "90%".
2381 ## <a id="plugins-contrib-vmware-esx-soap-host-mem-consumed"></a> vmware-esx-soap-host-mem-consumed
2383 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.
2385 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
2388 ------------------------|--------------
2389 vmware_host | **Required.** ESX or ESXi hostname.
2390 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
2391 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
2392 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
2393 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
2394 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
2395 vmware_sessionfile | **Optional.** Session file name enhancement.
2396 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
2397 vmware_nosession | **Optional.** No auth session - IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
2398 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
2399 vmware_password | **Optional.** The username's password. No value defined as default.
2400 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
2401 vmware_warn | **Optional.** The warning threshold in percent. No value defined as default.
2402 vmware_crit | **Optional.** The critical threshold in percent. No value defined as default.
2405 ## <a id="plugins-contrib-vmware-esx-soap-host-mem-swapused"></a> vmware-esx-soap-host-mem-swapused
2407 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.
2409 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
2412 ------------------------|--------------
2413 vmware_host | **Required.** ESX or ESXi hostname.
2414 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
2415 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
2416 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
2417 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
2418 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
2419 vmware_sessionfile | **Optional.** Session file name enhancement.
2420 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
2421 vmware_nosession | **Optional.** No auth session - IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
2422 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
2423 vmware_password | **Optional.** The username's password. No value defined as default.
2424 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
2425 vmware_warn | **Optional.** The warning threshold in percent. No value defined as default.
2426 vmware_crit | **Optional.** The critical threshold in percent. No value defined as default.
2427 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.
2430 ## <a id="plugins-contrib-vmware-esx-soap-host-mem-overhead"></a> vmware-esx-soap-host-mem-overhead
2432 Check command object for the `check_vmware_esx` plugin. Additional mem used by VM Server in MB.
2434 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
2437 ------------------------|--------------
2438 vmware_host | **Required.** ESX or ESXi hostname.
2439 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
2440 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
2441 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
2442 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
2443 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
2444 vmware_sessionfile | **Optional.** Session file name enhancement.
2445 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
2446 vmware_nosession | **Optional.** No auth session - IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
2447 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
2448 vmware_password | **Optional.** The username's password. No value defined as default.
2449 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
2450 vmware_warn | **Optional.** The warning threshold in percent. No value defined as default.
2451 vmware_crit | **Optional.** The critical threshold in percent. No value defined as default.
2454 ## <a id="plugins-contrib-vmware-esx-soap-host-mem-memctl"></a> vmware-esx-soap-host-mem-memctl
2456 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.
2458 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
2461 ------------------------|--------------
2462 vmware_host | **Required.** ESX or ESXi hostname.
2463 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
2464 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
2465 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
2466 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
2467 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
2468 vmware_sessionfile | **Optional.** Session file name enhancement.
2469 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
2470 vmware_nosession | **Optional.** No auth session - IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
2471 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
2472 vmware_password | **Optional.** The username's password. No value defined as default.
2473 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
2474 vmware_warn | **Optional.** The warning threshold in percent. No value defined as default.
2475 vmware_crit | **Optional.** The critical threshold in percent. No value defined as default.
2476 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.
2479 ## <a id="plugins-contrib-vmware-esx-soap-host-net"></a> vmware-esx-soap-host-net
2481 Check command object for the `check_vmware_esx` plugin. Shows net 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_exclude | **Optional.** Blacklist NICs. No value defined as default.
2500 vmware_isregexp | **Optional.** Treat blacklist expression as regexp.
2503 ## <a id="plugins-contrib-vmware-esx-soap-host-net-usage"></a> vmware-esx-soap-host-net-usage
2505 Check command object for the `check_vmware_esx` plugin. Overall network usage in KBps(Kilobytes per Second).
2507 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
2510 ------------------------|--------------
2511 vmware_host | **Required.** ESX or ESXi hostname.
2512 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
2513 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
2514 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
2515 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
2516 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
2517 vmware_sessionfile | **Optional.** Session file name enhancement.
2518 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
2519 vmware_nosession | **Optional.** No auth session - IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
2520 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
2521 vmware_password | **Optional.** The username's password. No value defined as default.
2522 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
2523 vmware_warn | **Optional.** The warning threshold in KBps(Kilobytes per Second). No value defined as default.
2524 vmware_crit | **Optional.** The critical threshold in KBps(Kilobytes per Second). No value defined as default.
2527 ## <a id="plugins-contrib-vmware-esx-soap-host-net-receive"></a> vmware-esx-soap-host-net-receive
2529 Check command object for the `check_vmware_esx` plugin. Data receive in KBps(Kilobytes per Second).
2531 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
2534 ------------------------|--------------
2535 vmware_host | **Required.** ESX or ESXi hostname.
2536 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
2537 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
2538 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
2539 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
2540 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
2541 vmware_sessionfile | **Optional.** Session file name enhancement.
2542 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
2543 vmware_nosession | **Optional.** No auth session - IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
2544 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
2545 vmware_password | **Optional.** The username's password. No value defined as default.
2546 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
2547 vmware_warn | **Optional.** The warning threshold in KBps(Kilobytes per Second). No value defined as default.
2548 vmware_crit | **Optional.** The critical threshold in KBps(Kilobytes per Second). No value defined as default.
2551 ## <a id="plugins-contrib-vmware-esx-soap-host-net-send"></a> vmware-esx-soap-host-net-send
2553 Check command object for the `check_vmware_esx` plugin. Data send in KBps(Kilobytes per Second).
2555 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
2558 ------------------------|--------------
2559 vmware_host | **Required.** ESX or ESXi hostname.
2560 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
2561 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
2562 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
2563 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
2564 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
2565 vmware_sessionfile | **Optional.** Session file name enhancement.
2566 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
2567 vmware_nosession | **Optional.** No auth session - IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
2568 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
2569 vmware_password | **Optional.** The username's password. No value defined as default.
2570 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
2571 vmware_warn | **Optional.** The warning threshold in KBps(Kilobytes per Second). No value defined as default.
2572 vmware_crit | **Optional.** The critical threshold in KBps(Kilobytes per Second). No value defined as default.
2575 ## <a id="plugins-contrib-vmware-esx-soap-host-net-nic"></a> vmware-esx-soap-host-net-nic
2577 Check command object for the `check_vmware_esx` plugin. Check all active NICs.
2579 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
2582 ------------------------|--------------
2583 vmware_host | **Required.** ESX or ESXi hostname.
2584 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
2585 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
2586 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
2587 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
2588 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
2589 vmware_sessionfile | **Optional.** Session file name enhancement.
2590 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
2591 vmware_nosession | **Optional.** No auth session - IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
2592 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
2593 vmware_password | **Optional.** The username's password. No value defined as default.
2594 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
2595 vmware_exclude | **Optional.** Blacklist NICs. No value defined as default.
2596 vmware_isregexp | **Optional.** Treat blacklist expression as regexp.
2599 ## <a id="plugins-contrib-vmware-esx-soap-host-volumes"></a> vmware-esx-soap-host-volumes
2601 Check command object for the `check_vmware_esx` plugin. Shows all datastore volumes info.
2603 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
2606 ------------------------|--------------
2607 vmware_host | **Required.** ESX or ESXi hostname.
2608 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
2609 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
2610 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
2611 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
2612 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
2613 vmware_sessionfile | **Optional.** Session file name enhancement.
2614 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
2615 vmware_nosession | **Optional.** No auth session - IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
2616 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
2617 vmware_password | **Optional.** The username's password. No value defined as default.
2618 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
2619 vmware_subselect | **Optional.** Volume name to be checked the free space.
2620 vmware_gigabyte | **Optional.** Output in GB instead of MB.
2621 vmware_usedspace | **Optional.** Output used space instead of free. Defaults to "false".
2622 vmware_alertonly | **Optional.** List only alerting volumes. Defaults to "false".
2623 vmware_exclude | **Optional.** Blacklist volumes name. No value defined as default.
2624 vmware_include | **Optional.** Whitelist volumes name. No value defined as default.
2625 vmware_isregexp | **Optional.** Treat blacklist and whitelist expressions as regexp.
2626 vmware_warn | **Optional.** The warning threshold for volumes. Defaults to "80%".
2627 vmware_crit | **Optional.** The critical threshold for volumes. Defaults to "90%".
2628 vmware_spaceleft | **Optional.** This has to be used in conjunction with thresholds as mentioned above.
2631 ## <a id="plugins-contrib-vmware-esx-soap-host-io"></a> vmware-esx-soap-host-io
2633 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.
2635 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
2638 ------------------------|--------------
2639 vmware_host | **Required.** ESX or ESXi hostname.
2640 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
2641 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
2642 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
2643 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
2644 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
2645 vmware_sessionfile | **Optional.** Session file name enhancement.
2646 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
2647 vmware_nosession | **Optional.** No auth session - IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
2648 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
2649 vmware_password | **Optional.** The username's password. No value defined as default.
2650 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
2653 ## <a id="plugins-contrib-vmware-esx-soap-host-io-aborted"></a> vmware-esx-soap-host-io-aborted
2655 Check command object for the `check_vmware_esx` plugin. Number of aborted SCSI commands.
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-resets"></a> vmware-esx-soap-host-io-resets
2679 Check command object for the `check_vmware_esx` plugin. Number of SCSI bus resets.
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-read"></a> vmware-esx-soap-host-io-read
2703 Check command object for the `check_vmware_esx` plugin. Average number of kilobytes read from the disk each second.
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-read-latency"></a> vmware-esx-soap-host-io-read-latency
2727 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.
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-write"></a> vmware-esx-soap-host-io-write
2751 Check command object for the `check_vmware_esx` plugin. Average number of kilobytes written to disk each second.
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-write-latency"></a> vmware-esx-soap-host-io-write-latency
2775 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.
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-io-usage"></a> vmware-esx-soap-host-io-usage
2799 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.
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_warn | **Optional.** The warning threshold. No value defined as default.
2818 vmware_crit | **Optional.** The critical threshold. No value defined as default.
2821 ## <a id="plugins-contrib-vmware-esx-soap-host-io-kernel-latency"></a> vmware-esx-soap-host-io-kernel-latency
2823 Check command object for the `check_vmware_esx` plugin. Average amount of time (ms) spent by VMkernel processing each SCSI command.
2825 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
2828 ------------------------|--------------
2829 vmware_host | **Required.** ESX or ESXi hostname.
2830 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
2831 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
2832 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
2833 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
2834 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
2835 vmware_sessionfile | **Optional.** Session file name enhancement.
2836 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
2837 vmware_nosession | **Optional.** No auth session - IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
2838 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
2839 vmware_password | **Optional.** The username's password. No value defined as default.
2840 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
2841 vmware_warn | **Optional.** The warning threshold. No value defined as default.
2842 vmware_crit | **Optional.** The critical threshold. No value defined as default.
2845 ## <a id="plugins-contrib-vmware-esx-soap-host-io-device-latency"></a> vmware-esx-soap-host-io-device-latency
2847 Check command object for the `check_vmware_esx` plugin. Average amount of time (ms) to complete a SCSI command from the physical device.
2849 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
2852 ------------------------|--------------
2853 vmware_host | **Required.** ESX or ESXi hostname.
2854 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
2855 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
2856 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
2857 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
2858 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
2859 vmware_sessionfile | **Optional.** Session file name enhancement.
2860 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
2861 vmware_nosession | **Optional.** No auth session - IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
2862 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
2863 vmware_password | **Optional.** The username's password. No value defined as default.
2864 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
2865 vmware_warn | **Optional.** The warning threshold. No value defined as default.
2866 vmware_crit | **Optional.** The critical threshold. No value defined as default.
2869 ## <a id="plugins-contrib-vmware-esx-soap-host-io-queue-latency"></a> vmware-esx-soap-host-io-queue-latency
2871 Check command object for the `check_vmware_esx` plugin. Average amount of time (ms) spent in the VMkernel queue.
2873 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
2876 ------------------------|--------------
2877 vmware_host | **Required.** ESX or ESXi hostname.
2878 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
2879 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
2880 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
2881 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
2882 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
2883 vmware_sessionfile | **Optional.** Session file name enhancement.
2884 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
2885 vmware_nosession | **Optional.** No auth session - IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
2886 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
2887 vmware_password | **Optional.** The username's password. No value defined as default.
2888 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
2889 vmware_warn | **Optional.** The warning threshold. No value defined as default.
2890 vmware_crit | **Optional.** The critical threshold. No value defined as default.
2893 ## <a id="plugins-contrib-vmware-esx-soap-host-io-total-latency"></a> vmware-esx-soap-host-io-total-latency
2895 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.
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_warn | **Optional.** The warning threshold. No value defined as default.
2914 vmware_crit | **Optional.** The critical threshold. No value defined as default.
2917 ## <a id="plugins-contrib-vmware-esx-soap-host-media"></a> vmware-esx-soap-host-media
2919 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.
2921 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
2924 ------------------------|--------------
2925 vmware_host | **Required.** ESX or ESXi hostname.
2926 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
2927 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
2928 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
2929 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
2930 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
2931 vmware_sessionfile | **Optional.** Session file name enhancement.
2932 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
2933 vmware_nosession | **Optional.** No auth session - IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
2934 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
2935 vmware_password | **Optional.** The username's password. No value defined as default.
2936 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
2937 vmware_exclude | **Optional.** Blacklist VMs name. No value defined as default.
2938 vmware_include | **Optional.** Whitelist VMs name. No value defined as default.
2939 vmware_isregexp | **Optional.** Treat blacklist and whitelist expressions as regexp.
2940 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.
2943 ## <a id="plugins-contrib-vmware-esx-soap-host-service"></a> vmware-esx-soap-host-service
2945 Check command object for the `check_vmware_esx` plugin. Shows host service info.
2947 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
2950 ------------------------|--------------
2951 vmware_host | **Required.** ESX or ESXi hostname.
2952 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
2953 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
2954 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
2955 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
2956 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
2957 vmware_sessionfile | **Optional.** Session file name enhancement.
2958 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
2959 vmware_nosession | **Optional.** No auth session - IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
2960 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
2961 vmware_password | **Optional.** The username's password. No value defined as default.
2962 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
2963 vmware_exclude | **Optional.** Blacklist services name. No value defined as default.
2964 vmware_include | **Optional.** Whitelist services name. No value defined as default.
2965 vmware_isregexp | **Optional.** Treat blacklist and whitelist expressions as regexp.
2966 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.
2969 ## <a id="plugins-contrib-vmware-esx-soap-host-runtime"></a> vmware-esx-soap-host-runtime
2971 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.
2973 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
2976 ------------------------|--------------
2977 vmware_host | **Required.** ESX or ESXi hostname.
2978 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
2979 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
2980 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
2981 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
2982 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
2983 vmware_sessionfile | **Optional.** Session file name enhancement.
2984 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
2985 vmware_nosession | **Optional.** No auth session - IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
2986 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
2987 vmware_password | **Optional.** The username's password. No value defined as default.
2988 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
2991 ## <a id="plugins-contrib-vmware-esx-soap-host-runtime-con"></a> vmware-esx-soap-host-runtime-con
2993 Check command object for the `check_vmware_esx` plugin. Shows connection state.
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
3013 ## <a id="plugins-contrib-vmware-esx-soap-host-runtime-listvms"></a> vmware-esx-soap-host-runtime-listvms
3015 Check command object for the `check_vmware_esx` plugin. List of VMware machines and their status.
3017 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
3020 ------------------------|--------------
3021 vmware_host | **Required.** ESX or ESXi hostname.
3022 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
3023 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
3024 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
3025 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
3026 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
3027 vmware_sessionfile | **Optional.** Session file name enhancement.
3028 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
3029 vmware_nosession | **Optional.** No auth session - IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
3030 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
3031 vmware_password | **Optional.** The username's password. No value defined as default.
3032 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
3033 vmware_exclude | **Optional.** Blacklist VMs name. No value defined as default.
3034 vmware_include | **Optional.** Whitelist VMs name. No value defined as default.
3035 vmware_isregexp | **Optional.** Treat blacklist and whitelist expressions as regexp.
3036 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.
3039 ## <a id="plugins-contrib-vmware-esx-soap-host-runtime-status"></a> vmware-esx-soap-host-runtime-status
3041 Check command object for the `check_vmware_esx` plugin. Overall object status (gray/green/red/yellow).
3043 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
3046 ------------------------|--------------
3047 vmware_host | **Required.** ESX or ESXi hostname.
3048 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
3049 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
3050 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
3051 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
3052 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
3053 vmware_sessionfile | **Optional.** Session file name enhancement.
3054 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
3055 vmware_nosession | **Optional.** No auth session - IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
3056 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
3057 vmware_password | **Optional.** The username's password. No value defined as default.
3058 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
3061 ## <a id="plugins-contrib-vmware-esx-soap-host-runtime-health"></a> vmware-esx-soap-host-runtime-health
3063 Check command object for the `check_vmware_esx` plugin. Checks cpu/storage/memory/sensor status.
3065 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
3068 ------------------------|--------------
3069 vmware_host | **Required.** ESX or ESXi hostname.
3070 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
3071 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
3072 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
3073 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
3074 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
3075 vmware_sessionfile | **Optional.** Session file name enhancement.
3076 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
3077 vmware_nosession | **Optional.** No auth session - IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
3078 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
3079 vmware_password | **Optional.** The username's password. No value defined as default.
3080 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
3081 vmware_exclude | **Optional.** Blacklist status name. No value defined as default.
3082 vmware_include | **Optional.** Whitelist status name. No value defined as default.
3083 vmware_isregexp | **Optional.** Treat blacklist and whitelist expressions as regexp.
3086 ## <a id="plugins-contrib-vmware-esx-soap-host-runtime-health-listsensors"></a> vmware-esx-soap-host-runtime-health-listsensors
3088 Check command object for the `check_vmware_esx` plugin. List all available sensors(use for listing purpose only).
3090 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
3093 ------------------------|--------------
3094 vmware_host | **Required.** ESX or ESXi hostname.
3095 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
3096 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
3097 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
3098 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
3099 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
3100 vmware_sessionfile | **Optional.** Session file name enhancement.
3101 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
3102 vmware_nosession | **Optional.** No auth session - IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
3103 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
3104 vmware_password | **Optional.** The username's password. No value defined as default.
3105 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
3106 vmware_exclude | **Optional.** Blacklist status name. No value defined as default.
3107 vmware_include | **Optional.** Whitelist status name. No value defined as default.
3108 vmware_isregexp | **Optional.** Treat blacklist and whitelist expressions as regexp.
3111 ## <a id="plugins-contrib-vmware-esx-soap-host-runtime-health-nostoragestatus"></a> vmware-esx-soap-host-runtime-health-nostoragestatus
3113 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**.
3115 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
3118 ------------------------|--------------
3119 vmware_host | **Required.** ESX or ESXi hostname.
3120 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
3121 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
3122 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
3123 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
3124 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
3125 vmware_sessionfile | **Optional.** Session file name enhancement.
3126 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
3127 vmware_nosession | **Optional.** No auth session - IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
3128 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
3129 vmware_password | **Optional.** The username's password. No value defined as default.
3130 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
3131 vmware_exclude | **Optional.** Blacklist status name. No value defined as default.
3132 vmware_include | **Optional.** Whitelist status name. No value defined as default.
3133 vmware_isregexp | **Optional.** Treat blacklist and whitelist expressions as regexp.
3136 ## <a id="plugins-contrib-vmware-esx-soap-host-runtime-storagehealth"></a> vmware-esx-soap-host-runtime-storagehealth
3138 Check command object for the `check_vmware_esx` plugin. Local storage status check.
3140 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
3143 ------------------------|--------------
3144 vmware_host | **Required.** ESX or ESXi hostname.
3145 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
3146 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
3147 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
3148 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
3149 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
3150 vmware_sessionfile | **Optional.** Session file name enhancement.
3151 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
3152 vmware_nosession | **Optional.** No auth session - IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
3153 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
3154 vmware_password | **Optional.** The username's password. No value defined as default.
3155 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
3156 vmware_exclude | **Optional.** Blacklist storage name. No value defined as default.
3157 vmware_include | **Optional.** Whitelist storage name. No value defined as default.
3158 vmware_isregexp | **Optional.** Treat blacklist and whitelist expressions as regexp.
3159 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.
3162 ## <a id="plugins-contrib-vmware-esx-soap-host-runtime-temp"></a> vmware-esx-soap-host-runtime-temp
3164 Check command object for the `check_vmware_esx` plugin. Lists all temperature sensors.
3166 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
3169 ------------------------|--------------
3170 vmware_host | **Required.** ESX or ESXi hostname.
3171 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
3172 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
3173 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
3174 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
3175 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
3176 vmware_sessionfile | **Optional.** Session file name enhancement.
3177 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
3178 vmware_nosession | **Optional.** No auth session - IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
3179 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
3180 vmware_password | **Optional.** The username's password. No value defined as default.
3181 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
3182 vmware_exclude | **Optional.** Blacklist sensor name. No value defined as default.
3183 vmware_include | **Optional.** Whitelist sensor name. No value defined as default.
3184 vmware_isregexp | **Optional.** Treat blacklist and whitelist expressions as regexp.
3185 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.
3188 ## <a id="plugins-contrib-vmware-esx-soap-host-runtime-issues"></a> vmware-esx-soap-host-runtime-issues
3190 Check command object for the `check_vmware_esx` plugin. Lists all configuration issues for the host.
3192 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
3195 ------------------------|--------------
3196 vmware_host | **Required.** ESX or ESXi hostname.
3197 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
3198 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
3199 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
3200 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
3201 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
3202 vmware_sessionfile | **Optional.** Session file name enhancement.
3203 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
3204 vmware_nosession | **Optional.** No auth session - IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
3205 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
3206 vmware_password | **Optional.** The username's password. No value defined as default.
3207 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
3208 vmware_exclude | **Optional.** Blacklist configuration issues. No value defined as default.
3209 vmware_include | **Optional.** Whitelist configuration issues. No value defined as default.
3210 vmware_isregexp | **Optional.** Treat blacklist and whitelist expressions as regexp.
3211 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.
3214 ## <a id="plugins-contrib-vmware-esx-soap-host-storage"></a> vmware-esx-soap-host-storage
3216 Check command object for the `check_vmware_esx` plugin. Shows Host storage info.
3218 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
3221 ------------------------|--------------
3222 vmware_host | **Required.** ESX or ESXi hostname.
3223 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
3224 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
3225 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
3226 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
3227 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
3228 vmware_sessionfile | **Optional.** Session file name enhancement.
3229 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
3230 vmware_nosession | **Optional.** No auth session - IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
3231 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
3232 vmware_password | **Optional.** The username's password. No value defined as default.
3233 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
3234 vmware_exclude | **Optional.** Blacklist adapters, luns and paths. No value defined as default.
3235 vmware_include | **Optional.** Whitelist adapters, luns and paths. No value defined as default.
3236 vmware_isregexp | **Optional.** Treat blacklist and whitelist expressions as regexp.
3239 ## <a id="plugins-contrib-vmware-esx-soap-host-storage-adapter"></a> vmware-esx-soap-host-storage-adapter
3241 Check command object for the `check_vmware_esx` plugin. List host bus adapters.
3243 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
3246 ------------------------|--------------
3247 vmware_host | **Required.** ESX or ESXi hostname.
3248 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
3249 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
3250 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
3251 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
3252 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
3253 vmware_sessionfile | **Optional.** Session file name enhancement.
3254 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
3255 vmware_nosession | **Optional.** No auth session - IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
3256 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
3257 vmware_password | **Optional.** The username's password. No value defined as default.
3258 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
3259 vmware_exclude | **Optional.** Blacklist adapters. No value defined as default.
3260 vmware_include | **Optional.** Whitelist adapters. No value defined as default.
3261 vmware_isregexp | **Optional.** Treat blacklist and whitelist expressions as regexp.
3262 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.
3265 ## <a id="plugins-contrib-vmware-esx-soap-host-storage-lun"></a> vmware-esx-soap-host-storage-lun
3267 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.
3269 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
3272 ------------------------|--------------
3273 vmware_host | **Required.** ESX or ESXi hostname.
3274 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
3275 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
3276 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
3277 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
3278 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
3279 vmware_sessionfile | **Optional.** Session file name enhancement.
3280 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
3281 vmware_nosession | **Optional.** No auth session - IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
3282 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
3283 vmware_password | **Optional.** The username's password. No value defined as default.
3284 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
3285 vmware_exclude | **Optional.** Blacklist luns. No value defined as default.
3286 vmware_include | **Optional.** Whitelist luns. No value defined as default.
3287 vmware_isregexp | **Optional.** Treat blacklist and whitelist expressions as regexp.
3288 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.
3291 ## <a id="plugins-contrib-vmware-esx-soap-host-storage-path"></a> vmware-esx-soap-host-storage-path
3293 Check command object for the `check_vmware_esx` plugin. List multipaths and the associated paths.
3295 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
3298 ------------------------|--------------
3299 vmware_host | **Required.** ESX or ESXi hostname.
3300 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
3301 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
3302 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
3303 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
3304 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
3305 vmware_sessionfile | **Optional.** Session file name enhancement.
3306 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
3307 vmware_nosession | **Optional.** No auth session - IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
3308 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
3309 vmware_password | **Optional.** The username's password. No value defined as default.
3310 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
3311 vmware_alertonly | **Optional.** List only alerting units. Important here to avoid masses of data. Defaults to "false".
3312 vmware_exclude | **Optional.** Blacklist paths. No value defined as default.
3313 vmware_include | **Optional.** Whitelist paths. No value defined as default.
3314 vmware_isregexp | **Optional.** Treat blacklist and whitelist expressions as regexp.
3315 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.
3318 ## <a id="plugins-contrib-vmware-esx-soap-vm-cpu"></a> vmware-esx-soap-vm-cpu
3320 Check command object for the `check_vmware_esx` plugin. Shows all CPU usage info.
3322 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
3325 ------------------------|--------------
3326 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. Conflicts with **vmware_host**.
3327 vmware_host | **Optional.** ESX or ESXi hostname. Conflicts with **vmware_datacenter**.
3328 vmware_vmname | **Required.** Virtual machine name.
3329 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
3330 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
3331 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
3332 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
3333 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
3334 vmware_sessionfile | **Optional.** Session file name enhancement.
3335 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
3336 vmware_nosession | **Optional.** No auth session - IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
3337 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
3338 vmware_password | **Optional.** The username's password. No value defined as default.
3339 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
3343 ## <a id="plugins-contrib-vmware-esx-soap-vm-cpu-ready"></a> vmware-esx-soap-vm-cpu-ready
3345 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.
3347 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
3350 ------------------------|--------------
3351 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. Conflicts with **vmware_host**.
3352 vmware_host | **Optional.** ESX or ESXi hostname. Conflicts with **vmware_datacenter**.
3353 vmware_vmname | **Required.** Virtual machine name.
3354 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
3355 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
3356 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
3357 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
3358 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
3359 vmware_sessionfile | **Optional.** Session file name enhancement.
3360 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
3361 vmware_nosession | **Optional.** No auth session - IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
3362 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
3363 vmware_password | **Optional.** The username's password. No value defined as default.
3364 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
3365 vmware_warn | **Optional.** The warning threshold. No value defined as default.
3366 vmware_crit | **Optional.** The critical threshold. No value defined as default.
3369 ## <a id="plugins-contrib-vmware-esx-soap-vm-cpu-wait"></a> vmware-esx-soap-vm-cpu-wait
3371 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.
3373 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
3376 ------------------------|--------------
3377 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. Conflicts with **vmware_host**.
3378 vmware_host | **Optional.** ESX or ESXi hostname. Conflicts with **vmware_datacenter**.
3379 vmware_vmname | **Required.** Virtual machine name.
3380 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
3381 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
3382 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
3383 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
3384 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
3385 vmware_sessionfile | **Optional.** Session file name enhancement.
3386 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
3387 vmware_nosession | **Optional.** No auth session - IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
3388 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
3389 vmware_password | **Optional.** The username's password. No value defined as default.
3390 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
3391 vmware_warn | **Optional.** The warning threshold. No value defined as default.
3392 vmware_crit | **Optional.** The critical threshold. No value defined as default.
3395 ## <a id="plugins-contrib-vmware-esx-soap-vm-cpu-usage"></a> vmware-esx-soap-vm-cpu-usage
3397 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.
3399 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
3402 ------------------------|--------------
3403 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. Conflicts with **vmware_host**.
3404 vmware_host | **Optional.** ESX or ESXi hostname. Conflicts with **vmware_datacenter**.
3405 vmware_vmname | **Required.** Virtual machine name.
3406 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
3407 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
3408 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
3409 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
3410 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
3411 vmware_sessionfile | **Optional.** Session file name enhancement.
3412 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
3413 vmware_nosession | **Optional.** No auth session - IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
3414 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
3415 vmware_password | **Optional.** The username's password. No value defined as default.
3416 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
3417 vmware_warn | **Optional.** Warning threshold in percent. Defaults to "80%".
3418 vmware_crit | **Optional.** Critical threshold in percent. Defaults to "90%".
3421 ## <a id="plugins-contrib-vmware-esx-soap-vm-mem"></a> vmware-esx-soap-vm-mem
3423 Check command object for the `check_vmware_esx` plugin. Shows all memory info, except overall.
3425 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
3428 ------------------------|--------------
3429 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. Conflicts with **vmware_host**.
3430 vmware_host | **Optional.** ESX or ESXi hostname. Conflicts with **vmware_datacenter**.
3431 vmware_vmname | **Required.** Virtual machine name.
3432 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
3433 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
3434 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
3435 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
3436 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
3437 vmware_sessionfile | **Optional.** Session file name enhancement.
3438 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
3439 vmware_nosession | **Optional.** No auth session - IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
3440 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
3441 vmware_password | **Optional.** The username's password. No value defined as default.
3442 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
3445 ## <a id="plugins-contrib-vmware-esx-soap-vm-mem-usage"></a> vmware-esx-soap-vm-mem-usage
3447 Check command object for the `check_vmware_esx` plugin. Average mem usage in percentage of configured virtual machine "physical" memory.
3449 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
3452 ------------------------|--------------
3453 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. Conflicts with **vmware_host**.
3454 vmware_host | **Optional.** ESX or ESXi hostname. Conflicts with **vmware_datacenter**.
3455 vmware_vmname | **Required.** Virtual machine name.
3456 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
3457 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
3458 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
3459 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
3460 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
3461 vmware_sessionfile | **Optional.** Session file name enhancement.
3462 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
3463 vmware_nosession | **Optional.** No auth session - IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
3464 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
3465 vmware_password | **Optional.** The username's password. No value defined as default.
3466 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
3467 vmware_warn | **Optional.** Warning threshold in percent. Defaults to "80%".
3468 vmware_crit | **Optional.** Critical threshold in percent. Defaults to "90%".
3471 ## <a id="plugins-contrib-vmware-esx-soap-vm-mem-consumed"></a> vmware-esx-soap-vm-mem-consumed
3473 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>
3474 **vm consumed memory = memory granted - memory saved**
3476 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
3479 ------------------------|--------------
3480 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. Conflicts with **vmware_host**.
3481 vmware_host | **Optional.** ESX or ESXi hostname. Conflicts with **vmware_datacenter**.
3482 vmware_vmname | **Required.** Virtual machine name.
3483 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
3484 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
3485 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
3486 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
3487 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
3488 vmware_sessionfile | **Optional.** Session file name enhancement.
3489 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
3490 vmware_nosession | **Optional.** No auth session - IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
3491 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
3492 vmware_password | **Optional.** The username's password. No value defined as default.
3493 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
3494 vmware_warn | **Optional.** The warning threshold. No value defined as default.
3495 vmware_crit | **Optional.** The critical threshold. No value defined as default.
3498 ## <a id="plugins-contrib-vmware-esx-soap-vm-mem-memctl"></a> vmware-esx-soap-vm-mem-memctl
3500 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.
3502 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
3505 ------------------------|--------------
3506 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. Conflicts with **vmware_host**.
3507 vmware_host | **Optional.** ESX or ESXi hostname. Conflicts with **vmware_datacenter**.
3508 vmware_vmname | **Required.** Virtual machine name.
3509 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
3510 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
3511 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
3512 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
3513 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
3514 vmware_sessionfile | **Optional.** Session file name enhancement.
3515 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
3516 vmware_nosession | **Optional.** No auth session - IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
3517 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
3518 vmware_password | **Optional.** The username's password. No value defined as default.
3519 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
3520 vmware_warn | **Optional.** The warning threshold. No value defined as default.
3521 vmware_crit | **Optional.** The critical threshold. No value defined as default.
3525 ## <a id="plugins-contrib-vmware-esx-soap-vm-net"></a> vmware-esx-soap-vm-net
3527 Check command object for the `check_vmware_esx` plugin. Shows net info.
3529 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
3532 ------------------------|--------------
3533 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. Conflicts with **vmware_host**.
3534 vmware_host | **Optional.** ESX or ESXi hostname. Conflicts with **vmware_datacenter**.
3535 vmware_vmname | **Required.** Virtual machine name.
3536 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
3537 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
3538 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
3539 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
3540 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
3541 vmware_sessionfile | **Optional.** Session file name enhancement.
3542 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
3543 vmware_nosession | **Optional.** No auth session - IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
3544 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
3545 vmware_password | **Optional.** The username's password. No value defined as default.
3546 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
3549 ## <a id="plugins-contrib-vmware-esx-soap-vm-net-usage"></a> vmware-esx-soap-vm-net-usage
3551 Check command object for the `check_vmware_esx` plugin. Overall network usage in KBps(Kilobytes per Second).
3553 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
3556 ------------------------|--------------
3557 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. Conflicts with **vmware_host**.
3558 vmware_host | **Optional.** ESX or ESXi hostname. Conflicts with **vmware_datacenter**.
3559 vmware_vmname | **Required.** Virtual machine name.
3560 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
3561 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
3562 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
3563 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
3564 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
3565 vmware_sessionfile | **Optional.** Session file name enhancement.
3566 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
3567 vmware_nosession | **Optional.** No auth session - IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
3568 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
3569 vmware_password | **Optional.** The username's password. No value defined as default.
3570 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
3571 vmware_warn | **Optional.** The warning threshold. No value defined as default.
3572 vmware_crit | **Optional.** The critical threshold. No value defined as default.
3575 ## <a id="plugins-contrib-vmware-esx-soap-vm-net-receive"></a> vmware-esx-soap-vm-net-receive
3577 Check command object for the `check_vmware_esx` plugin. Receive in KBps(Kilobytes per Second).
3579 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
3582 ------------------------|--------------
3583 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. Conflicts with **vmware_host**.
3584 vmware_host | **Optional.** ESX or ESXi hostname. Conflicts with **vmware_datacenter**.
3585 vmware_vmname | **Required.** Virtual machine name.
3586 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
3587 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
3588 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
3589 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
3590 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
3591 vmware_sessionfile | **Optional.** Session file name enhancement.
3592 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
3593 vmware_nosession | **Optional.** No auth session - IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
3594 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
3595 vmware_password | **Optional.** The username's password. No value defined as default.
3596 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
3597 vmware_warn | **Optional.** The warning threshold. No value defined as default.
3598 vmware_crit | **Optional.** The critical threshold. No value defined as default.
3601 ## <a id="plugins-contrib-vmware-esx-soap-vm-net-send"></a> vmware-esx-soap-vm-net-send
3603 Check command object for the `check_vmware_esx` plugin. Send in KBps(Kilobytes per Second).
3605 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
3608 ------------------------|--------------
3609 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. Conflicts with **vmware_host**.
3610 vmware_host | **Optional.** ESX or ESXi hostname. Conflicts with **vmware_datacenter**.
3611 vmware_vmname | **Required.** Virtual machine name.
3612 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
3613 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
3614 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
3615 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
3616 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
3617 vmware_sessionfile | **Optional.** Session file name enhancement.
3618 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
3619 vmware_nosession | **Optional.** No auth session - IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
3620 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
3621 vmware_password | **Optional.** The username's password. No value defined as default.
3622 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
3623 vmware_warn | **Optional.** The warning threshold. No value defined as default.
3624 vmware_crit | **Optional.** The critical threshold. No value defined as default.
3627 ## <a id="plugins-contrib-vmware-esx-soap-vm-io"></a> vmware-esx-soap-vm-io
3629 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.
3631 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
3634 ------------------------|--------------
3635 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. Conflicts with **vmware_host**.
3636 vmware_host | **Optional.** ESX or ESXi hostname. Conflicts with **vmware_datacenter**.
3637 vmware_vmname | **Required.** Virtual machine name.
3638 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
3639 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
3640 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
3641 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
3642 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
3643 vmware_sessionfile | **Optional.** Session file name enhancement.
3644 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
3645 vmware_nosession | **Optional.** No auth session - IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
3646 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
3647 vmware_password | **Optional.** The username's password. No value defined as default.
3648 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
3651 ## <a id="plugins-contrib-vmware-esx-soap-vm-io-read"></a> vmware-esx-soap-vm-io-read
3653 Check command object for the `check_vmware_esx` plugin. Average number of kilobytes read from the disk each second.
3655 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
3658 ------------------------|--------------
3659 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. Conflicts with **vmware_host**.
3660 vmware_host | **Optional.** ESX or ESXi hostname. Conflicts with **vmware_datacenter**.
3661 vmware_vmname | **Required.** Virtual machine name.
3662 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
3663 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
3664 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
3665 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
3666 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
3667 vmware_sessionfile | **Optional.** Session file name enhancement.
3668 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
3669 vmware_nosession | **Optional.** No auth session - IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
3670 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
3671 vmware_password | **Optional.** The username's password. No value defined as default.
3672 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
3673 vmware_warn | **Optional.** The warning threshold. No value defined as default.
3674 vmware_crit | **Optional.** The critical threshold. No value defined as default.
3677 ## <a id="plugins-contrib-vmware-esx-soap-vm-io-write"></a> vmware-esx-soap-vm-io-write
3679 Check command object for the `check_vmware_esx` plugin. Average number of kilobytes written to disk each second.
3681 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
3684 ------------------------|--------------
3685 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. Conflicts with **vmware_host**.
3686 vmware_host | **Optional.** ESX or ESXi hostname. Conflicts with **vmware_datacenter**.
3687 vmware_vmname | **Required.** Virtual machine name.
3688 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
3689 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
3690 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
3691 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
3692 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
3693 vmware_sessionfile | **Optional.** Session file name enhancement.
3694 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
3695 vmware_nosession | **Optional.** No auth session - IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
3696 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
3697 vmware_password | **Optional.** The username's password. No value defined as default.
3698 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
3699 vmware_warn | **Optional.** The warning threshold. No value defined as default.
3700 vmware_crit | **Optional.** The critical threshold. No value defined as default.
3703 ## <a id="plugins-contrib-vmware-esx-soap-vm-io-usage"></a> vmware-esx-soap-vm-io-usage
3705 Check command object for the `check_vmware_esx` plugin. Aggregated disk I/O rate.
3707 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
3710 ------------------------|--------------
3711 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. Conflicts with **vmware_host**.
3712 vmware_host | **Optional.** ESX or ESXi hostname. Conflicts with **vmware_datacenter**.
3713 vmware_vmname | **Required.** Virtual machine name.
3714 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
3715 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
3716 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
3717 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
3718 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
3719 vmware_sessionfile | **Optional.** Session file name enhancement.
3720 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
3721 vmware_nosession | **Optional.** No auth session - IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
3722 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
3723 vmware_password | **Optional.** The username's password. No value defined as default.
3724 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
3725 vmware_warn | **Optional.** The warning threshold. No value defined as default.
3726 vmware_crit | **Optional.** The critical threshold. No value defined as default.
3729 ## <a id="plugins-contrib-vmware-esx-soap-vm-runtime"></a> vmware-esx-soap-vm-runtime
3731 Check command object for the `check_vmware_esx` plugin. Shows virtual machine runtime info.
3733 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
3736 ------------------------|--------------
3737 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. Conflicts with **vmware_host**.
3738 vmware_host | **Optional.** ESX or ESXi hostname. Conflicts with **vmware_datacenter**.
3739 vmware_vmname | **Required.** Virtual machine name.
3740 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
3741 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
3742 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
3743 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
3744 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
3745 vmware_sessionfile | **Optional.** Session file name enhancement.
3746 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
3747 vmware_nosession | **Optional.** No auth session - IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
3748 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
3749 vmware_password | **Optional.** The username's password. No value defined as default.
3750 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
3753 ## <a id="plugins-contrib-vmware-esx-soap-vm-runtime-con"></a> vmware-esx-soap-vm-runtime-con
3755 Check command object for the `check_vmware_esx` plugin. Shows the connection state.
3757 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
3760 ------------------------|--------------
3761 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. Conflicts with **vmware_host**.
3762 vmware_host | **Optional.** ESX or ESXi hostname. Conflicts with **vmware_datacenter**.
3763 vmware_vmname | **Required.** Virtual machine name.
3764 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
3765 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
3766 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
3767 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
3768 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
3769 vmware_sessionfile | **Optional.** Session file name enhancement.
3770 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
3771 vmware_nosession | **Optional.** No auth session - IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
3772 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
3773 vmware_password | **Optional.** The username's password. No value defined as default.
3774 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
3777 ## <a id="plugins-contrib-vmware-esx-soap-vm-runtime-powerstate"></a> vmware-esx-soap-vm-runtime-powerstate
3779 Check command object for the `check_vmware_esx` plugin. Shows virtual machine power state: poweredOn, poweredOff or suspended.
3781 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
3784 ------------------------|--------------
3785 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. Conflicts with **vmware_host**.
3786 vmware_host | **Optional.** ESX or ESXi hostname. Conflicts with **vmware_datacenter**.
3787 vmware_vmname | **Required.** Virtual machine name.
3788 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
3789 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
3790 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
3791 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
3792 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
3793 vmware_sessionfile | **Optional.** Session file name enhancement.
3794 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
3795 vmware_nosession | **Optional.** No auth session - IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
3796 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
3797 vmware_password | **Optional.** The username's password. No value defined as default.
3798 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
3801 ## <a id="plugins-contrib-vmware-esx-soap-vm-runtime-status"></a> vmware-esx-soap-vm-runtime-status
3803 Check command object for the `check_vmware_esx` plugin. Overall object status (gray/green/red/yellow).
3805 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
3808 ------------------------|--------------
3809 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. Conflicts with **vmware_host**.
3810 vmware_host | **Optional.** ESX or ESXi hostname. Conflicts with **vmware_datacenter**.
3811 vmware_vmname | **Required.** Virtual machine name.
3812 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
3813 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
3814 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
3815 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
3816 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
3817 vmware_sessionfile | **Optional.** Session file name enhancement.
3818 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
3819 vmware_nosession | **Optional.** No auth session - IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
3820 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
3821 vmware_password | **Optional.** The username's password. No value defined as default.
3822 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
3825 ## <a id="plugins-contrib-vmware-esx-soap-vm-runtime-consoleconnections"></a> vmware-esx-soap-vm-runtime-consoleconnections
3827 Check command object for the `check_vmware_esx` plugin. Console connections to virtual machine.
3829 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
3832 ------------------------|--------------
3833 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. Conflicts with **vmware_host**.
3834 vmware_host | **Optional.** ESX or ESXi hostname. Conflicts with **vmware_datacenter**.
3835 vmware_vmname | **Required.** Virtual machine name.
3836 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
3837 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
3838 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
3839 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
3840 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
3841 vmware_sessionfile | **Optional.** Session file name enhancement.
3842 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
3843 vmware_nosession | **Optional.** No auth session - IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
3844 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
3845 vmware_password | **Optional.** The username's password. No value defined as default.
3846 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
3847 vmware_warn | **Optional.** The warning threshold. No value defined as default.
3848 vmware_crit | **Optional.** The critical threshold. No value defined as default.
3851 ## <a id="plugins-contrib-vmware-esx-soap-vm-runtime-gueststate"></a> vmware-esx-soap-vm-runtime-gueststate
3853 Check command object for the `check_vmware_esx` plugin. Guest OS status. Needs VMware Tools installed and running.
3855 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
3858 ------------------------|--------------
3859 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. Conflicts with **vmware_host**.
3860 vmware_host | **Optional.** ESX or ESXi hostname. Conflicts with **vmware_datacenter**.
3861 vmware_vmname | **Required.** Virtual machine name.
3862 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
3863 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
3864 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
3865 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
3866 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
3867 vmware_sessionfile | **Optional.** Session file name enhancement.
3868 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
3869 vmware_nosession | **Optional.** No auth session - IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
3870 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
3871 vmware_password | **Optional.** The username's password. No value defined as default.
3872 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
3874 ## <a id="plugins-contrib-vmware-esx-soap-vm-runtime-tools"></a> vmware-esx-soap-vm-runtime-tools
3876 Check command object for the `check_vmware_esx` plugin. Guest OS status. VMware tools status.
3878 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
3881 ------------------------|--------------
3882 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. Conflicts with **vmware_host**.
3883 vmware_host | **Optional.** ESX or ESXi hostname. Conflicts with **vmware_datacenter**.
3884 vmware_vmname | **Required.** Virtual machine name.
3885 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
3886 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
3887 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
3888 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
3889 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
3890 vmware_sessionfile | **Optional.** Session file name enhancement.
3891 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
3892 vmware_nosession | **Optional.** No auth session - IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
3893 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
3894 vmware_password | **Optional.** The username's password. No value defined as default.
3895 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
3896 vmware_openvmtools | **Optional** Prevent CRITICAL state for installed and running Open VM Tools.
3899 ## <a id="plugins-contrib-vmware-esx-soap-vm-runtime-issues"></a> vmware-esx-soap-vm-runtime-issues
3901 Check command object for the `check_vmware_esx` plugin. All issues for the virtual machine.
3903 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
3906 ------------------------|--------------
3907 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. Conflicts with **vmware_host**.
3908 vmware_host | **Optional.** ESX or ESXi hostname. Conflicts with **vmware_datacenter**.
3909 vmware_vmname | **Required.** Virtual machine name.
3910 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
3911 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
3912 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
3913 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
3914 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
3915 vmware_sessionfile | **Optional.** Session file name enhancement.
3916 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
3917 vmware_nosession | **Optional.** No auth session - IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
3918 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
3919 vmware_password | **Optional.** The username's password. No value defined as default.
3920 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
3921 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.
3924 ## <a id="plugins-contrib-hardware"></a> Hardware
3926 This category includes all plugins for various hardware checks.
3928 ### <a id="plugins-contrib-command-hpasm"></a> hpasm
3930 The plugin [check_hpasm](https://labs.consol.de/de/nagios/check_hpasm/index.html) is a plugin to monitor HP hardware through the HP Insight Agent via SNMP.
3932 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
3935 --------------------------------|-----------------------------------------------------------------------
3936 hpasm_hostname | **Optional.** The host's address. Defaults to "$address$" if the host's `address` attribute is set, "$address6$" otherwise.
3937 hpasm_community | **Optional.** SNMP community of the server (SNMP v1/2 only).
3938 hpasm_protocol | **Optional.** The SNMP protocol to use (default: 2c, other possibilities: 1,3).
3939 hpasm_port | **Optional.** The SNMP port to use (default: 161).
3940 hpasm_blacklist | **Optional.** Blacklist some (missing/failed) components.
3941 hpasm_ignore-dimms | **Optional.** Ignore "N/A"-DIMM status on misc. servers (e.g. older DL320).
3942 hpasm_ignore-fan-redundancy | **Optional.** Ignore missing redundancy partners.
3943 hpasm_customthresholds | **Optional.** Use custom thresholds for certain temperatures.
3944 hpasm_eventrange | **Optional.** Period of time before critical IML events respecively become warnings or vanish. A range is descibed as a number and a unit (s, m, h, d), e.g. --eventrange 1h/20m.
3945 hpasm_perfdata | **Optional.** Output performance data. If your performance data string becomes too long and is truncated by Nagios, then you can use --perfdata=short instead. This will output temperature tags without location information.
3946 hpasm_username | **Optional.** The securityName for the USM security model (SNMPv3 only).
3947 hpasm_authpassword | **Optional.** The authentication password for SNMPv3.
3948 hpasm_authprotocol | **Optional.** The authentication protocol for SNMPv3 (md5|sha).
3949 hpasm_privpassword | **Optional.** The password for authPriv security level.
3950 hpasm_privprotocol | **Optional.** The private protocol for SNMPv3 (des|aes|aes128|3des|3desde).
3951 hpasm_servertype | **Optional.** The type of the server: proliant (default) or bladesystem.
3952 hpasm_eval-nics | **Optional.** Check network interfaces (and groups). Try it and report me whyt you think about it. I need to build up some know how on this subject. If get an error and you think, it is not justified for your configuration, please tell me about it. (alwasy send the output of "snmpwalk -On .... 1.3.6.1.4.1.232" and a description how you setup your nics and why it is correct opposed to the plugins error message.
projects / icinga2 / blob