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.
16 > These templates are built into the binaries. By convention
17 > all command and timeperiod objects should import these templates.
19 ### <a id="itl-plugin-check-command"></a> plugin-check-command
21 Command template for check plugins executed by Icinga 2.
23 The `plugin-check-command` command does not support any vars.
25 By default this template is automatically imported into all CheckCommand definitions.
27 ### <a id="itl-plugin-notification-command"></a> plugin-notification-command
29 Command template for notification scripts executed by Icinga 2.
31 The `plugin-notification-command` command does not support any vars.
33 By default this template is automatically imported into all CheckCommand definitions.
35 ### <a id="itl-plugin-event-command"></a> plugin-event-command
37 Command template for event handler scripts executed by Icinga 2.
39 The `plugin-event-command` command does not support any vars.
41 By default this template is automatically imported into all CheckCommand definitions.
43 ### <a id="itl-legacy-timeperiod"></a> legacy-timeperiod
45 Timeperiod template for [Timeperiod objects](9-object-types.md#objecttype-timeperiod).
47 The `legacy-timeperiod` timeperiod does not support any vars.
49 By default this template is automatically imported into all CheckCommand definitions.
51 ## <a id="itl-check-commands"></a> Check Commands
53 These check commands are embedded into Icinga 2 and do not require any external
56 ### <a id="itl-icinga"></a> icinga
58 Check command for the built-in `icinga` check. This check returns performance
59 data for the current Icinga instance.
61 The `icinga` check command does not support any vars.
63 ### <a id="itl-icinga-cluster"></a> cluster
65 Check command for the built-in `cluster` check. This check returns performance
66 data for the current Icinga instance and connected endpoints.
68 The `cluster` check command does not support any vars.
70 ### <a id="itl-icinga-cluster-zone"></a> cluster-zone
72 Check command for the built-in `cluster-zone` check.
74 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
77 ---------------------|---------------
78 cluster_zone | **Required.** The zone name.
79 cluster_lag_warning | **Optional.** Warning threshold for log lag in seconds. Applies if the log lag is greater than the threshold.
80 cluster_lag_critical | **Optional.** Critical threshold for log lag in seconds. Applies if the log lag is greater than the threshold.
82 ### <a id="itl-icinga-ido"></a> ido
84 Check command for the built-in `ido` check.
86 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
89 -------------|---------------
90 ido_type | **Required.** The type of the IDO connection object. Can be either "IdoMysqlConnection" or "IdoPgsqlConnection".
91 ido_name | **Required.** The name of the IDO connection object.
93 ### <a id="itl-random"></a> random
95 Check command for the built-in `random` check. This check returns random states
96 and adds the check source to the check output.
98 For test and demo purposes only. The `random` check command does not support
101 ### <a id="itl-exception"></a> exception
103 Check command for the built-in `exception` check. This check throws an exception.
105 For test and demo purposes only. The `exception` check command does not support
108 # <a id="plugin-check-commands"></a> Plugin Check Commands
110 ## <a id="plugin-check-commands-monitoring-plugins"></a> Plugin Check Commands for Monitoring Plugins
112 The Plugin Check Commands provides example configuration for plugin check commands
113 provided by the [Monitoring Plugins](https://www.monitoring-plugins.org) project.
115 By default the Plugin Check Commands are included in the `icinga2.conf` configuration
120 The plugin check commands assume that there's a global constant named `PluginDir`
121 which contains the path of the plugins from the Monitoring Plugins project.
123 **Note**: If there are command parameters missing for the provided CheckCommand
124 definitions please kindly send a patch upstream. This should include an update
125 for the ITL CheckCommand itself and this documentation section.
127 ### <a id="plugin-check-command-apt"></a> apt
129 The plugin [apt](https://www.monitoring-plugins.org/doc/index.html) checks for software updates on systems that use
130 package management systems based on the apt-get(8) command found in Debian based systems.
132 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
135 ------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
136 apt_extra_opts | **Optional.** Read options from an ini file.
137 apt_upgrade | **Optional.** [Default] Perform an upgrade. If an optional OPTS argument is provided, apt-get will be run with these command line options instead of the default.
138 apt_dist_upgrade | **Optional.** Perform a dist-upgrade instead of normal upgrade. Like with -U OPTS can be provided to override the default options.
139 apt_include | **Optional.** Include only packages matching REGEXP. Can be specified multiple times the values will be combined together.
140 apt_exclude | **Optional.** Exclude packages matching REGEXP from the list of packages that would otherwise be included. Can be specified multiple times.
141 apt_critical | **Optional.** If the full package information of any of the upgradable packages match this REGEXP, the plugin will return CRITICAL status. Can be specified multiple times.
142 apt_timeout | **Optional.** Seconds before plugin times out (default: 10).
145 ### <a id="plugin-check-command-breeze"></a> breeze
147 The [check_breeze](https://www.monitoring-plugins.org/doc/man/check_breeze.html) plugin reports the signal
148 strength of a Breezecom wireless equipment.
150 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
153 -----------------|---------------------------------
154 breeze_hostname | **Required.** Name or IP address of host to check. Defaults to "$address$" if the host's `address` attribute is set, "$address6$" otherwise.
155 breeze_community | **Optional.** SNMPv1 community. Defaults to "public".
156 breeze_warning | **Required.** Percentage strength below which a WARNING status will result. Defaults to 50.
157 breeze_critical | **Required.** Percentage strength below which a WARNING status will result. Defaults to 20.
160 ### <a id="plugin-check-command-by-ssh"></a> by_ssh
162 The [check_by_ssh](https://www.monitoring-plugins.org/doc/man/check_by_ssh.html) plugin uses SSH to execute
163 commands on a remote host.
165 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
168 ----------------|--------------
169 by_ssh_address | **Optional.** The host's address. Defaults to "$address$" if the host's `address` attribute is set, "$address6$" otherwise.
170 by_ssh_port | **Optional.** The SSH port. Defaults to 22.
171 by_ssh_command | **Required.** The command that should be executed. Can be an array if multiple arguments should be passed to `check_by_ssh`.
172 by_ssh_arguments| **Optional.** A dictionary with arguments for the command. This works exactly like the 'arguments' dictionary for ordinary CheckCommands.
173 by_ssh_logname | **Optional.** The SSH username.
174 by_ssh_identity | **Optional.** The SSH identity.
175 by_ssh_quiet | **Optional.** Whether to suppress SSH warnings. Defaults to false.
176 by_ssh_warn | **Optional.** The warning threshold.
177 by_ssh_crit | **Optional.** The critical threshold.
178 by_ssh_timeout | **Optional.** The timeout in seconds.
179 by_ssh_options | **Optional.** Call ssh with '-o OPTION' (multiple options may be specified as an array).
180 by_ssh_ipv4 | **Optional.** Use IPv4 connection. Defaults to false.
181 by_ssh_ipv6 | **Optional.** Use IPv6 connection. Defaults to false.
184 ### <a id="plugin-check-command-clamd"></a> clamd
186 The [check_clamd](https://www.monitoring-plugins.org/doc/man/check_clamd.html) plugin tests CLAMD
187 connections with the specified host (or unix socket).
189 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
192 -------------------|--------------
193 clamd_address | **Required.** The host's address or unix socket (must be an absolute path).
194 clamd_port | **Optional.** Port number (default: none).
195 clamd_expect | **Optional.** String to expect in server response. Multiple strings must be defined as array.
196 clamd_all | **Optional.** All expect strings need to occur in server response. Defaults to false.
197 clamd_escape_send | **Optional.** Enable usage of \\n, \\r, \\t or \\\\ in send string.
198 clamd_send | **Optional.** String to send to the server.
199 clamd_escape_quit | **Optional.** Enable usage of \\n, \\r, \\t or \\\\ in quit string.
200 clamd_quit | **Optional.** String to send server to initiate a clean close of the connection.
201 clamd_refuse | **Optional.** Accept TCP refusals with states ok, warn, crit. Defaults to crit.
202 clamd_mismatch | **Optional.** Accept expected string mismatches with states ok, warn, crit. Defaults to warn.
203 clamd_jail | **Optional.** Hide output from TCP socket.
204 clamd_maxbytes | **Optional.** Close connection once more than this number of bytes are received.
205 clamd_delay | **Optional.** Seconds to wait between sending string and polling for response.
206 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) -- separated by comma.
207 clamd_ssl | **Optional.** Use SSL for the connection. Defaults to false.
208 clamd_wtime | **Optional.** Response time to result in warning status (seconds).
209 clamd_ctime | **Optional.** Response time to result in critical status (seconds).
210 clamd_timeout | **Optional.** Seconds before connection times out. Defaults to 10.
211 clamd_ipv4 | **Optional.** Use IPv4 connection. Defaults to false.
212 clamd_ipv6 | **Optional.** Use IPv6 connection. Defaults to false.
215 ### <a id="plugin-check-command-dhcp"></a> dhcp
217 The [check_dhcp](https://www.monitoring-plugins.org/doc/man/check_dhcp.html) plugin
218 tests the availability of DHCP servers on a network.
220 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
223 ----------------|--------------
224 dhcp_serverip | **Optional.** The IP address of the DHCP server which we should get a response from.
225 dhcp_requestedip| **Optional.** The IP address which we should be offered by a DHCP server.
226 dhcp_timeout | **Optional.** The timeout in seconds.
227 dhcp_interface | **Optional.** The interface to use.
228 dhcp_mac | **Optional.** The MAC address to use in the DHCP request.
229 dhcp_unicast | **Optional.** Whether to use unicast requests. Defaults to false.
232 ### <a id="plugin-check-command-dig"></a> dig
234 The [check_dig](https://www.monitoring-plugins.org/doc/man/check_dig.html) plugin
235 test the DNS service on the specified host using dig.
237 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
240 ---------------------|--------------
241 dig_server | **Optional.** The DNS server to query. Defaults to "127.0.0.1".
242 dig_port | **Optional.** Port number (default: 53).
243 dig_lookup | **Required.** The address that should be looked up.
244 dig_record_type | **Optional.** Record type to lookup (default: A).
245 dig_expected_address | **Optional.** An address expected to be in the answer section. If not set, uses whatever was in -l.
246 dig_arguments | **Optional.** Pass STRING as argument(s) to dig.
247 dig_retries | **Optional.** Number of retries passed to dig, timeout is divided by this value (Default: 3).
248 dig_warning | **Optional.** Response time to result in warning status (seconds).
249 dig_critical | **Optional.** Response time to result in critical status (seconds).
250 dig_timeout | **Optional.** Seconds before connection times out (default: 10).
251 dig_ipv4 | **Optional.** Force dig to only use IPv4 query transport. Defaults to false.
252 dig_ipv6 | **Optional.** Force dig to only use IPv6 query transport. Defaults to false.
255 ### <a id="plugin-check-command-disk"></a> disk
257 The [check_disk](https://www.monitoring-plugins.org/doc/man/check_disk.html) plugin
258 checks the amount of used disk space on a mounted file system and generates an alert
259 if free space is less than one of the threshold values.
261 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
264 --------------------|------------------------
265 disk\_wfree | **Optional.** The free space warning threshold. Defaults to "20%". If the percent sign is omitted, units from `disk_units` are used.
266 disk\_cfree | **Optional.** The free space critical threshold. Defaults to "10%". If the percent sign is omitted, units from `disk_units` are used.
267 disk\_inode\_wfree | **Optional.** The free inode warning threshold.
268 disk\_inode\_cfree | **Optional.** The free inode critical threshold.
269 disk\_partition | **Optional.** The partition. **Deprecated in 2.3.**
270 disk\_partition\_excluded | **Optional.** The excluded partition. **Deprecated in 2.3.**
271 disk\_partitions | **Optional.** The partition(s). Multiple partitions must be defined as array.
272 disk\_partitions\_excluded | **Optional.** The excluded partition(s). Multiple partitions must be defined as array.
273 disk\_clear | **Optional.** Clear thresholds.
274 disk\_exact\_match | **Optional.** For paths or partitions specified with -p, only check for exact paths.
275 disk\_errors\_only | **Optional.** Display only devices/mountpoints with errors. May be true or false.
276 disk\_ignore\_reserved | **Optional.** If set, account root-reserved blocks are not accounted for freespace in perfdata.
277 disk\_group | **Optional.** Group paths. Thresholds apply to (free-)space of all partitions together.
278 disk\_kilobytes | **Optional.** Same as --units kB. May be true or false.
279 disk\_local | **Optional.** Only check local filesystems. May be true or false.
280 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). May be true or false.
281 disk\_mountpoint | **Optional.** Display the mountpoint instead of the partition. May be true or false.
282 disk\_megabytes | **Optional.** Same as --units MB. May be true or false.
283 disk\_all | **Optional.** Explicitly select all paths. This is equivalent to -R '.\*'. May be true or false.
284 disk\_eregi\_path | **Optional.** Case insensitive regular expression for path/partition. Multiple regular expression strings must be defined as array.
285 disk\_ereg\_path | **Optional.** Regular expression for path or partition. Multiple regular expression strings must be defined as array.
286 disk\_ignore\_eregi\_path | **Optional.** Regular expression to ignore selected path/partition (case insensitive). Multiple regular expression strings must be defined as array.
287 disk\_ignore\_ereg\_path | **Optional.** Regular expression to ignore selected path or partition. Multiple regular expression strings must be defined as array.
288 disk\_timeout | **Optional.** Seconds before connection times out (default: 10).
289 disk\_units | **Optional.** Choose bytes, kB, MB, GB, TB (default: MB).
290 disk\_exclude\_type | **Optional.** Ignore all filesystems of indicated type. Multiple regular expression strings must be defined as array.
292 ### <a id="plugin-check-command-disk-smb"></a> disk_smb
294 The [check_disk_smb](https://www.monitoring-plugins.org/doc/man/check_disk_smb.html) plugin
295 uses the `smbclient` binary to check SMB shares.
297 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
300 ------------------------|------------------------
301 disk_smb_hostname | **Required.** NetBIOS name of the server.
302 disk_smb_share | **Required.** Share name being queried.
303 disk_smb_workgroup | **Optional.** Workgroup or Domain used (defaults to 'WORKGROUP' if omitted).
304 disk_smb_address | **Optional.** IP address of the host (only necessary if host belongs to another network).
305 disk_smb_username | **Optional.** Username for server log-in (defaults to 'guest' if omitted).
306 disk_smb_password | **Optional.** Password for server log-in (defaults to an empty password if omitted).
307 disk_smb_wused | **Optional.** The used space warning threshold. Defaults to "85%". If the percent sign is omitted, use optional disk units.
308 disk_smb_cused | **Optional.** The used space critical threshold. Defaults to "95%". If the percent sign is omitted, use optional disk units.
309 disk_smb_port | **Optional.** Connection port, e.g. `139` or `445`. Defaults to `smbclient` default if omitted.
311 ### <a id="plugin-check-command-dns"></a> dns
313 The [check_dns](https://www.monitoring-plugins.org/doc/man/check_dns.html) plugin
314 uses the nslookup program to obtain the IP address for the given host/domain query.
315 An optional DNS server to use may be specified. If no DNS server is specified, the
316 default server(s) specified in `/etc/resolv.conf` will be used.
318 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
321 ---------------------|--------------
322 dns_lookup | **Optional.** The hostname or IP to query the DNS for. Defaults to "$host_name$".
323 dns_server | **Optional.** The DNS server to query. Defaults to the server configured in the OS.
324 dns_expected_answer | **Optional.** The answer to look for. A hostname must end with a dot. **Deprecated in 2.3.**
325 dns_expected_answers | **Optional.** The answer(s) to look for. A hostname must end with a dot. Multiple answers must be defined as array.
326 dns_authoritative | **Optional.** Expect the server to send an authoritative answer.
327 dns_wtime | **Optional.** Return warning if elapsed time exceeds value.
328 dns_ctime | **Optional.** Return critical if elapsed time exceeds value.
329 dns_timeout | **Optional.** Seconds before connection times out. Defaults to 10.
332 ### <a id="plugin-check-command-dummy"></a> dummy
334 The [check_dummy](https://www.monitoring-plugins.org/doc/man/check_dummy.html) plugin
335 will simply return the state corresponding to the numeric value of the `dummy_state`
336 argument with optional text.
338 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
341 ----------------|--------------
342 dummy_state | **Optional.** The state. Can be one of 0 (ok), 1 (warning), 2 (critical) and 3 (unknown). Defaults to 0.
343 dummy_text | **Optional.** Plugin output. Defaults to "Check was successful.".
346 ### <a id="plugin-check-command-file-age"></a> file_age
348 The [check_file_age](https://www.monitoring-plugins.org/doc/man/check_file_age.html) plugin
349 checks a file's size and modification time to make sure it's not empty and that it's sufficiently recent.
351 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
354 -----------------------|--------------------------------------------------------------------------------------------------------
355 file_age_file | **Required.** File to monitor.
356 file_age_warning_time | **Optional.** File must be no more than this many seconds old as warning threshold. Defaults to "240s".
357 file_age_critical_time | **Optional.** File must be no more than this many seconds old as critical threshold. Defaults to "600s".
358 file_age_warning_size | **Optional.** File must be at least this many bytes long as warning threshold. No default given.
359 file_age_critical_size | **Optional.** File must be at least this many bytes long as critical threshold. Defaults to "0B".
360 file_age_ignoremissing | **Optional.** Return OK if the file does not exist. Defaults to false.
363 ### <a id="plugin-check-command-flexlm"></a> flexlm
365 The [check_flexlm](https://www.monitoring-plugins.org/doc/man/check_flexlm.html) plugin
366 checks available flexlm license managers. Requires the `lmstat` command.
368 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
371 -------------------|----------------------------------------------------------
372 flexlm_licensefile | **Required.** Name of license file (usually license.dat).
373 flexlm_timeout | **Optional.** Plugin time out in seconds. Defaults to 15.
376 ### <a id="plugin-check-command-fping4"></a> fping4
378 The [check_fping](https://www.monitoring-plugins.org/doc/man/check_fping.html) plugin
379 will use the `fping` command to ping the specified host for a fast check. Note that it is
380 necessary to set the suid flag on fping.
382 This CheckCommand expects an IPv4 address.
384 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
387 ----------------|--------------
388 fping_address | **Optional.** The host's IPv4 address. Defaults to "$address$".
389 fping_wrta | **Optional.** The RTA warning threshold in milliseconds. Defaults to 100.
390 fping_wpl | **Optional.** The packet loss warning threshold in %. Defaults to 5.
391 fping_crta | **Optional.** The RTA critical threshold in milliseconds. Defaults to 200.
392 fping_cpl | **Optional.** The packet loss critical threshold in %. Defaults to 15.
393 fping_number | **Optional.** The number of packets to send. Defaults to 5.
394 fping_interval | **Optional.** The interval between packets in milli-seconds. Defaults to 500.
395 fping_bytes | **Optional.** The size of ICMP packet.
396 fping_target_timeout | **Optional.** The target timeout in milli-seconds.
397 fping_source_ip | **Optional.** The name or ip address of the source ip.
398 fping_source_interface | **Optional.** The source interface name.
401 ### <a id="plugin-check-command-fping6"></a> fping6
403 The [check_fping](https://www.monitoring-plugins.org/doc/man/check_fping.html) plugin
404 will use the `fping` command to ping the specified host for a fast check. Note that it is
405 necessary to set the suid flag on fping.
407 This CheckCommand expects an IPv6 address.
409 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
412 ----------------|--------------
413 fping_address | **Optional.** The host's IPv6 address. Defaults to "$address6$".
414 fping_wrta | **Optional.** The RTA warning threshold in milliseconds. Defaults to 100.
415 fping_wpl | **Optional.** The packet loss warning threshold in %. Defaults to 5.
416 fping_crta | **Optional.** The RTA critical threshold in milliseconds. Defaults to 200.
417 fping_cpl | **Optional.** The packet loss critical threshold in %. Defaults to 15.
418 fping_number | **Optional.** The number of packets to send. Defaults to 5.
419 fping_interval | **Optional.** The interval between packets in milli-seconds. Defaults to 500.
420 fping_bytes | **Optional.** The size of ICMP packet.
421 fping_target_timeout | **Optional.** The target timeout in milli-seconds.
422 fping_source_ip | **Optional.** The name or ip address of the source ip.
423 fping_source_interface | **Optional.** The source interface name.
426 ### <a id="plugin-check-command-ftp"></a> ftp
428 The [check_ftp](https://www.monitoring-plugins.org/doc/man/check_ftp.html) plugin
429 tests FTP connections with the specified host (or unix socket).
431 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
434 -------------------|--------------
435 ftp_address | **Optional.** The host's address. Defaults to "$address$" if the host's `address` attribute is set, "$address6$" otherwise.
436 ftp_port | **Optional.** The FTP port number.
437 ftp_expect | **Optional.** String to expect in server response. Multiple strings must be defined as array.
438 ftp_all | **Optional.** All expect strings need to occur in server response. Defaults to false.
439 ftp_escape_send | **Optional.** Enable usage of \\n, \\r, \\t or \\\\ in send string.
440 ftp_send | **Optional.** String to send to the server.
441 ftp_escape_quit | **Optional.** Enable usage of \\n, \\r, \\t or \\\\ in quit string.
442 ftp_quit | **Optional.** String to send server to initiate a clean close of the connection.
443 ftp_refuse | **Optional.** Accept TCP refusals with states ok, warn, crit. Defaults to crit.
444 ftp_mismatch | **Optional.** Accept expected string mismatches with states ok, warn, crit. Defaults to warn.
445 ftp_jail | **Optional.** Hide output from TCP socket.
446 ftp_maxbytes | **Optional.** Close connection once more than this number of bytes are received.
447 ftp_delay | **Optional.** Seconds to wait between sending string and polling for response.
448 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) -- separated by comma.
449 ftp_ssl | **Optional.** Use SSL for the connection. Defaults to false.
450 ftp_wtime | **Optional.** Response time to result in warning status (seconds).
451 ftp_ctime | **Optional.** Response time to result in critical status (seconds).
452 ftp_timeout | **Optional.** Seconds before connection times out. Defaults to 10.
453 ftp_ipv4 | **Optional.** Use IPv4 connection. Defaults to false.
454 ftp_ipv6 | **Optional.** Use IPv6 connection. Defaults to false.
457 ### <a id="plugin-check-command-game"></a> game
459 The [check_game](https://www.monitoring-plugins.org/doc/man/check_game.html) plugin
460 tests game server connections with the specified host.
461 This plugin uses the 'qstat' command, the popular game server status query tool.
462 If you don't have the package installed, you will need to [download](http://www.activesw.com/people/steve/qstat.html)
463 or install the package `quakestat` before you can use this plugin.
465 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
468 -------------------|-------------------
469 game_game | **Required.** Name of the game.
470 game_ipaddress | **Required.** Ipaddress of the game server to query.
471 game_timeout | **Optional.** Seconds before connection times out. Defaults to 10.
472 game_port | **Optional.** Port to connect to.
473 game_gamefield | **Optional.** Field number in raw qstat output that contains game name.
474 game_mapfield | **Optional.** Field number in raw qstat output that contains map name.
475 game_pingfield | **Optional.** Field number in raw qstat output that contains ping time.
476 game_gametime | **Optional.** Field number in raw qstat output that contains game time.
477 game_hostname | **Optional.** Name of the host running the game.
480 ### <a id="plugin-check-command-hostalive"></a> hostalive
482 Check command object for the [check_ping](https://www.monitoring-plugins.org/doc/man/check_ping.html)
483 plugin with host check default values. This variant uses the host's `address` attribute
484 if available and falls back to using the `address6` attribute if the `address` attribute is not set.
486 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
489 ----------------|--------------
490 ping_address | **Optional.** The host's address. Defaults to "$address$" if the host's `address` attribute is set, "$address6$" otherwise.
491 ping_wrta | **Optional.** The RTA warning threshold in milliseconds. Defaults to 3000.
492 ping_wpl | **Optional.** The packet loss warning threshold in %. Defaults to 80.
493 ping_crta | **Optional.** The RTA critical threshold in milliseconds. Defaults to 5000.
494 ping_cpl | **Optional.** The packet loss critical threshold in %. Defaults to 100.
495 ping_packets | **Optional.** The number of packets to send. Defaults to 5.
496 ping_timeout | **Optional.** The plugin timeout in seconds. Defaults to 0 (no timeout).
499 ### <a id="plugin-check-command-hostalive4"></a> hostalive4
501 Check command object for the [check_ping](https://www.monitoring-plugins.org/doc/man/check_ping.html)
502 plugin with host check default values. This variant uses the host's `address` attribute.
504 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
507 ----------------|--------------
508 ping_address | **Optional.** The host's IPv4 address. Defaults to "$address$".
509 ping_wrta | **Optional.** The RTA warning threshold in milliseconds. Defaults to 3000.
510 ping_wpl | **Optional.** The packet loss warning threshold in %. Defaults to 80.
511 ping_crta | **Optional.** The RTA critical threshold in milliseconds. Defaults to 5000.
512 ping_cpl | **Optional.** The packet loss critical threshold in %. Defaults to 100.
513 ping_packets | **Optional.** The number of packets to send. Defaults to 5.
514 ping_timeout | **Optional.** The plugin timeout in seconds. Defaults to 0 (no timeout).
517 ### <a id="plugin-check-command-hostalive6"></a> hostalive6
519 Check command object for the [check_ping](https://www.monitoring-plugins.org/doc/man/check_ping.html)
520 plugin with host check default values. This variant uses the host's `address6` attribute.
522 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
525 ----------------|--------------
526 ping_address | **Optional.** The host's IPv6 address. Defaults to "$address6$".
527 ping_wrta | **Optional.** The RTA warning threshold in milliseconds. Defaults to 3000.
528 ping_wpl | **Optional.** The packet loss warning threshold in %. Defaults to 80.
529 ping_crta | **Optional.** The RTA critical threshold in milliseconds. Defaults to 5000.
530 ping_cpl | **Optional.** The packet loss critical threshold in %. Defaults to 100.
531 ping_packets | **Optional.** The number of packets to send. Defaults to 5.
532 ping_timeout | **Optional.** The plugin timeout in seconds. Defaults to 0 (no timeout).
535 ### <a id="plugin-check-command-hpjd"></a> hpjd
537 The [check_hpjd](https://www.monitoring-plugins.org/doc/man/check_hpjd.html) plugin
538 tests the state of an HP printer with a JetDirect card. Net-snmp must be installed
539 on the computer running the plugin.
541 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
544 ----------------|--------------
545 hpjd_address | **Optional.** The host's address. Defaults to "$address$" if the host's `address` attribute is set, "$address6$" otherwise.
546 hpjd_port | **Optional.** The host's SNMP port. Defaults to 161.
547 hpjd_community | **Optional.** The SNMP community. Defaults to "public".
550 ### <a id="plugin-check-command-http"></a> http
552 The [check_http](https://www.monitoring-plugins.org/doc/man/check_http.html) plugin
553 tests the HTTP service on the specified host. It can test normal (http) and secure
554 (https) servers, follow redirects, search for strings and regular expressions,
555 check connection times, and report on certificate expiration times.
557 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
560 ---------------------------------|---------------------------------
561 http_address | **Optional.** The host's address. Defaults to "$address$" if the host's `address` attribute is set, "$address6$" otherwise.
562 http_vhost | **Optional.** The virtual host that should be sent in the "Host" header.
563 http_uri | **Optional.** The request URI for GET or POST. Defaults to `/`.
564 http_port | **Optional.** The TCP port. Defaults to 80 when not using SSL, 443 otherwise.
565 http_ssl | **Optional.** Whether to use SSL. Defaults to false.
566 http_ssl_force_tlsv1 | **Optional.** Whether to force TLSv1.
567 http_ssl_force_tlsv1_1 | **Optional.** Whether to force TLSv1.1.
568 http_ssl_force_tlsv1_2 | **Optional.** Whether to force TLSv1.2.
569 http_ssl_force_sslv2 | **Optional.** Whether to force SSLv2.
570 http_ssl_force_sslv3 | **Optional.** Whether to force SSLv3.
571 http_ssl_force_tlsv1_or_higher | **Optional.** Whether to force TLSv1 or higher.
572 http_ssl_force_tlsv1_1_or_higher | **Optional.** Whether to force TLSv1.1 or higher.
573 http_ssl_force_tlsv1_2_or_higher | **Optional.** Whether to force TLSv1.2 or higher.
574 http_ssl_force_sslv2_or_higher | **Optional.** Whether to force SSLv2 or higher.
575 http_ssl_force_sslv3_or_higher | **Optional.** Whether to force SSLv3 or higher.
576 http_sni | **Optional.** Whether to use SNI. Defaults to false.
577 http_auth_pair | **Optional.** Add 'username:password' authorization pair.
578 http_proxy_auth_pair | **Optional.** Add 'username:password' authorization pair for proxy.
579 http_ignore_body | **Optional.** Don't download the body, just the headers.
580 http_linespan | **Optional.** Allow regex to span newline.
581 http_expect_body_regex | **Optional.** A regular expression which the body must match against. Incompatible with http_ignore_body.
582 http_expect_body_eregi | **Optional.** A case-insensitive expression which the body must match against. Incompatible with http_ignore_body.
583 http_invertregex | **Optional.** Changes behaviour of http_expect_body_regex and http_expect_body_eregi to return CRITICAL if found, OK if not.
584 http_warn_time | **Optional.** The warning threshold.
585 http_critical_time | **Optional.** The critical threshold.
586 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.
587 http_certificate | **Optional.** Minimum number of days a certificate has to be valid. This parameter explicitely sets the port to 443 and ignores the URL if passed.
588 http_clientcert | **Optional.** Name of file contains the client certificate (PEM format).
589 http_privatekey | **Optional.** Name of file contains the private key (PEM format).
590 http_headerstring | **Optional.** String to expect in the response headers.
591 http_string | **Optional.** String to expect in the content.
592 http_post | **Optional.** URL encoded http POST data.
593 http_method | **Optional.** Set http method (for example: HEAD, OPTIONS, TRACE, PUT, DELETE).
594 http_maxage | **Optional.** Warn if document is more than seconds old.
595 http_contenttype | **Optional.** Specify Content-Type header when POSTing.
596 http_useragent | **Optional.** String to be sent in http header as User Agent.
597 http_header | **Optional.** Any other tags to be sent in http header.
598 http_extendedperfdata | **Optional.** Print additional perfdata. Defaults to false.
599 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)
600 http_pagesize | **Optional.** Minimum page size required:Maximum page size required.
601 http_timeout | **Optional.** Seconds before connection times out.
602 http_ipv4 | **Optional.** Use IPv4 connection. Defaults to false.
603 http_ipv6 | **Optional.** Use IPv6 connection. Defaults to false.
606 ### <a id="plugin-check-command-icmp"></a> icmp
608 The [check_icmp](https://www.monitoring-plugins.org/doc/man/check_icmp.html) plugin
609 check_icmp allows for checking multiple hosts at once compared to `check_ping`.
610 The main difference is that check_ping executes the system's ping(1) command and
611 parses its output while check_icmp talks ICMP itself. check_icmp must be installed
614 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
617 ----------------|--------------
618 icmp_address | **Optional.** The host's address. This can either be a single address or an array of addresses. Defaults to "$address$".
619 icmp_wrta | **Optional.** The RTA warning threshold in milliseconds. Defaults to 100.
620 icmp_wpl | **Optional.** The packet loss warning threshold in %. Defaults to 5.
621 icmp_crta | **Optional.** The RTA critical threshold in milliseconds. Defaults to 200.
622 icmp_cpl | **Optional.** The packet loss critical threshold in %. Defaults to 15.
623 icmp_source | **Optional.** The source IP address to send packets from.
624 icmp_packets | **Optional.** The number of packets to send. Defaults to 5.
625 icmp_packet_interval | **Optional** The maximum packet interval. Defaults to 80 (milliseconds).
626 icmp_target_interval | **Optional.** The maximum target interval.
627 icmp_hosts_alive | **Optional.** The number of hosts which have to be alive for the check to succeed.
628 icmp_data_bytes | **Optional.** Payload size for each ICMP request. Defaults to 8.
629 icmp_timeout | **Optional.** The plugin timeout in seconds. Defaults to 10 (seconds).
632 ### <a id="plugin-check-command-imap"></a> imap
634 The [check_imap](https://www.monitoring-plugins.org/doc/man/check_imap.html) plugin
635 tests IMAP connections with the specified host (or unix socket).
637 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
640 ----------------------|--------------
641 imap_address | **Optional.** The host's address. Defaults to "$address$" if the host's `address` attribute is set, "$address6$" otherwise.
642 imap_port | **Optional.** The port that should be checked. Defaults to 143.
643 imap_escape | **Optional.** Can use \\n, \\r, \\t or \\ in send or quit string. Must come before send or quit option. Default: nothing added to send, \\r\\n added to end of quit.
644 imap_send | **Optional.** String to send to the server.
645 imap_expect | **Optional.** String to expect in server response. Multiple strings must be defined as array.
646 imap_all | **Optional.** All expect strings need to occur in server response. Default is any.
647 imap_quit | **Optional.** String to send server to initiate a clean close of the connection.
648 imap_refuse | **Optional.** Accept TCP refusals with states ok, warn, crit (default: crit).
649 imap_mismatch | **Optional.** Accept expected string mismatches with states ok, warn, crit (default: warn).
650 imap_jail | **Optional.** Hide output from TCP socket.
651 imap_maxbytes | **Optional.** Close connection once more than this number of bytes are received.
652 imap_delay | **Optional.** Seconds to wait between sending string and polling for response.
653 imap_certificate_age | **Optional.** Minimum number of days a certificate has to be valid.
654 imap_ssl | **Optional.** Use SSL for the connection.
655 imap_warning | **Optional.** Response time to result in warning status (seconds).
656 imap_critical | **Optional.** Response time to result in critical status (seconds).
657 imap_timeout | **Optional.** Seconds before connection times out (default: 10).
658 imap_ipv4 | **Optional.** Use IPv4 connection. Defaults to false.
659 imap_ipv6 | **Optional.** Use IPv6 connection. Defaults to false.
662 ### <a id="plugin-check-command-ldap"></a> ldap
664 The [check_ldap](https://www.monitoring-plugins.org/doc/man/check_ldap.html) plugin
665 can be used to check LDAP servers.
667 The plugin can also be used for monitoring ldaps connections instead of the deprecated `check_ldaps`.
668 This can be ensured by enabling `ldap_starttls` or `ldap_ssl`.
670 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
673 ----------------|--------------
674 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.
675 ldap_port | **Optional.** Port number. Defaults to 389.
676 ldap_attr | **Optional.** LDAP attribute to search for (default: "(objectclass=*)"
677 ldap_base | **Required.** LDAP base (eg. ou=myunit,o=myorg,c=at).
678 ldap_bind | **Optional.** LDAP bind DN (if required).
679 ldap_pass | **Optional.** LDAP password (if required).
680 ldap_starttls | **Optional.** Use STARTSSL mechanism introduced in protocol version 3.
681 ldap_ssl | **Optional.** Use LDAPS (LDAP v2 SSL method). This also sets the default port to 636.
682 ldap_v2 | **Optional.** Use LDAP protocol version 2 (enabled by default).
683 ldap_v3 | **Optional.** Use LDAP protocol version 3 (disabled by default)
684 ldap_warning | **Optional.** Response time to result in warning status (seconds).
685 ldap_critical | **Optional.** Response time to result in critical status (seconds).
686 ldap_timeout | **Optional.** Seconds before connection times out (default: 10).
687 ldap_verbose | **Optional.** Show details for command-line debugging (disabled by default)
689 ### <a id="plugin-check-command-load"></a> load
691 The [check_load](https://www.monitoring-plugins.org/doc/man/check_load.html) plugin
692 tests the current system load average.
694 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
697 ----------------|--------------
698 load_wload1 | **Optional.** The 1-minute warning threshold. Defaults to 5.
699 load_wload5 | **Optional.** The 5-minute warning threshold. Defaults to 4.
700 load_wload15 | **Optional.** The 15-minute warning threshold. Defaults to 3.
701 load_cload1 | **Optional.** The 1-minute critical threshold. Defaults to 10.
702 load_cload5 | **Optional.** The 5-minute critical threshold. Defaults to 6.
703 load_cload15 | **Optional.** The 15-minute critical threshold. Defaults to 4.
704 load_percpu | **Optional.** Divide the load averages by the number of CPUs (when possible). Defaults to false.
706 ### <a id="plugin-check-command-mailq"></a> mailq
708 The [check_mailq](https://www.monitoring-plugins.org/doc/man/check_mailq.html) plugin
709 checks the number of messages in the mail queue (supports multiple sendmail queues, qmail).
711 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
714 ------------------------|--------------
715 mailq_warning | **Required.** Min. number of messages in queue to generate warning.
716 mailq_critical | **Required.** Min. number of messages in queue to generate critical alert ( w < c ).
717 mailq_domain_warning | **Optional.** Min. number of messages for same domain in queue to generate warning
718 mailq_domain_critical | **Optional.** Min. number of messages for same domain in queue to generate critical alert ( W < C ).
719 mailq_timeout | **Optional.** Plugin timeout in seconds (default = 15).
720 mailq_servertype | **Optional.** [ sendmail \| qmail \| postfix \| exim \| nullmailer ] (default = autodetect).
722 ### <a id="plugin-check-command-mysql"></a> mysql
724 The [check_mysql](https://www.monitoring-plugins.org/doc/man/check_mysql.html) plugin
725 tests connections to a MySQL server.
727 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
730 ------------------------|---------------------------------------------------------------
731 mysql_hostname | **Optional.** Host name, IP Address, or unix socket (must be an absolute path).
732 mysql_port | **Optional.** Port number (default: 3306).
733 mysql_ignore_auth | **Optional.** Ignore authentication failure and check for mysql connectivity only.
734 mysql_database | **Optional.** Check database with indicated name.
735 mysql_file | **Optional.** Read from the specified client options file.
736 mysql_group | **Optional.** Use a client options group.
737 mysql_username | **Optional.** Connect using the indicated username.
738 mysql_password | **Optional.** Use the indicated password to authenticate the connection.
739 mysql_check_slave | **Optional.** Check if the slave thread is running properly.
740 mysql_warning | **Optional.** Exit with WARNING status if slave server is more than INTEGER seconds behind master.
741 mysql_critical | **Optional.** Exit with CRITICAL status if slave server is more then INTEGER seconds behind master.
742 mysql_ssl | **Optional.** Use ssl encryptation.
743 mysql_cacert | **Optional.** Path to CA signing the cert.
744 mysql_cert | **Optional.** Path to SSL certificate.
745 mysql_key | **Optional.** Path to private SSL key.
746 mysql_cadir | **Optional.** Path to CA directory.
747 mysql_ciphers | **Optional.** List of valid SSL ciphers.
750 ### <a id="plugin-check-command-mysql-query"></a> mysql_query
752 The [check_mysql_query](https://www.monitoring-plugins.org/doc/man/check_mysql_query.html) plugin
753 checks a query result against threshold levels.
754 The result from the query should be numeric. For extra security, create a user with minimal access.
756 **Note**: You must specify `mysql_query_password` with an empty string to force an empty password,
757 overriding any my.cnf settings.
759 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
762 ------------------------|---------------------------------------------------------------
763 mysql_query_hostname | **Optional.** Host name, IP Address, or unix socket (must be an absolute path).
764 mysql_query_port | **Optional.** Port number (default: 3306).
765 mysql_query_database | **Optional.** Check database with indicated name.
766 mysql_query_file | **Optional.** Read from the specified client options file.
767 mysql_query_group | **Optional.** Use a client options group.
768 mysql_query_username | **Optional.** Connect using the indicated username.
769 mysql_query_password | **Optional.** Use the indicated password to authenticate the connection.
770 mysql_query_execute | **Required.** SQL Query to run on the MySQL Server.
771 mysql_query_warning | **Optional.** Exit with WARNING status if query is outside of the range (format: start:end).
772 mysql_query_critical | **Optional.** Exit with CRITICAL status if query is outside of the range.
775 ### <a id="plugin-check-command-negate"></a> negate
777 The [negate](https://www.monitoring-plugins.org/doc/man/negate.html) plugin
778 negates the status of a plugin (returns OK for CRITICAL and vice-versa).
779 Additional switches can be used to control which state becomes what.
781 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
784 ------------------------|---------------------------------------------------------------
785 negate_timeout | **Optional.** Seconds before plugin times out (default: 11).
786 negate_timeout_result | **Optional.** Custom result on Negate timeouts, default to UNKNOWN.
787 negate_ok | **Optional.** OK, WARNING, CRITICAL or UNKNOWN.
788 negate_warning | Numeric values are accepted.
789 negate_critical | If nothing is specified, permutes OK and CRITICAL.
790 negate_substitute | **Optional.** Substitute output text as well. Will only substitute text in CAPITALS.
791 negate_command | **Required.** Command to be negated.
792 negate_arguments | **Optional.** Arguments for the negated command.
794 ### <a id="plugin-check-command-nrpe"></a> nrpe
796 The `check_nrpe` plugin can be used to query an [NRPE](http://docs.icinga.org/latest/en/nrpe.html)
797 server or [NSClient++](https://www.nsclient.org). **Note**: This plugin
798 is considered insecure/deprecated.
800 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
803 ----------------|--------------
804 nrpe_address | **Optional.** The host's address. Defaults to "$address$" if the host's `address` attribute is set, "$address6$" otherwise.
805 nrpe_port | **Optional.** The NRPE port. Defaults to 5666.
806 nrpe_command | **Optional.** The command that should be executed.
807 nrpe_no_ssl | **Optional.** Whether to disable SSL or not. Defaults to `false`.
808 nrpe_timeout_unknown | **Optional.** Whether to set timeouts to unknown instead of critical state. Defaults to `false`.
809 nrpe_timeout | **Optional.** The timeout in seconds.
810 nrpe_arguments | **Optional.** Arguments that should be passed to the command. Multiple arguments must be defined as array.
811 nrpe_ipv4 | **Optional.** Use IPv4 connection. Defaults to false.
812 nrpe_ipv6 | **Optional.** Use IPv6 connection. Defaults to false.
815 ### <a id="plugin-check-command-nscp"></a> nscp
817 The [check_nt](https://www.monitoring-plugins.org/doc/man/check_nt.html) plugin
818 collects data from the [NSClient++](https://www.nsclient.org) service.
820 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
823 ----------------|--------------
824 nscp_address | **Optional.** The host's address. Defaults to "$address$" if the host's `address` attribute is set, "$address6$" otherwise.
825 nscp_port | **Optional.** The NSClient++ port. Defaults to 12489.
826 nscp_password | **Optional.** The NSClient++ password.
827 nscp_variable | **Required.** The variable that should be checked.
828 nscp_params | **Optional.** Parameters for the query. Multiple parameters must be defined as array.
829 nscp_warn | **Optional.** The warning threshold.
830 nscp_crit | **Optional.** The critical threshold.
831 nscp_timeout | **Optional.** The query timeout in seconds.
832 nscp_showall | **Optional.** Use with SERVICESTATE to see working services or PROCSTATE for running processes. Defaults to false.
835 ### <a id="plugin-check-command-ntp-time"></a> ntp_time
837 The [check_ntp_time](https://www.monitoring-plugins.org/doc/man/check_ntp_time.html) plugin
838 checks the clock offset between the local host and a remote NTP server.
840 **Note**: If you want to monitor an NTP server, please use `ntp_peer`.
842 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
845 ----------------|--------------
846 ntp_address | **Optional.** The host's address. Defaults to "$address$" if the host's `address` attribute is set, "$address6$" otherwise.
847 ntp_port | **Optional.** Port number (default: 123).
848 ntp_quiet | **Optional.** Returns UNKNOWN instead of CRITICAL if offset cannot be found.
849 ntp_warning | **Optional.** Offset to result in warning status (seconds).
850 ntp_critical | **Optional.** Offset to result in critical status (seconds).
851 ntp_timeoffset | **Optional.** Expected offset of the ntp server relative to local server (seconds).
852 ntp_timeout | **Optional.** Seconds before connection times out (default: 10).
853 ntp_ipv4 | **Optional.** Use IPv4 connection. Defaults to false.
854 ntp_ipv6 | **Optional.** Use IPv6 connection. Defaults to false.
857 ### <a id="plugin-check-command-ntp-peer"></a> ntp_peer
859 The [check_ntp_peer](https://www.monitoring-plugins.org/doc/man/check_ntp_peer.html) plugin
860 checks the health of an NTP server. It supports checking the offset with the sync peer, the
861 jitter and stratum. This plugin will not check the clock offset between the local host and NTP
862 server; please use `ntp_time` for that purpose.
864 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
867 ----------------|--------------
868 ntp_address | **Optional.** The host's address. Defaults to "$address$" if the host's `address` attribute is set, "$address6$" otherwise.
869 ntp_port | **Optional.** The port to use. Default to 123.
870 ntp_warning | **Optional.** Offset to result in warning status (seconds).
871 ntp_critical | **Optional.** Offset to result in critical status (seconds).
872 ntp_wstratum | **Optional.** Warning threshold for stratum of server's synchronization peer.
873 ntp_cstratum | **Optional.** Critical threshold for stratum of server's synchronization peer.
874 ntp_wjitter | **Optional.** Warning threshold for jitter.
875 ntp_cjitter | **Optional.** Critical threshold for jitter.
876 ntp_wsource | **Optional.** Warning threshold for number of usable time sources.
877 ntp_csource | **Optional.** Critical threshold for number of usable time sources.
878 ntp_timeout | **Optional.** Seconds before connection times out (default: 10).
879 ntp_ipv4 | **Optional.** Use IPv4 connection. Defaults to false.
880 ntp_ipv6 | **Optional.** Use IPv6 connection. Defaults to false.
883 ### <a id="plugin-check-command-passive"></a> passive
885 Specialised check command object for passive checks executing the `check_dummy` plugin with appropriate default values.
887 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
890 ----------------|--------------
891 dummy_state | **Optional.** The state. Can be one of 0 (ok), 1 (warning), 2 (critical) and 3 (unknown). Defaults to 3.
892 dummy_text | **Optional.** Plugin output. Defaults to "No Passive Check Result Received.".
894 ### <a id="plugin-check-command-pgsql"></a> pgsql
896 The [check_pgsql](https://www.monitoring-plugins.org/doc/man/check_pgsql.html) plugin
897 tests a PostgreSQL DBMS to determine whether it is active and accepting queries.
898 If a query is specified using the `pgsql_query` attribute, it will be executed after
899 connecting to the server. The result from the query has to be numeric in order
900 to compare it against the query thresholds if set.
902 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
905 ------------------------|---------------------------------------------------------------
906 pgsql_hostname | **Optional.** Host name, IP Address, or unix socket (must be an absolute path).
907 pgsql_port | **Optional.** Port number (default: 5432).
908 pgsql_database | **Optional.** Database to check (default: template1).
909 pgsql_username | **Optional.** Login name of user.
910 pgsql_password | **Optional.** Password (BIG SECURITY ISSUE).
911 pgsql_options | **Optional.** Connection parameters (keyword = value), see below.
912 pgsql_warning | **Optional.** Response time to result in warning status (seconds).
913 pgsql_critical | **Optional.** Response time to result in critical status (seconds).
914 pgsql_timeout | **Optional.** Seconds before connection times out (default: 10).
915 pgsql_query | **Optional.** SQL query to run. Only first column in first row will be read.
916 pgsql_query_warning | **Optional.** SQL query value to result in warning status (double).
917 pgsql_query_critical | **Optional.** SQL query value to result in critical status (double).
919 ### <a id="plugin-check-command-ping"></a> ping
921 The [check_ping](https://www.monitoring-plugins.org/doc/man/check_ping.html) plugin
922 uses the ping command to probe the specified host for packet loss (percentage) and
923 round trip average (milliseconds).
925 This command uses the host's `address` attribute if available and falls back to using
926 the `address6` attribute if the `address` attribute is not set.
928 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
931 ----------------|--------------
932 ping_address | **Optional.** The host's address. Defaults to "$address$" if the host's `address` attribute is set, "$address6$" otherwise.
933 ping_wrta | **Optional.** The RTA warning threshold in milliseconds. Defaults to 100.
934 ping_wpl | **Optional.** The packet loss warning threshold in %. Defaults to 5.
935 ping_crta | **Optional.** The RTA critical threshold in milliseconds. Defaults to 200.
936 ping_cpl | **Optional.** The packet loss critical threshold in %. Defaults to 15.
937 ping_packets | **Optional.** The number of packets to send. Defaults to 5.
938 ping_timeout | **Optional.** The plugin timeout in seconds. Defaults to 0 (no timeout).
941 ### <a id="plugin-check-command-ping4"></a> ping4
943 The [check_ping](https://www.monitoring-plugins.org/doc/man/check_ping.html) plugin
944 uses the ping command to probe the specified host for packet loss (percentage) and
945 round trip average (milliseconds).
947 This command uses the host's `address` attribute if not explicitely specified using
948 the `ping_address` attribute.
950 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
953 ----------------|--------------
954 ping_address | **Optional.** The host's IPv4 address. Defaults to "$address$".
955 ping_wrta | **Optional.** The RTA warning threshold in milliseconds. Defaults to 100.
956 ping_wpl | **Optional.** The packet loss warning threshold in %. Defaults to 5.
957 ping_crta | **Optional.** The RTA critical threshold in milliseconds. Defaults to 200.
958 ping_cpl | **Optional.** The packet loss critical threshold in %. Defaults to 15.
959 ping_packets | **Optional.** The number of packets to send. Defaults to 5.
960 ping_timeout | **Optional.** The plugin timeout in seconds. Defaults to 0 (no timeout).
962 ### <a id="plugin-check-command-ping6"></a> ping6
964 The [check_ping](https://www.monitoring-plugins.org/doc/man/check_ping.html) plugin
965 uses the ping command to probe the specified host for packet loss (percentage) and
966 round trip average (milliseconds).
968 This command uses the host's `address6` attribute if not explicitely specified using
969 the `ping_address` attribute.
971 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
974 ----------------|--------------
975 ping_address | **Optional.** The host's IPv6 address. Defaults to "$address6$".
976 ping_wrta | **Optional.** The RTA warning threshold in milliseconds. Defaults to 100.
977 ping_wpl | **Optional.** The packet loss warning threshold in %. Defaults to 5.
978 ping_crta | **Optional.** The RTA critical threshold in milliseconds. Defaults to 200.
979 ping_cpl | **Optional.** The packet loss critical threshold in %. Defaults to 15.
980 ping_packets | **Optional.** The number of packets to send. Defaults to 5.
981 ping_timeout | **Optional.** The plugin timeout in seconds. Defaults to 0 (no timeout).
984 ### <a id="plugin-check-command-pop"></a> pop
986 The [check_pop](https://www.monitoring-plugins.org/doc/man/check_pop.html) plugin
987 tests POP connections with the specified host (or unix socket).
989 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
992 ---------------------|--------------
993 pop_address | **Optional.** The host's address. Defaults to "$address$" if the host's `address` attribute is set, "$address6$" otherwise.
994 pop_port | **Optional.** The port that should be checked. Defaults to 110.
995 pop_escape | **Optional.** Can use \\n, \\r, \\t or \\ in send or quit string. Must come before send or quit option. Default: nothing added to send, \\r\\n added to end of quit.
996 pop_send | **Optional.** String to send to the server.
997 pop_expect | **Optional.** String to expect in server response. Multiple strings must be defined as array.
998 pop_all | **Optional.** All expect strings need to occur in server response. Default is any.
999 pop_quit | **Optional.** String to send server to initiate a clean close of the connection.
1000 pop_refuse | **Optional.** Accept TCP refusals with states ok, warn, crit (default: crit).
1001 pop_mismatch | **Optional.** Accept expected string mismatches with states ok, warn, crit (default: warn).
1002 pop_jail | **Optional.** Hide output from TCP socket.
1003 pop_maxbytes | **Optional.** Close connection once more than this number of bytes are received.
1004 pop_delay | **Optional.** Seconds to wait between sending string and polling for response.
1005 pop_certificate_age | **Optional.** Minimum number of days a certificate has to be valid.
1006 pop_ssl | **Optional.** Use SSL for the connection.
1007 pop_warning | **Optional.** Response time to result in warning status (seconds).
1008 pop_critical | **Optional.** Response time to result in critical status (seconds).
1009 pop_timeout | **Optional.** Seconds before connection times out (default: 10).
1010 pop_ipv4 | **Optional.** Use IPv4 connection. Defaults to false.
1011 pop_ipv6 | **Optional.** Use IPv6 connection. Defaults to false.
1014 ### <a id="plugin-check-command-processes"></a> procs
1016 The [check_procs](https://www.monitoring-plugins.org/doc/man/check_procs.html) plugin
1017 checks all processes and generates WARNING or CRITICAL states if the specified
1018 metric is outside the required threshold ranges. The metric defaults to number
1019 of processes. Search filters can be applied to limit the processes to check.
1021 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
1024 ---------------------|--------------
1025 procs_warning | **Optional.** The process count warning threshold. Defaults to 250.
1026 procs_critical | **Optional.** The process count critical threshold. Defaults to 400.
1027 procs_metric | **Optional.** Check thresholds against metric.
1028 procs_timeout | **Optional.** Seconds before plugin times out.
1029 procs_traditional | **Optional.** Filter own process the traditional way by PID instead of /proc/pid/exe. Defaults to false.
1030 procs_state | **Optional.** Only scan for processes that have one or more of the status flags you specify.
1031 procs_ppid | **Optional.** Only scan for children of the parent process ID indicated.
1032 procs_vsz | **Optional.** Only scan for processes with VSZ higher than indicated.
1033 procs_rss | **Optional.** Only scan for processes with RSS higher than indicated.
1034 procs_pcpu | **Optional.** Only scan for processes with PCPU higher than indicated.
1035 procs_user | **Optional.** Only scan for processes with user name or ID indicated.
1036 procs_argument | **Optional.** Only scan for processes with args that contain STRING.
1037 procs_argument_regex | **Optional.** Only scan for processes with args that contain the regex STRING.
1038 procs_command | **Optional.** Only scan for exact matches of COMMAND (without path).
1039 procs_nokthreads | **Optional.** Only scan for non kernel threads. Defaults to false.
1042 ### <a id="plugin-check-command-simap"></a> simap
1044 The [check_simap](https://www.monitoring-plugins.org/doc/man/check_simap.html) plugin
1045 tests SIMAP connections with the specified host (or unix socket).
1047 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
1050 -----------------------|--------------
1051 simap_address | **Optional.** The host's address. Defaults to "$address$" if the host's `address` attribute is set, "$address6$" otherwise.
1052 simap_port | **Optional.** The port that should be checked. Defaults to 993.
1053 simap_escape | **Optional.** Can use \\n, \\r, \\t or \\ in send or quit string. Must come before send or quit option. Default: nothing added to send, \\r\\n added to end of quit.
1054 simap_send | **Optional.** String to send to the server.
1055 simap_expect | **Optional.** String to expect in server response. Multiple strings must be defined as array.
1056 simap_all | **Optional.** All expect strings need to occur in server response. Default is any.
1057 simap_quit | **Optional.** String to send server to initiate a clean close of the connection.
1058 simap_refuse | **Optional.** Accept TCP refusals with states ok, warn, crit (default: crit).
1059 simap_mismatch | **Optional.** Accept expected string mismatches with states ok, warn, crit (default: warn).
1060 simap_jail | **Optional.** Hide output from TCP socket.
1061 simap_maxbytes | **Optional.** Close connection once more than this number of bytes are received.
1062 simap_delay | **Optional.** Seconds to wait between sending string and polling for response.
1063 simap_certificate_age | **Optional.** Minimum number of days a certificate has to be valid.
1064 simap_ssl | **Optional.** Use SSL for the connection.
1065 simap_warning | **Optional.** Response time to result in warning status (seconds).
1066 simap_critical | **Optional.** Response time to result in critical status (seconds).
1067 simap_timeout | **Optional.** Seconds before connection times out (default: 10).
1068 simap_ipv4 | **Optional.** Use IPv4 connection. Defaults to false.
1069 simap_ipv6 | **Optional.** Use IPv6 connection. Defaults to false.
1071 ### <a id="plugin-check-command-smart"></a> smart
1073 The [check_ide_smart](https://www.monitoring-plugins.org/doc/man/check_ide_smart.html) plugin
1074 checks a local hard drive with the (Linux specific) SMART interface. Requires installation of `smartctl`.
1076 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
1079 ----------------|--------------
1080 smart_device | **Required.** The name of a local hard drive to monitor.
1083 ### <a id="plugin-check-command-smtp"></a> smtp
1085 The [check_smtp](https://www.monitoring-plugins.org/doc/man/check_smtp.html) plugin
1086 will attempt to open an SMTP connection with the host.
1088 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
1091 ----------------------|--------------
1092 smtp_address | **Optional.** The host's address. Defaults to "$address$" if the host's `address` attribute is set, "$address6$" otherwise.
1093 smtp_port | **Optional.** The port that should be checked. Defaults to 25.
1094 smtp_mail_from | **Optional.** Test a MAIL FROM command with the given email address.
1095 smtp_expect | **Optional.** String to expect in first line of server response (default: '220').
1096 smtp_command | **Optional.** SMTP command (may be used repeatedly).
1097 smtp_response | **Optional.** Expected response to command (may be used repeatedly).
1098 smtp_helo_fqdn | **Optional.** FQDN used for HELO
1099 smtp_certificate_age | **Optional.** Minimum number of days a certificate has to be valid.
1100 smtp_starttls | **Optional.** Use STARTTLS for the connection.
1101 smtp_authtype | **Optional.** SMTP AUTH type to check (default none, only LOGIN supported).
1102 smtp_authuser | **Optional.** SMTP AUTH username.
1103 smtp_authpass | **Optional.** SMTP AUTH password.
1104 smtp_ignore_quit | **Optional.** Ignore failure when sending QUIT command to server.
1105 smtp_warning | **Optional.** Response time to result in warning status (seconds).
1106 smtp_critical | **Optional.** Response time to result in critical status (seconds).
1107 smtp_timeout | **Optional.** Seconds before connection times out (default: 10).
1108 smtp_ipv4 | **Optional.** Use IPv4 connection. Defaults to false.
1109 smtp_ipv6 | **Optional.** Use IPv6 connection. Defaults to false.
1112 ### <a id="plugin-check-command-snmp"></a> snmp
1114 The [check_snmp](https://www.monitoring-plugins.org/doc/man/check_snmp.html) plugin
1115 checks the status of remote machines and obtains system information via SNMP.
1117 **Note**: This plugin uses the `snmpget` command included with the NET-SNMP package.
1119 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
1122 --------------------|--------------
1123 snmp_address | **Optional.** The host's address. Defaults to "$address$" if the host's `address` attribute is set, "$address6$" otherwise.
1124 snmp_oid | **Required.** The SNMP OID.
1125 snmp_community | **Optional.** The SNMP community. Defaults to "public".
1126 snmp_port | **Optional.** The SNMP port. Defaults to "161".
1127 snmp_retries | **Optional.** Number of retries to be used in the SNMP requests.
1128 snmp_warn | **Optional.** The warning threshold.
1129 snmp_crit | **Optional.** The critical threshold.
1130 snmp_string | **Optional.** Return OK state if the string matches exactly with the output value
1131 snmp_ereg | **Optional.** Return OK state if extended regular expression REGEX matches with the output value
1132 snmp_eregi | **Optional.** Return OK state if case-insensitive extended REGEX matches with the output value
1133 snmp_label | **Optional.** Prefix label for output value
1134 snmp_invert_search | **Optional.** Invert search result and return CRITICAL state if found
1135 snmp_units | **Optional.** Units label(s) for output value (e.g., 'sec.').
1136 snmp_version | **Optional.** Version to use. E.g. 1, 2, 2c or 3.
1137 snmp_miblist | **Optional.** MIB's to use, comma separated. Defaults to "ALL".
1138 snmp_rate_multiplier | **Optional.** Converts rate per second. For example, set to 60 to convert to per minute.
1139 snmp_rate | **Optional.** Boolean. Enable rate calculation.
1140 snmp_getnext | **Optional.** Boolean. Use SNMP GETNEXT. Defaults to false.
1141 snmp_timeout | **Optional.** The command timeout in seconds. Defaults to 10 seconds.
1143 ### <a id="plugin-check-command-snmpv3"></a> snmpv3
1145 Check command object for the [check_snmp](https://www.monitoring-plugins.org/doc/man/check_snmp.html)
1146 plugin, using SNMPv3 authentication and encryption options.
1148 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
1151 ---------------------|--------------
1152 snmpv3_address | **Optional.** The host's address. Defaults to "$address$" if the host's `address` attribute is set, "$address6$" otherwise.
1153 snmpv3_getnext | **Optional.** Use SNMP GETNEXT instead of SNMP GET.
1154 snmpv3_seclevel | **Optional.** The security level. Defaults to authPriv.
1155 snmpv3_auth_alg | **Optional.** The authentication algorithm. Defaults to SHA.
1156 snmpv3_user | **Required.** The username to log in with.
1157 snmpv3_auth_key | **Required,** The authentication key. Required if `snmpv3_seclevel` is set to `authPriv` otherwise optional.
1158 snmpv3_priv_key | **Required.** The encryption key.
1159 snmpv3_oid | **Required.** The SNMP OID.
1160 snmpv3_priv_alg | **Optional.** The encryption algorithm. Defaults to AES.
1161 snmpv3_warn | **Optional.** The warning threshold.
1162 snmpv3_crit | **Optional.** The critical threshold.
1163 snmpv3_string | **Optional.** Return OK state (for that OID) if STRING is an exact match.
1164 snmpv3_ereg | **Optional.** Return OK state (for that OID) if extended regular expression REGEX matches.
1165 snmpv3_eregi | **Optional.** Return OK state (for that OID) if case-insensitive extended REGEX matches.
1166 snmpv3_invert_search | **Optional.** Invert search result and return CRITICAL if found
1167 snmpv3_label | **Optional.** Prefix label for output value.
1168 snmpv3_units | **Optional.** Units label(s) for output value (e.g., 'sec.').
1169 snmpv3_rate_multiplier | **Optional.** Converts rate per second. For example, set to 60 to convert to per minute.
1170 snmpv3_rate | **Optional.** Boolean. Enable rate calculation.
1171 snmpv3_timeout | **Optional.** The command timeout in seconds. Defaults to 10 seconds.
1173 ### <a id="plugin-check-command-snmp-uptime"></a> snmp-uptime
1175 Check command object for the [check_snmp](https://www.monitoring-plugins.org/doc/man/check_snmp.html)
1176 plugin, using the uptime OID by default.
1178 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
1181 ----------------|--------------
1182 snmp_address | **Optional.** The host's address. Defaults to "$address$" if the host's `address` attribute is set, "$address6$" otherwise.
1183 snmp_oid | **Optional.** The SNMP OID. Defaults to "1.3.6.1.2.1.1.3.0".
1184 snmp_community | **Optional.** The SNMP community. Defaults to "public".
1187 ### <a id="plugin-check-command-spop"></a> spop
1189 The [check_spop](https://www.monitoring-plugins.org/doc/man/check_spop.html) plugin
1190 tests SPOP connections with the specified host (or unix socket).
1192 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
1195 ----------------------|--------------
1196 spop_address | **Optional.** The host's address. Defaults to "$address$" if the host's `address` attribute is set, "$address6$" otherwise.
1197 spop_port | **Optional.** The port that should be checked. Defaults to 995.
1198 spop_escape | **Optional.** Can use \\n, \\r, \\t or \\ in send or quit string. Must come before send or quit option. Default: nothing added to send, \\r\\n added to end of quit.
1199 spop_send | **Optional.** String to send to the server.
1200 spop_expect | **Optional.** String to expect in server response. Multiple strings must be defined as array.
1201 spop_all | **Optional.** All expect strings need to occur in server response. Default is any.
1202 spop_quit | **Optional.** String to send server to initiate a clean close of the connection.
1203 spop_refuse | **Optional.** Accept TCP refusals with states ok, warn, crit (default: crit).
1204 spop_mismatch | **Optional.** Accept expected string mismatches with states ok, warn, crit (default: warn).
1205 spop_jail | **Optional.** Hide output from TCP socket.
1206 spop_maxbytes | **Optional.** Close connection once more than this number of bytes are received.
1207 spop_delay | **Optional.** Seconds to wait between sending string and polling for response.
1208 spop_certificate_age | **Optional.** Minimum number of days a certificate has to be valid.
1209 spop_ssl | **Optional.** Use SSL for the connection.
1210 spop_warning | **Optional.** Response time to result in warning status (seconds).
1211 spop_critical | **Optional.** Response time to result in critical status (seconds).
1212 spop_timeout | **Optional.** Seconds before connection times out (default: 10).
1213 spop_ipv4 | **Optional.** Use IPv4 connection. Defaults to false.
1214 spop_ipv6 | **Optional.** Use IPv6 connection. Defaults to false.
1217 ### <a id="plugin-check-command-ssh"></a> ssh
1219 The [check_ssh](https://www.monitoring-plugins.org/doc/man/check_ssh.html) plugin
1220 connects to an SSH server at a specified host and port.
1222 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
1225 ----------------|--------------
1226 ssh_address | **Optional.** The host's address. Defaults to "$address$" if the host's `address` attribute is set, "$address6$" otherwise.
1227 ssh_port | **Optional.** The port that should be checked. Defaults to 22.
1228 ssh_timeout | **Optional.** Seconds before connection times out. Defaults to 10.
1229 ssh_ipv4 | **Optional.** Use IPv4 connection. Defaults to false.
1230 ssh_ipv6 | **Optional.** Use IPv6 connection. Defaults to false.
1233 ### <a id="plugin-check-command-ssl"></a> ssl
1235 Check command object for the [check_tcp](https://www.monitoring-plugins.org/doc/man/check_tcp.html) plugin,
1236 using ssl-related options.
1238 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
1241 ------------------------------|--------------
1242 ssl_address | **Optional.** The host's address. Defaults to "$address$" if the host's `address` attribute is set, "$address6$" otherwise.
1243 ssl_port | **Required.** The port that should be checked.
1244 ssl_timeout | **Optional.** Timeout in seconds for the connect and handshake. The plugin default is 10 seconds.
1245 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.
1246 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.
1249 ### <a id="plugin-check-command-ssmtp"></a> ssmtp
1251 The [check_ssmtp](https://www.monitoring-plugins.org/doc/man/check_ssmtp.html) plugin
1252 tests SSMTP connections with the specified host (or unix socket).
1254 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
1257 -----------------------|--------------
1258 ssmtp_address | **Optional.** The host's address. Defaults to "$address$" if the host's `address` attribute is set, "$address6$" otherwise.
1259 ssmtp_port | **Optional.** The port that should be checked. Defaults to 465.
1260 ssmtp_escape | **Optional.** Can use \\n, \\r, \\t or \\ in send or quit string. Must come before send or quit option. Default: nothing added to send, \\r\\n added to end of quit.
1261 ssmtp_send | **Optional.** String to send to the server.
1262 ssmtp_expect | **Optional.** String to expect in server response. Multiple strings must be defined as array.
1263 ssmtp_all | **Optional.** All expect strings need to occur in server response. Default is any.
1264 ssmtp_quit | **Optional.** String to send server to initiate a clean close of the connection.
1265 ssmtp_refuse | **Optional.** Accept TCP refusals with states ok, warn, crit (default: crit).
1266 ssmtp_mismatch | **Optional.** Accept expected string mismatches with states ok, warn, crit (default: warn).
1267 ssmtp_jail | **Optional.** Hide output from TCP socket.
1268 ssmtp_maxbytes | **Optional.** Close connection once more than this number of bytes are received.
1269 ssmtp_delay | **Optional.** Seconds to wait between sending string and polling for response.
1270 ssmtp_certificate_age | **Optional.** Minimum number of days a certificate has to be valid.
1271 ssmtp_ssl | **Optional.** Use SSL for the connection.
1272 ssmtp_warning | **Optional.** Response time to result in warning status (seconds).
1273 ssmtp_critical | **Optional.** Response time to result in critical status (seconds).
1274 ssmtp_timeout | **Optional.** Seconds before connection times out (default: 10).
1275 ssmtp_ipv4 | **Optional.** Use IPv4 connection. Defaults to false.
1276 ssmtp_ipv6 | **Optional.** Use IPv6 connection. Defaults to false.
1279 ### <a id="plugin-check-command-swap"></a> swap
1281 The [check_swap](https://www.monitoring-plugins.org/doc/man/check_swap.html) plugin
1282 checks the swap space on a local machine.
1284 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
1287 ----------------|--------------
1288 swap_wfree | **Optional.** The free swap space warning threshold in % (enable `swap_integer` for number values). Defaults to `50%`.
1289 swap_cfree | **Optional.** The free swap space critical threshold in % (enable `swap_integer` for number values). Defaults to `25%`.
1290 swap_integer | **Optional.** Specifies whether the thresholds are passed as number or percent value. Defaults to false (percent values).
1291 swap_allswaps | **Optional.** Conduct comparisons for all swap partitions, one by one. Defaults to false.
1292 swap_noswap | **Optional.** Resulting state when there is no swap regardless of thresholds. Possible values are "ok", "warning", "critical", "unknown". Defaults to "critical".
1295 ### <a id="plugin-check-command-tcp"></a> tcp
1297 The [check_tcp](https://www.monitoring-plugins.org/doc/man/check_tcp.html) plugin
1298 tests TCP connections with the specified host (or unix socket).
1300 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
1303 ----------------|--------------
1304 tcp_address | **Optional.** The host's address. Defaults to "$address$" if the host's `address` attribute is set, "$address6$" otherwise.
1305 tcp_port | **Required.** The port that should be checked.
1306 tcp_expect | **Optional.** String to expect in server response. Multiple strings must be defined as array.
1307 tcp_all | **Optional.** All expect strings need to occur in server response. Defaults to false.
1308 tcp_escape_send | **Optional.** Enable usage of \\n, \\r, \\t or \\\\ in send string.
1309 tcp_send | **Optional.** String to send to the server.
1310 tcp_escape_quit | **Optional.** Enable usage of \\n, \\r, \\t or \\\\ in quit string.
1311 tcp_quit | **Optional.** String to send server to initiate a clean close of the connection.
1312 tcp_refuse | **Optional.** Accept TCP refusals with states ok, warn, crit. Defaults to crit.
1313 tcp_mismatch | **Optional.** Accept expected string mismatches with states ok, warn, crit. Defaults to warn.
1314 tcp_jail | **Optional.** Hide output from TCP socket.
1315 tcp_maxbytes | **Optional.** Close connection once more than this number of bytes are received.
1316 tcp_delay | **Optional.** Seconds to wait between sending string and polling for response.
1317 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) -- separated by comma.
1318 tcp_ssl | **Optional.** Use SSL for the connection. Defaults to false.
1319 tcp_wtime | **Optional.** Response time to result in warning status (seconds).
1320 tcp_ctime | **Optional.** Response time to result in critical status (seconds).
1321 tcp_timeout | **Optional.** Seconds before connection times out. Defaults to 10.
1322 tcp_ipv4 | **Optional.** Use IPv4 connection. Defaults to false.
1323 tcp_ipv6 | **Optional.** Use IPv6 connection. Defaults to false.
1326 ### <a id="plugin-check-command-udp"></a> udp
1328 The [check_udp](https://www.monitoring-plugins.org/doc/man/check_udp.html) plugin
1329 tests UDP connections with the specified host (or unix socket).
1331 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
1334 ----------------|--------------
1335 udp_address | **Optional.** The host's address. Defaults to "$address$" if the host's `address` attribute is set, "$address6$" otherwise.
1336 udp_port | **Required.** The port that should be checked.
1337 udp_send | **Required.** The payload to send in the UDP datagram.
1338 udp_expect | **Required.** The payload to expect in the response datagram.
1339 udp_quit | **Optional.** The payload to send to 'close' the session.
1340 udp_ipv4 | **Optional.** Use IPv4 connection. Defaults to false.
1341 udp_ipv6 | **Optional.** Use IPv6 connection. Defaults to false.
1344 ### <a id="plugin-check-command-ups"></a> ups
1346 The [check_ups](https://www.monitoring-plugins.org/doc/man/check_ups.html) plugin
1347 tests the UPS service on the specified host. [Network UPS Tools](http://www.networkupstools.org)
1348 must be running for this plugin to work.
1350 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
1353 ----------------|--------------
1354 ups_address | **Required.** The address of the host running upsd. Defaults to "$address$" if the host's `address` attribute is set, "$address6$" otherwise.
1355 ups_name | **Required.** The UPS name. Defaults to `ups`.
1356 ups_port | **Optional.** The port to which to connect. Defaults to 3493.
1357 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`.
1358 ups_warning | **Optional.** The warning threshold for the selected variable.
1359 ups_critical | **Optional.** The critical threshold for the selected variable.
1360 ups_celsius | **Optional.** Display the temperature in degrees Celsius instead of Fahrenheit. Defaults to `false`.
1361 ups_timeout | **Optional.** The number of seconds before the connection times out. Defaults to 10.
1364 ### <a id="plugin-check-command-users"></a> users
1366 The [check_users](https://www.monitoring-plugins.org/doc/man/check_users.html) plugin
1367 checks the number of users currently logged in on the local system and generates an
1368 error if the number exceeds the thresholds specified.
1370 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
1373 ----------------|--------------
1374 users_wgreater | **Optional.** The user count warning threshold. Defaults to 20.
1375 users_cgreater | **Optional.** The user count critical threshold. Defaults to 50.
1377 ## <a id="windows-plugins"></a> Windows Plugins for Icinga 2
1379 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.
1381 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:
1383 include <windows-plugins>
1385 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.
1388 ### <a id="windows-plugins-thresholds"></a> Threshold syntax
1390 So not specified differently the thresholds for the plugins all follow the same pattern
1393 :------------|:----------
1394 "29" | The threshold is 29.
1395 "!29" | The threshold is 29, but the negative of the result is returned.
1396 "[10-40]" | The threshold is a range from (including) 20 to 40, a value inside means the threshold has been exceeded.
1397 "![10-40]" | Same as above, but the result is inverted.
1400 ### <a id="windows-plugins-disk-windows"></a> disk-windows
1402 Check command object for the `check_disk.exe` plugin.
1403 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.).
1408 :-------------------|:------------
1409 disk\_win\_warn | **Optional**. The warning threshold.
1410 disk\_win\_crit | **Optional**. The critical threshold.
1411 disk\_win\_path | **Optional**. Check only these paths, default checks all.
1412 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.
1413 disk\_win\_exclude | **Optional**. Exclude these drives from check.
1415 ### <a id="windows-plugins-load-windows"></a> load-windows
1417 Check command object for the `check_load.exe` plugin.
1418 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`](10-icinga-template-library.md#windows-plugins-load-windows).
1423 :---------------|:------------
1424 load\_win\_warn | **Optional**. The warning threshold.
1425 load\_win\_crit | **Optional**. The critical threshold.
1428 ### <a id="windows-plugins-memory-windows"></a> memory-windows
1430 Check command object for the `check_memory.exe` plugin.
1431 The memory collection is instant.
1435 > Percentage based thresholds can be used by adding a '%' to the threshold
1436 > value. Keep in mind that memory\_win\_unit is applied before the
1437 > value is calculated.
1442 :-----------------|:------------
1443 memory\_win\_warn | **Optional**. The warning threshold.
1444 memory\_win\_crit | **Optional**. The critical threshold.
1445 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.
1448 ### <a id="windows-plugins-network-windows"></a> network-windows
1450 Check command object for the `check_network.exe` plugin.
1451 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`](10-icinga-template-library.md#windows-plugins-load-windows).
1456 :------------------|:------------
1457 network\_win\_warn | **Optional**. The warning threshold.
1458 network\_win\_crit | **Optional**. The critical threshold.
1461 ### <a id="windows-plugins-permon-windows"></a> perfmon-windows
1463 Check command object for the `check_perfmon.exe` plugin.
1464 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`.
1466 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"`
1471 :---------------------|:------------
1472 perfmon\_win\_warn | **Optional**. The warning threshold.
1473 perfmon\_win\_crit | **Optional**. The critical threshold.
1474 perfmon\_win\_counter | **Required**. The Performance Counter to use. Ex. `\Processor(_Total)\% Idle Time`.
1475 perfmon\_win\_wait | **Optional**. Time in milliseconds to wait between data collection (default: 1000).
1476 perfmon\_win\_type | **Optional**. Format in which to expect perfomance values. Possible are: long, int64 and double (default).
1479 ### <a id="windows-plugins-ping-windows"></a> ping-windows
1481 Check command object for the `check_ping.exe` plugin.
1482 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.
1487 :------------------|:------------
1488 ping\_win\_warn | **Optional**. The warning threshold. RTA and package loss separated by comma.
1489 ping\_win\_crit | **Optional**. The critical threshold. RTA and package loss separated by comma.
1490 ping\_win\_address | **Required**. An IPv4 or IPv6 address
1491 ping\_win\_packets | **Optional**. Number of packages to send. Default: 5.
1492 ping\_win\_timeout | **Optional**. The timeout in milliseconds. Default: 1000
1495 ### <a id="windows-plugins-procs-windows"></a> procs-windows
1497 Check command object for `check_procs.exe` plugin.
1498 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.
1503 :----------------|:------------
1504 procs\_win\_warn | **Optional**. The warning threshold.
1505 procs\_win\_crit | **Optional**. The critical threshold.
1506 procs\_win\_user | **Optional**. Count this useres processes.
1509 ### <a id="windows-plugins-service-windows"></a> service-windows
1511 Check command object for `check_service.exe` plugin.
1512 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.
1517 :---------------------|:------------
1518 service\_win\_warn | **Optional**. Warn when service is not running.
1519 service\_win\_service | **Required**. The critical threshold.
1522 ### <a id="windows-plugins-swap-windows"></a> swap-windows
1524 Check command object for `check_swap.exe` plugin.
1525 The data collection is instant.
1530 :---------------|:------------
1531 swap\_win\_warn | **Optional**. The warning threshold.
1532 swap\_win\_crit | **Optional**. The critical threshold.
1533 swap\_win\_unit | **Optional**. The unit to display the received value in, thresholds are interpreted in this unit. Defaults to "mb" (megabyte).
1536 ### <a id="windows-plugins-update-windows"></a> update-windows
1538 Check command object for `check_update.exe` plugin.
1539 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.
1543 > The Network Services Account which runs Icinga 2 by default does not have the required
1544 > permissions to run this check.
1549 :-------------------|:------------
1550 update\_win\_warn | If set, returns warning when important updates are available
1551 update\_win\_crit | If set, return critical when important updates that require a reboot are available.
1552 update\_win\_reboot | Set to treat 'may need update' as 'definitely needs update'
1555 ### <a id="windows-plugins-uptime-windows"></a> uptime-windows
1557 Check command opject for `check_uptime.exe` plugin.
1558 Uses GetTickCount64 to get the uptime, so boot time is not included.
1563 :-----------------|:------------
1564 uptime\_win\_warn | **Optional**. The warning threshold.
1565 uptime\_win\_crit | **Optional**. The critical threshold.
1566 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).
1569 ### <a id="windows-plugins-users-windows"></a> users-windows
1571 Check command object for `check_users.exe` plugin.
1576 :----------------|:------------
1577 users\_win\_warn | **Optional**. The warning threshold.
1578 users\_win\_crit | **Optional**. The critical threshold.
1581 ## <a id="nscp-plugin-check-commands"></a> Plugin Check Commands for NSClient++
1583 Icinga 2 can use the `nscp client` command to run arbitrary NSClient++ checks.
1585 You can enable these check commands by adding the following the include directive in your
1586 [icinga2.conf](4-configuring-icinga-2.md#icinga2-conf) configuration file:
1590 You can also optionally specify an alternative installation directory for NSClient++ by adding
1591 the NscpPath constant in your [constants.conf](4-configuring-icinga-2.md#constants-conf) configuration
1594 const NscpPath = "C:\\Program Files (x86)\\NSClient++"
1596 By default Icinga 2 uses the Microsoft Installer API to determine where NSClient++ is installed. It should
1597 not be necessary to manually set this constant.
1599 Note that it is not necessary to run NSClient++ as a Windows service for these commands to work.
1601 ### <a id="nscp-check-local"></a> nscp-local
1603 Check command object for NSClient++
1605 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
1608 ----------------|--------------
1609 nscp_log_level | **Optional.** The log level. Defaults to "critical".
1610 nscp_load_all | **Optional.** Whether to load all modules. Defaults to true.
1611 nscp_boot | **Optional.** Whether to use the --boot option. Defaults to true.
1612 nscp_query | **Required.** The NSClient++ query. Try `nscp client -q x` for a list.
1613 nscp_arguments | **Optional.** An array of query arguments.
1614 nscp_showall | **Optional.** Shows more details in plugin output, default to false.
1616 ### <a id="nscp-check-local-cpu"></a> nscp-local-cpu
1618 Check command object for the `check_cpu` NSClient++ plugin.
1621 --------------------|------------------
1622 nscp_cpu_time | **Optional.** Calculate avarage usage for the given time intervals. Value has to be an array, default to [ "1m", "5m", "15m" ].
1623 nscp_cpu_warning | **Optional.** Threshold for WARNING state in percent, default to 80.
1624 nscp_cpu_critical | **Optional.** Threshold for CRITICAL state in percent, default to 90.
1625 nscp_cpu_arguments | **Optional.** Additional arguments.
1626 nscp_cpu_showall | **Optional.** Shows more details in plugin output, default to false.
1628 ### <a id="nscp-check-local-memory"></a> nscp-local-memory
1630 Check command object for the `check_memory` NSClient++ plugin.
1633 ----------------------|------------------
1634 nscp_memory_committed | **Optional.** Check for committed memory, default to false.
1635 nscp_memory_physical | **Optional.** Check for physical memory, default to true.
1636 nscp_memory_free | **Optional.** Switch between checking free (true) or used memory (false), default to false.
1637 nscp_memory_warning | **Optional.** Threshold for WARNING state in percent or absolut (use MB, GB, ...), default to 80 (free=false) or 20 (free=true).
1638 nscp_memory_critical | **Optional.** Threshold for CRITICAL state in percent or absolut (use MB, GB, ...), default to 90 (free=false) or 10 (free=true).
1639 nscp_memory_arguments | **Optional.** Additional arguments.
1640 nscp_memory_showall | **Optional.** Shows more details in plugin output, default to false.
1642 ### <a id="nscp-check-local-os-version"></a> nscp-local-os-version
1644 Check command object for the `check_os_version` NSClient++ plugin.
1646 This command has the same custom attributes like the `nscp-local` check command.
1648 ### <a id="nscp-check-local-pagefile"></a> nscp-local-pagefile
1650 Check command object for the `check_pagefile` NSClient++ plugin.
1652 This command has the same custom attributes like the `nscp-local` check command.
1654 ### <a id="nscp-check-local-process"></a> nscp-local-process
1656 Check command object for the `check_process` NSClient++ plugin.
1658 This command has the same custom attributes like the `nscp-local` check command.
1660 ### <a id="nscp-check-local-service"></a> nscp-local-service
1662 Check command object for the `check_service` NSClient++ plugin.
1665 -----------------------|------------------
1666 nscp_service_name | **Required.** Name of service to check.
1667 nscp_service_type | **Optional.** Type to check, default to state.
1668 nscp_service_ok | **Optional.** State for return an OK, i.e. for type=state running, stopped, ...
1669 nscp_service_otype | **Optional.** Dedicate type for nscp_service_ok, default to nscp_service_state.
1670 nscp_service_warning | **Optional.** State for return an WARNING.
1671 nscp_service_wtype | **Optional.** Dedicate type for nscp_service_warning, default to nscp_service_state.
1672 nscp_service_critical | **Optional.** State for return an CRITICAL.
1673 nscp_service_ctype | **Optional.** Dedicate type for nscp_service_critical, default to nscp_service_state.
1674 nscp_service_arguments | **Optional.** Additional arguments.
1675 nscp_service_showall | **Optional.** Shows more details in plugin output, default to true.
1677 ### <a id="nscp-check-local-uptime"></a> nscp-local-uptime
1679 Check command object for the `check_uptime` NSClient++ plugin.
1681 This command has the same custom attributes like the `nscp-local` check command.
1683 ### <a id="nscp-check-local-version"></a> nscp-local-version
1685 Check command object for the `check_version` NSClient++ plugin.
1687 This command has the same custom attributes like the `nscp-local` check command.
1689 ### <a id="nscp-check-local-disk"></a> nscp-local-disk
1691 Check command object for the `check_drivesize` NSClient++ plugin.
1694 -----------------------|------------------
1695 nscp_disk_drive | **Optional.** Drive character, default to all drives.
1696 nscp_disk_free | **Optional.** Switch between checking free space (free=true) or used space (free=false), default to false.
1697 nscp_disk_warning | **Optional.** Threshold for WARNING in percent or absolut (use MB, GB, ...), default to 80 (used) or 20 percent (free).
1698 nscp_disk_critical | **Optional.** Threshold for CRITICAL in percent or absolut (use MB, GB, ...), default to 90 (used) or 10 percent (free).
1699 nscp_disk_arguments | **Optional.** Additional arguments.
1700 nscp_disk_showall | **Optional.** Shows more details in plugin output, default to true.
1702 ### <a id="nscp-check-local-counter"></a> nscp-local-counter
1704 Check command object for the `check_pdh` NSClient++ plugin.
1707 -----------------------|------------------
1708 nscp_counter_name | **Required.** Performance counter name.
1709 nscp_counter_warning | **Optional.** WARNING Threshold.
1710 nscp_counter_critical | **Optional.** CRITICAL Threshold.
1711 nscp_counter_arguments | **Optional.** Additional arguments.
1712 nscp_counter_showall | **Optional.** Shows more details in plugin output, default to false.
1713 nscp_counter_perfsyntax | **Optional.** Apply performance data label, e.g. `Total Processor Time` to avoid special character problems. Defaults to `nscp_counter_name`.
1717 ## <a id="snmp-manubulon-plugin-check-commands"></a> Plugin Check Commands for Manubulon SNMP
1719 The `SNMP Manubulon Plugin Check Commands` provide configuration for plugin check
1720 commands provided by the [SNMP Manubulon project](http://nagios.manubulon.com/index_snmp.html).
1722 **Note:** Some plugin parameters are only available in Debian packages or in a
1723 [forked repository](https://github.com/dnsmichi/manubulon-snmp) with patches applied.
1725 The SNMP manubulon plugin check commands assume that the global constant named `ManubulonPluginDir`
1726 is set to the path where the Manubublon SNMP plugins are installed.
1728 You can enable these plugin check commands by adding the following the include directive in your
1729 [icinga2.conf](4-configuring-icinga-2.md#icinga2-conf) configuration file:
1733 ### Checks by Host Type
1735 **N/A** : Not available for this type.
1737 **SNMP** : Available for simple SNMP query.
1741 **Specific** : Script name for platform specific checks.
1744 Host type | Interface | storage | load/cpu | mem | process | env | specific
1745 ------------------------|------------|----------|-----------|-----|----------|-----|-------------------------
1746 Linux | Yes | Yes | Yes | Yes | Yes | No |
1747 Windows | Yes | Yes | Yes | Yes | Yes | No | check_snmp_win.pl
1748 Cisco router/switch | Yes | N/A | Yes | Yes | N/A | Yes |
1749 HP router/switch | Yes | N/A | Yes | Yes | N/A | No |
1750 Bluecoat proxy | Yes | SNMP | Yes | SNMP| No | Yes |
1751 CheckPoint on SPLAT | Yes | Yes | Yes | Yes | Yes | No | check_snmp_cpfw.pl
1752 CheckPoint on Nokia IP | Yes | Yes | Yes | No | ?? | No | check_snmp_vrrp.pl
1753 Boostedge | Yes | Yes | Yes | Yes | ?? | No | check_snmp_boostedge.pl
1754 AS400 | Yes | Yes | Yes | Yes | No | No |
1755 NetsecureOne Netbox | Yes | Yes | Yes | ?? | Yes | No |
1756 Radware Linkproof | Yes | N/A | SNMP | SNMP| No | No | check_snmp_linkproof_nhr <br> check_snmp_vrrp.pl
1757 IronPort | Yes | SNMP | SNMP | SNMP| No | Yes |
1758 Cisco CSS | Yes | ?? | Yes | Yes | No | ?? | check_snmp_css.pl
1761 ### <a id="plugin-check-command-snmp-load"></a> snmp-load
1763 Check command object for the [check_snmp_load.pl](http://nagios.manubulon.com/snmp_load.html) plugin.
1765 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
1769 ------------------------|--------------
1770 snmp_address | **Optional.** The host's address. Defaults to "$address$" if the host's `address` attribute is set, "$address6$" otherwise.
1771 snmp_nocrypt | **Optional.** Define SNMP encryption. If set, **snmp_v3** needs to be set. Defaults to false.
1772 snmp_community | **Optional.** The SNMP community. Defaults to "public".
1773 snmp_port | **Optional.** The SNMP port connection.
1774 snmp_v2 | **Optional.** SNMP version to 2c. Defaults to false.
1775 snmp_v3 | **Optional.** SNMP version to 3. Defaults to false.
1776 snmp_login | **Optional.** SNMP version 3 username. Defaults to "snmpuser".
1777 snmp_password | **Required.** SNMP version 3 password. No value defined as default.
1778 snmp_v3_use_privpass | **Optional.** Define to use SNMP version 3 priv password. Defaults to false.
1779 snmp_authprotocol | **Optional.** SNMP version 3 authentication protocol. Defaults to "md5,des".
1780 snmp_privpass | **Required.** SNMP version 3 priv password. No value defined as default.
1781 snmp_warn | **Optional.** The warning threshold. Change the `snmp_load_type` var to "netsl" for using 3 values.
1782 snmp_crit | **Optional.** The critical threshold. Change the `snmp_load_type` var to "netsl" for using 3 values.
1783 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.
1784 snmp_perf | **Optional.** Enable perfdata values. Defaults to true.
1785 snmp_timeout | **Optional.** The command timeout in seconds. Defaults to 5 seconds.
1787 ### <a id="plugin-check-command-snmp-memory"></a> snmp-memory
1789 Check command object for the [check_snmp_mem.pl](http://nagios.manubulon.com/snmp_mem.html) plugin.
1791 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
1794 ------------------------|--------------
1795 snmp_address | **Optional.** The host's address. Defaults to "$address$" if the host's `address` attribute is set, "$address6$" otherwise.
1796 snmp_nocrypt | **Optional.** Define SNMP encryption. If set, **snmp_v3** needs to be set. Defaults to false.
1797 snmp_community | **Optional.** The SNMP community. Defaults to "public".
1798 snmp_port | **Optional.** The SNMP port connection.
1799 snmp_v2 | **Optional.** SNMP version to 2c. Defaults to false.
1800 snmp_v3 | **Optional.** SNMP version to 3. Defaults to false.
1801 snmp_login | **Optional.** SNMP version 3 username. Defaults to "snmpuser".
1802 snmp_password | **Required.** SNMP version 3 password. No value defined as default.
1803 snmp_v3_use_privpass | **Optional.** Define to use SNMP version 3 priv password. Defaults to false.
1804 snmp_authprotocol | **Optional.** SNMP version 3 authentication protocol. Defaults to "md5,des".
1805 snmp_privpass | **Required.** SNMP version 3 priv password. No value defined as default.
1806 snmp_warn | **Optional.** The warning threshold.
1807 snmp_crit | **Optional.** The critical threshold.
1808 snmp_is_cisco | **Optional.** Change OIDs for Cisco switches. Defaults to false.
1809 snmp_perf | **Optional.** Enable perfdata values. Defaults to true.
1810 snmp_timeout | **Optional.** The command timeout in seconds. Defaults to 5 seconds.
1812 ### <a id="plugin-check-command-snmp-storage"></a> snmp-storage
1814 Check command object for the [check_snmp_storage.pl](http://nagios.manubulon.com/snmp_storage.html) plugin.
1816 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
1819 ------------------------|--------------
1820 snmp_address | **Optional.** The host's address. Defaults to "$address$" if the host's `address` attribute is set, "$address6$" otherwise.
1821 snmp_nocrypt | **Optional.** Define SNMP encryption. If set, **snmp_v3** needs to be set. Defaults to false.
1822 snmp_community | **Optional.** The SNMP community. Defaults to "public".
1823 snmp_port | **Optional.** The SNMP port connection.
1824 snmp_v2 | **Optional.** SNMP version to 2c. Defaults to false.
1825 snmp_v3 | **Optional.** SNMP version to 3. Defaults to false.
1826 snmp_login | **Optional.** SNMP version 3 username. Defaults to "snmpuser".
1827 snmp_password | **Required.** SNMP version 3 password. No value defined as default.
1828 snmp_v3_use_privpass | **Optional.** Define to use SNMP version 3 priv password. Defaults to false.
1829 snmp_authprotocol | **Optional.** SNMP version 3 authentication protocol. Defaults to "md5,des".
1830 snmp_privpass | **Required.** SNMP version 3 priv password. No value defined as default.
1831 snmp_warn | **Optional.** The warning threshold.
1832 snmp_crit | **Optional.** The critical threshold.
1833 snmp_storage_name | **Optional.** Storage name. Default to regex "^/$$". More options available in the [snmp storage](http://nagios.manubulon.com/snmp_storage.html) documentation.
1834 snmp_perf | **Optional.** Enable perfdata values. Defaults to true.
1835 snmp_timeout | **Optional.** The command timeout in seconds. Defaults to 5 seconds.
1837 ### <a id="plugin-check-command-snmp-interface"></a> snmp-interface
1839 Check command object for the [check_snmp_int.pl](http://nagios.manubulon.com/snmp_int.html) plugin.
1841 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
1844 ----------------------------|--------------
1845 snmp_address | **Optional.** The host's address. Defaults to "$address$" if the host's `address` attribute is set, "$address6$" otherwise.
1846 snmp_nocrypt | **Optional.** Define SNMP encryption. If set, **snmp_v3** needs to be set. Defaults to false.
1847 snmp_community | **Optional.** The SNMP community. Defaults to "public".
1848 snmp_port | **Optional.** The SNMP port connection.
1849 snmp_v2 | **Optional.** SNMP version to 2c. Defaults to false.
1850 snmp_v3 | **Optional.** SNMP version to 3. Defaults to false.
1851 snmp_login | **Optional.** SNMP version 3 username. Defaults to "snmpuser".
1852 snmp_password | **Required.** SNMP version 3 password. No value defined as default.
1853 snmp_v3_use_privpass | **Optional.** Define to use SNMP version 3 priv password. Defaults to false.
1854 snmp_authprotocol | **Optional.** SNMP version 3 authentication protocol. Defaults to "md5,des".
1855 snmp_privpass | **Required.** SNMP version 3 priv password. No value defined as default.
1856 snmp_warn | **Optional.** The warning threshold.
1857 snmp_crit | **Optional.** The critical threshold.
1858 snmp_interface | **Optional.** Network interface name. Default to regex "eth0".
1859 snmp_interface_perf | **Optional.** Check the input/ouput bandwidth of the interface. Defaults to true.
1860 snmp_interface_label | **Optional.** Add label before speed in output: in=, out=, errors-out=, etc.
1861 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.
1862 snmp_interface_percent | **Optional.** Output performance data in % of max speed. Defaults to false.
1863 snmp_interface_kbits | **Optional.** Make the warning and critical levels in KBits/s. Defaults to true.
1864 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.
1865 snmp_interface_64bit | **Optional.** Use 64 bits counters instead of the standard counters when checking bandwidth & performance data for interface >= 1Gbps. Defaults to false.
1866 snmp_interface_errors | **Optional.** Add error & discard to Perfparse output. Defaults to true.
1867 snmp_interface_noregexp | **Optional.** Do not use regexp to match interface name in description OID. Defaults to false.
1868 snmp_interface_delta | **Optional.** Delta time of perfcheck. Defaults to "300" (5 min).
1869 snmp_interface_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.
1870 snmp_interface_ifname | **Optional.** Switch from IF-MIB::ifDescr to IF-MIB::ifName when looking up the interface's name
1871 snmp_perf | **Optional.** Enable perfdata values. Defaults to true.
1872 snmp_timeout | **Optional.** The command timeout in seconds. Defaults to 5 seconds.
1874 ### <a id="plugin-check-command-snmp-process"></a> snmp-process
1876 Check command object for the [check_snmp_process.pl](http://nagios.manubulon.com/snmp_process.html) plugin.
1878 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
1881 ------------------------|--------------
1882 snmp_address | **Optional.** The host's address. Defaults to "$address$" if the host's `address` attribute is set, "$address6$" otherwise.
1883 snmp_nocrypt | **Optional.** Define SNMP encryption. If set, **snmp_v3** needs to be set. Defaults to false.
1884 snmp_community | **Optional.** The SNMP community. Defaults to "public".
1885 snmp_port | **Optional.** The SNMP port connection.
1886 snmp_v2 | **Optional.** SNMP version to 2c. Defaults to false.
1887 snmp_v3 | **Optional.** SNMP version to 3. Defaults to false.
1888 snmp_login | **Optional.** SNMP version 3 username. Defaults to "snmpuser".
1889 snmp_password | **Required.** SNMP version 3 password. No value defined as default.
1890 snmp_v3_use_privpass | **Optional.** Define to use SNMP version 3 priv password. Defaults to false.
1891 snmp_authprotocol | **Optional.** SNMP version 3 authentication protocol. Defaults to "md5,des".
1892 snmp_privpass | **Required.** SNMP version 3 priv password. No value defined as default..
1893 snmp_warn | **Optional.** The warning threshold.
1894 snmp_crit | **Optional.** The critical threshold.
1895 snmp_process_name | **Optional.** Name of the process (regexp). No trailing slash!. Defaults to ".*".
1896 snmp_perf | **Optional.** Enable perfdata values. Defaults to true.
1897 snmp_timeout | **Optional.** The command timeout in seconds. Defaults to 5 seconds.
1898 snmp_process_use_params | **Optional.** Add process parameters to process name for regexp matching. Example: "named.*-t /var/named/chroot" will only select named process with this parameter. Defaults to false.
1902 ## <a id="plugin-contrib"></a> Contributed Plugin Check Commands
1904 The contributed Plugin Check Commands provides various additional command definitions
1905 contributed by community members.
1907 These check commands assume that the global constant named `PluginContribDir`
1908 is set to the path where the user installs custom plugins and can be enabled by
1909 uncommenting the corresponding line in [icinga2.conf](4-configuring-icinga-2.md#icinga2-conf):
1911 include <plugin-contrib>
1913 ### <a id="plugin-contrib-databases"></a> Databases
1915 All database plugins go in this category.
1917 #### <a id="plugin-contrib-command-db2_health"></a> db2_health
1919 The plugin `db2_health` utilises Perl DBD::DB2.
1920 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_db2_health/). For development check [https://github.com](https://github.com/lausser/check_db2_health).
1922 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
1925 ---------------------------------|------------------------------------------------------------------------------------------------------------------------------
1926 db2_health_database | **Required.** The name of the database. (If it was catalogued locally, this parameter is the only you need. Otherwise you must specify database, hostname and port)
1927 db2_health_username | **Optional.** The username for the database connection.
1928 db2_health_password | **Optional.** The password for the database connection.
1929 db2_health_port | **Optional.** The port where DB2 is listening.
1930 db2_health_warning | **Optional.** The warning threshold depending on the mode.
1931 db2_health_critical | **Optional.** The critical threshold depending on the mode.
1932 db2_health_mode | **Required.** The mode uses predefined keywords for the different checks. For example "connection-time", "database-usage" or "sql".
1933 db2_health_method | **Optional.** This tells the plugin how to connect to the database. The only method implemented yet is “dbi” which is the default. (It means, the plugin uses the perl module DBD::DB2).
1934 db2_health_name | **Optional.** The tablespace, datafile, wait event, latch, enqueue depending on the mode or SQL statement to be executed with "db2_health_mode" sql.
1935 db2_health_name2 | **Optional.** If "db2_health_name" is a sql statement, "db2_health_name2" can be used to appear in the output and the performance data.
1936 db2_health_regexp | **Optional.** If set to true, "db2_health_name" will be interpreted as a regular expression. Defaults to false.
1937 db2_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".
1938 db2_health_maxinactivity | **Optional.** Used for the maximum amount of time a certain event has not happened.
1939 db2_health_mitigation | **Optional.** Classifies the severity of an offline tablespace.
1940 db2_health_lookback | **Optional.** How many days in the past db2_health check should look back to calculate exitcode.
1941 db2_health_env_db2_home | **Required.** Specifies the location of the db2 client libraries as environment variable `DB2_HOME`. Defaults to "/opt/ibm/db2/V10.5".
1942 db2_health_env_db2_version | **Optional.** Specifies the DB2 version as environment variable `DB2_VERSION`.
1944 #### <a id="plugin-contrib-command-mssql_health"></a> mssql_health
1946 The plugin `mssql_health` utilises Perl DBD::Sybase based on FreeTDS to connect to MSSQL databases for monitoring.
1947 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).
1949 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
1952 ---------------------------------|------------------------------------------------------------------------------------------------------------------------------
1953 mssql_health_hostname | **Optional.** Specifies the database hostname or address. No default because you typically use "mssql_health_server".
1954 mssql_health_port | **Optional.** Specifies the database port. No default because you typically use "mssql_health_server".
1955 mssql_health_server | **Optional.** The name of a predefined connection (in freetds.conf).
1956 mssql_health_currentdb | **Optional.** The name of a database which is used as the current database for the connection.
1957 mssql_health_username | **Optional.** The username for the database connection.
1958 mssql_health_password | **Optional.** The password for the database connection.
1959 mssql_health_warning | **Optional.** The warning threshold depending on the mode.
1960 mssql_health_critical | **Optional.** The critical threshold depending on the mode.
1961 mssql_health_mode | **Required.** The mode uses predefined keywords for the different checks. For example "connection-time", "database-free" or "sql".
1962 mssql_health_method | **Optional.** How the plugin should connect to the database (dbi for the perl module `DBD::Sybase` (default) and `sqlrelay` for the SQLRelay proxy).
1963 mssql_health_name | **Optional.** Depending on the mode this could be the database name or a SQL statement.
1964 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.
1965 mssql_health_regexp | **Optional.** If set to true, "mssql_health_name" will be interpreted as a regular expression. Defaults to false.
1966 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".
1967 mssql_health_offlineok | **Optional.** Set this to true if offline databases are perfectly ok for you. Defaults to false.
1968 mssql_health_commit | **Optional.** Set this to true to turn on autocommit for the dbd::sybase module. Defaults to false.
1970 #### <a id="plugin-contrib-command-mysql_health"></a> mysql_health
1972 The plugin `mysql_health` utilises Perl DBD::MySQL to connect to MySQL databases for monitoring.
1973 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).
1975 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
1978 ---------------------------------|------------------------------------------------------------------------------------------------------------------------------
1979 mysql_health_hostname | **Required.** Specifies the database hostname or address. Defaults to "$address$" or "$address6$" if the `address` attribute is not set.
1980 mysql_health_port | **Optional.** Specifies the database port. Defaults to 3306 (or 1186 for "mysql_health_mode" cluster).
1981 mysql_health_socket | **Optional.** Specifies the database unix socket. No default.
1982 mysql_health_username | **Optional.** The username for the database connection.
1983 mysql_health_password | **Optional.** The password for the database connection.
1984 mysql_health_database | **Optional.** The database to connect to. Defaults to information_schema.
1985 mysql_health_warning | **Optional.** The warning threshold depending on the mode.
1986 mysql_health_critical | **Optional.** The critical threshold depending on the mode.
1987 mysql_health_warningx | **Optional.** The extended warning thresholds depending on the mode.
1988 mysql_health_criticalx | **Optional.** The extended critical thresholds depending on the mode.
1989 mysql_health_mode | **Required.** The mode uses predefined keywords for the different checks. For example "connection-time", "slave-lag" or "sql".
1990 mysql_health_method | **Optional.** How the plugin should connect to the database (`dbi` for using DBD::Mysql (default), `mysql` for using the mysql-Tool).
1991 mysql_health_commit | **Optional.** Turns on autocommit for the dbd::* module.
1992 mysql_health_notemp | **Optional.** Ignore temporary databases/tablespaces.
1993 mysql_health_nooffline | **Optional.** Skip the offline databases.
1994 mysql_health_regexp | **Optional.** Parameter name/name2/name3 will be interpreted as (perl) regular expression.
1995 mysql_health_name | **Optional.** The name of a specific component to check.
1996 mysql_health_name2 | **Optional.** The secondary name of a component.
1997 mysql_health_name3 | **Optional.** The tertiary name of a component.
1998 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".
1999 mysql_health_labelformat | **Optional.** One of those formats pnp4nagios or groundwork. Defaults to pnp4nagios.
2000 mysql_health_extraopts | **Optional.** Read command line arguments from an external file.
2001 mysql_health_blacklist | **Optional.** Blacklist some (missing/failed) components"
2002 mysql_health_mitigation | **Optional.** "The parameter allows you to change a critical error to a warning."
2003 mysql_health_lookback | **Optional.** The amount of time you want to look back when calculating average rates."
2004 mysql_health_environment | **Optional.** Add a variable to the plugin's environment."
2005 mysql_health_morphmessage | **Optional.** Modify the final output message."
2006 mysql_health_morphperfdata | **Optional.** The parameter allows you to change performance data labels."
2007 mysql_health_selectedperfdata | **Optional.** The parameter allows you to limit the list of performance data."
2008 mysql_health_report | **Optional.** Can be used to shorten the output."
2009 mysql_health_multiline | **Optional.** Multiline output."
2010 mysql_health_negate | **Optional.** Emulate the negate plugin. --negate warning=critical --negate unknown=critical."
2011 mysql_health_withmymodulesdyndir | **Optional.** Add-on modules for the my-modes will be searched in this directory."
2012 mysql_health_statefilesdir | **Optional.** An alternate directory where the plugin can save files."
2013 mysql_health_isvalidtime | **Optional.** Signals the plugin to return OK if now is not a valid check time."
2015 #### <a id="plugin-contrib-command-oracle_health"></a> oracle_health
2017 The plugin `oracle_health` utilises Perl DBD::Oracle based on oracle-instantclient-sdk or sqlplus to connect to Oracle databases for monitoring.
2018 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).
2020 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
2023 ---------------------------------|------------------------------------------------------------------------------------------------------------------------------
2024 oracle_health_connect | **Required.** Specifies the database connection string (from tnsnames.ora).
2025 oracle_health_username | **Optional.** The username for the database connection.
2026 oracle_health_password | **Optional.** The password for the database connection.
2027 oracle_health_warning | **Optional.** The warning threshold depending on the mode.
2028 oracle_health_critical | **Optional.** The critical threshold depending on the mode.
2029 oracle_health_mode | **Required.** The mode uses predefined keywords for the different checks. For example "connection-time", "flash-recovery-area-usage" or "sql".
2030 oracle_health_method | **Optional.** How the plugin should connect to the database (`dbi` for using DBD::Oracle (default), `sqlplus` for using the sqlplus-Tool).
2031 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.
2032 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.
2033 oracle_health_regexp | **Optional.** If set to true, "oracle_health_name" will be interpreted as a regular expression. Defaults to false.
2034 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".
2035 oracle_health_ident | **Optional.** If set to true, outputs instance and database names. Defaults to false.
2036 oracle_health_commit | **Optional.** Set this to true to turn on autocommit for the dbd::oracle module. Defaults to false.
2037 oracle_health_noperfdata | **Optional.** Set this to true if you want to disable perfdata. Defaults to false.
2042 --------------------|------------------------------------------------------------------------------------------------------------------------------------------
2043 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".
2044 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".
2046 #### <a id="plugin-contrib-command-postgres"></a> postgres
2048 The plugin `postgres` utilises the psql binary to connect to PostgreSQL databases for monitoring.
2049 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).
2051 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
2054 ---------------------------------|------------------------------------------------------------------------------------------------------------------------------
2055 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.
2056 postgres_port | **Optional.** Specifies the database port. Defaults to 5432.
2057 postgres_dbname | **Optional.** Specifies the database name to connect to. Defaults to "postgres" or "template1".
2058 postgres_dbuser | **Optional.** The username for the database connection. Defaults to "postgres".
2059 postgres_dbpass | **Optional.** The password for the database connection. You can use a .pgpass file instead.
2060 postgres_dbservice | **Optional.** Specifies the service name to use inside of pg_service.conf.
2061 postgres_warning | **Optional.** Specifies the warning threshold, range depends on the action.
2062 postgres_critical | **Optional.** Specifies the critical threshold, range depends on the action.
2063 postgres_include | **Optional.** Specifies name(s) items to specifically include (e.g. tables), depends on the action.
2064 postgres_exclude | **Optional.** Specifies name(s) items to specifically exclude (e.g. tables), depends on the action.
2065 postgres_includeuser | **Optional.** Include objects owned by certain users.
2066 postgres_excludeuser | **Optional.** Exclude objects owned by certain users.
2067 postgres_standby | **Optional.** Assume that the server is in continious WAL recovery mode if set to true. Defaults to false.
2068 postgres_production | **Optional.** Assume that the server is in production mode if set to true. Defaults to false.
2069 postgres_action | **Required.** Determines the test executed.
2070 postgres_unixsocket | **Optional.** If "postgres_unixsocket" is set to true, the unix socket is used instead of an address. Defaults to false.
2071 postgres_query | **Optional.** Query for "custom_query" action.
2072 postgres_valtype | **Optional.** Value type of query result for "custom_query".
2073 postgres_reverse | **Optional.** If "postgres_reverse" is set, warning and critical values are reversed for "custom_query" action.
2075 #### <a id="plugin-contrib-command-mongodb"></a> mongodb
2077 The plugin `mongodb` utilises Python PyMongo.
2078 For development check [https://github.com](https://github.com/mzupan/nagios-plugin-mongodb).
2080 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
2083 ---------------------------------|------------------------------------------------------------------------------------------------------------------------------
2084 mongodb_host | **Required.** Specifies the hostname or address.
2085 mongodb_port | **Required.** The port mongodb is runnung on.
2086 mongodb_user | **Optional.** The username you want to login as
2087 mongodb_passwd | **Optional.** The password you want to use for that user
2088 mongodb_warning | **Optional.** The warning threshold we want to set
2089 mongodb_critical | **Optional.** The critical threshold we want to set
2090 mongodb_action | **Required.** The action you want to take
2091 mongodb_maxlag | **Optional.** Get max replication lag (for replication_lag action only)
2092 mongodb_mappedmemory | **Optional.** Get mapped memory instead of resident (if resident memory can not be read)
2093 mongodb_perfdata | **Optional.** Enable output of Nagios performance data
2094 mongodb_database | **Optional.** Specify the database to check
2095 mongodb_alldatabases | **Optional.** Check all databases (action database_size)
2096 mongodb_ssl | **Optional.** Connect using SSL
2097 mongodb_replicaset | **Optional.** Connect to replicaset
2098 mongodb_replcheck | **Optional.** If set to true, will enable the mongodb_replicaset value needed for "replica_primary" check
2099 mongodb_querytype | **Optional.** The query type to check [query\|insert\|update\|delete\|getmore\|command] from queries_per_second
2100 mongodb_collection | **Optional.** Specify the collection to check
2101 mongodb_sampletime | **Optional.** Time used to sample number of pages faults
2103 #### <a id="plugin-contrib-command-elasticsearch"></a> elasticsearch
2105 An [ElasticSearch](https://www.elastic.co/products/elasticsearch) availability
2106 and performance monitoring plugin available for download at [GitHub](https://github.com/anchor/nagios-plugin-elasticsearch).
2107 The plugin requires the HTTP API enabled on your ElasticSearch node.
2110 -----------------------------|-------------------------------------------------------------------------------------------------------
2111 elasticsearch_failuredomain | **Optional.** A comma-separated list of ElasticSearch attributes that make up your cluster's failure domain.
2112 elasticsearch_host | **Optional.** Hostname or network address to probe. Defaults to 'localhost'.
2113 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.
2114 elasticsearch_port | **Optional.** TCP port to probe. The ElasticSearch API should be listening here. Defaults to 9200.
2115 elasticsearch_prefix | **Optional.** Optional prefix (e.g. 'es') for the ElasticSearch API. Defaults to ''.
2116 elasticsearch_yellowcritical | **Optional.** Instead of issuing a 'warning' for a yellow cluster state, issue a 'critical' alert. Defaults to false.
2118 #### <a id="plugin-contrib-command-redis"></a> redis
2120 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).
2121 It is provided by `William Leibzon` at [https://github.com](https://github.com/willixix/naglio-plugins/blob/master/check_redis.pl).
2124 -------------------------|--------------------------------------------------------------------------------------------------------------
2125 redis_hostname | **Required.** Hostname or IP Address to check. Defaults to "127.0.0.1".
2126 redis_port | **Optional.** Port number to query. Default to "6379".
2127 redis_database | **Optional.** Database name (usually a number) to query, needed for **redis_query**.
2128 redis_password | **Optional.** Password for Redis authentication. Safer alternative is to put them in a file and use **redis_credentials**.
2129 redis_credentials | **Optional.** Credentials file to read for Redis authentication.
2130 redis_timeout | **Optional.** Allows to set timeout for execution of this plugin.
2131 redis_variables | **Optional.** List of variables from info data to do threshold checks on.
2132 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.
2133 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.
2134 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.
2135 redis_perfvars | **Optional.** This allows to list variables which values will go only into perfparse output (and not for threshold checking).
2136 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.
2137 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".
2138 redis_query | **Optional.** Option specifies key to query and optional variable name to assign the results to after.
2139 redis_option | **Optional.** Specifiers are separated by "," and must include NAME or PATTERN.
2140 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.
2141 redis_hitrate | **Optional.** Calculates Hitrate and specify values are interpreted as WARNING and CRITICAL thresholds.
2142 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.
2143 redis_total_memory | **Optional.** Amount of memory on a system for memory utilization calculation. Use system memory or max_memory setting of redis.
2144 redis_replication_delay | **Optional.** Allows to set threshold on replication delay info.
2147 ### <a id="plugin-contrib-hardware"></a> Hardware
2149 This category includes all plugins for various hardware checks.
2151 #### <a id="plugin-contrib-command-hpasm"></a> hpasm
2153 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.
2155 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
2158 --------------------------------|-----------------------------------------------------------------------
2159 hpasm_hostname | **Optional.** The host's address. Defaults to "$address$" if the host's `address` attribute is set, "$address6$" otherwise.
2160 hpasm_community | **Optional.** SNMP community of the server (SNMP v1/2 only).
2161 hpasm_protocol | **Optional.** The SNMP protocol to use (default: 2c, other possibilities: 1,3).
2162 hpasm_port | **Optional.** The SNMP port to use (default: 161).
2163 hpasm_blacklist | **Optional.** Blacklist some (missing/failed) components.
2164 hpasm_ignore-dimms | **Optional.** Ignore "N/A"-DIMM status on misc. servers (e.g. older DL320).
2165 hpasm_ignore-fan-redundancy | **Optional.** Ignore missing redundancy partners.
2166 hpasm_customthresholds | **Optional.** Use custom thresholds for certain temperatures.
2167 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.
2168 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.
2169 hpasm_username | **Optional.** The securityName for the USM security model (SNMPv3 only).
2170 hpasm_authpassword | **Optional.** The authentication password for SNMPv3.
2171 hpasm_authprotocol | **Optional.** The authentication protocol for SNMPv3 (md5\|sha).
2172 hpasm_privpassword | **Optional.** The password for authPriv security level.
2173 hpasm_privprotocol | **Optional.** The private protocol for SNMPv3 (des\|aes\|aes128\|3des\|3desde).
2174 hpasm_servertype | **Optional.** The type of the server: proliant (default) or bladesystem.
2175 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 you get an error and 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.
2178 ### <a id="plugin-contrib-icingacli"></a> IcingaCLI
2180 This category includes all plugins using the icingacli provided by Icinga Web 2.
2182 #### <a id="plugin-contrib-icingacli-businessprocess"></a> Business Process
2184 This subcommand is provided by the [business process module](https://exchange.icinga.org/icinga/Business+Process) and executed as `icingacli-businessprocess`. The module is hosted by the Icinga project on its [project homepage](https://dev.icinga.org/projects/icingaweb2-module-businessprocess).
2186 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
2189 ------------------------------------------|-----------------------------------------------------------------------------------------
2190 icingacli_businessprocess_process | **Required.** Business process to monitor.
2191 icingacli_businessprocess_config | **Optional.** Configuration file containing your business process without file extension.
2192 icingacli_businessprocess_details | **Optional.** Get details for root cause analyses. Defaults to false.
2195 ### <a id="plugin-contrib-ipmi"></a> IPMI Devices
2197 This category includes all plugins for IPMI devices.
2199 #### <a id="plugin-contrib-command-ipmi-sensor"></a> ipmi-sensor
2201 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.
2203 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
2206 ---------------------------------|-----------------------------------------------------------------------------------------------------
2207 ipmi_address | **Required.** Specifies the remote host (IPMI device) to check. Defaults to "$address$".
2208 ipmi_config_file | **Optional.** Path to the FreeIPMI configuration file. It should contain IPMI username, IPMI password, and IPMI privilege-level.
2209 ipmi_username | **Optional.** The IPMI username.
2210 ipmi_password | **Optional.** The IPMI password.
2211 ipmi_privilege_level | **Optional.** The IPMI privilege level of the IPMI user.
2212 ipmi_backward_compatibility_mode | **Optional.** Enable backward compatibility mode, useful for FreeIPMI 0.5.* (this omits FreeIPMI options "--quiet-cache" and "--sdr-cache-recreate").
2213 ipmi_sensor_type | **Optional.** Limit sensors to query based on IPMI sensor type. Examples for IPMI sensor types are 'Fan', 'Temperature' and 'Voltage'.
2214 ipmi_exclude_sensor_id | **Optional.** Exclude sensor matching ipmi_sensor_id.
2215 ipmi_sensor_id | **Optional.** Include sensor matching ipmi_sensor_id.
2216 ipmi_protocal_lan_version | **Optional.** Change the protocol LAN version. Defaults to "LAN_2_0".
2217 ipmi_number_of_active_fans | **Optional.** Number of fans that should be active. Otherwise a WARNING state is returned.
2218 ipmi_show_fru | **Optional.** Print the product serial number if it is available in the IPMI FRU data.
2219 ipmi_no_sel_checking | **Optional.** Turn off system event log checking via ipmi-sel.
2221 ### <a id="plugin-contrib-metrics"></a> Metrics
2223 This category includes all plugins for metric-based checks.
2225 #### <a id="plugin-contrib-command-graphite"></a> graphite
2227 Check command object for the [check_graphite](https://github.com/obfuscurity/nagios-scripts) plugin.
2229 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
2232 ------------------------------------|-----------------------------------------------------------------------------------------------------
2233 graphite_url | **Required.** Target url.
2234 graphite_metric | **Required.** Metric path string.
2235 graphite_shortname | **Optional.** Metric short name (used for performance data).
2236 graphite_duration | **Optional.** Length, in minute of data to parse (default: 5).
2237 graphite_function | **Optional.** Function applied to metrics for thresholds (default: average).
2238 graphite_warning | **Required.** Warning threshold.
2239 graphite_critical | **Required.** Critical threshold.
2240 graphite_units | **Optional.** Adds a text tag to the metric count in the plugin output. Useful to identify the metric units. Doesn't affect data queries.
2241 graphite_message | **Optional.** Text message to output (default: "metric count:").
2242 graphite_zero_on_error | **Optional.** Return 0 on a graphite 500 error.
2243 graphite_link_graph | **Optional.** Add a link in the plugin output, showing a 24h graph for this metric in graphite.
2245 ### <a id="plugin-contrib-network-components"></a> Network Components
2247 This category includes all plugins for various network components like routers, switches and firewalls.
2249 #### <a id="plugin-contrib-command-interfacetable"></a> interfacetable
2251 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).
2253 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
2256 ------------------------------------|-----------------------------------------------------------------------------------------------------
2257 interfacetable_hostquery | **Required.** Specifies the remote host to poll. Defaults to "$address$".
2258 interfacetable_hostdisplay | **Optional.** Specifies the hostname to display in the HTML link. Defaults to "$host.display_name$".
2259 interfacetable_regex | **Optional.** Interface names and property names for some other options will be interpreted as regular expressions. Defaults to false.
2260 interfacetable_outputshort | **Optional.** Reduce the verbosity of the plugin output. Defaults to false.
2261 interfacetable_exclude | **Optional.** Comma separated list of interfaces globally excluded from the monitoring.
2262 interfacetable_include | **Optional.** Comma separated list of interfaces globally included in the monitoring.
2263 interfacetable_aliasmatching | **Optional.** Allow you to specify alias in addition to interface names. Defaults to false.
2264 interfacetable_excludetraffic | **Optional.** Comma separated list of interfaces excluded from traffic checks.
2265 interfacetable_includetraffic | **Optional.** Comma separated list of interfaces included for traffic checks.
2266 interfacetable_warningtraffic | **Optional.** Interface traffic load percentage leading to a warning alert.
2267 interfacetable_criticaltraffic | **Optional.** Interface traffic load percentage leading to a critical alert.
2268 interfacetable_pkt | **Optional.** Add unicast/non-unicast pkt stats for each interface.
2269 interfacetable_trafficwithpkt | **Optional.** Enable traffic calculation using pkt counters instead of octet counters. Useful when using 32-bit counters to track the load on > 1GbE interfaces. Defaults to false.
2270 interfacetable_trackproperty | **Optional.** List of tracked properties.
2271 interfacetable_excludeproperty | **Optional.** Comma separated list of interfaces excluded from the property tracking.
2272 interfacetable_includeproperty | **Optional.** Comma separated list of interfaces included in the property tracking.
2273 interfacetable_community | **Optional.** Specifies the snmp v1/v2c community string. Defaults to "public" if using snmp v1/v2c, ignored using v3.
2274 interfacetable_snmpv2 | **Optional.** Use snmp v2c. Defaults to false.
2275 interfacetable_login | **Optional.** Login for snmpv3 authentication.
2276 interfacetable_passwd | **Optional.** Auth password for snmpv3 authentication.
2277 interfacetable_privpass | **Optional.** Priv password for snmpv3 authentication.
2278 interfacetable_protocols | **Optional.** Authentication protocol,Priv protocol for snmpv3 authentication.
2279 interfacetable_domain | **Optional.** SNMP transport domain.
2280 interfacetable_contextname | **Optional.** Context name for the snmp requests.
2281 interfacetable_port | **Optional.** SNMP port. Defaults to standard port.
2282 interfacetable_64bits | **Optional.** Use SNMP 64-bits counters. Defaults to false.
2283 interfacetable_maxrepetitions | **Optional.** Increasing this value may enhance snmp query performances by gathering more results at one time.
2284 interfacetable_snmptimeout | **Optional.** Define the Transport Layer timeout for the snmp queries.
2285 interfacetable_snmpretries | **Optional.** Define the number of times to retry sending a SNMP message.
2286 interfacetable_snmpmaxmsgsize | **Optional.** Size of the SNMP message in octets, usefull in case of too long responses. Be carefull with network filters. Range 484 - 65535. Apply only to netsnmp perl bindings. The default is 1472 octets for UDP/IPv4, 1452 octets for UDP/IPv6, 1460 octets for TCP/IPv4, and 1440 octets for TCP/IPv6.
2287 interfacetable_unixsnmp | **Optional.** Use unix snmp utilities for snmp requests. Defaults to false, which means use the perl bindings.
2288 interfacetable_enableperfdata | **Optional.** Enable port performance data. Defaults to false.
2289 interfacetable_perfdataformat | **Optional.** Define which performance data will be generated. Possible values are "full" (default), "loadonly", "globalonly".
2290 interfacetable_perfdatathreshold | **Optional.** Define which thresholds are printed in the generated performance data. Possible values are "full" (default), "loadonly", "globalonly".
2291 interfacetable_perfdatadir | **Optional.** When specified, the performance data are also written directly to a file, in the specified location.
2292 interfacetable_perfdataservicedesc | **Optional.** Specify additional parameters for output performance data to PNP. Defaults to "$service.name$", only affects **interfacetable_perfdatadir**.
2293 interfacetable_grapher | **Optional.** Specify the used graphing solution. Possible values are "pnp4nagios" (default), "nagiosgrapher", "netwaysgrapherv2" and "ingraph".
2294 interfacetable_grapherurl | **Optional.** Graphing system url. Default depends on **interfacetable_grapher**.
2295 interfacetable_portperfunit | **Optional.** Traffic could be reported in bits (counters) or in bps (calculated value).
2296 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".
2297 interfacetable_duplex | **Optional.** Add the duplex mode property for each interface in the interface table. Defaults to false.
2298 interfacetable_stp | **Optional.** Add the stp state property for each interface in the interface table. Defaults to false.
2299 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"
2300 interfacetable_noipinfo | **Optional.** Remove the ip information for each interface from the interface table. Defaults to false.
2301 interfacetable_alias | **Optional.** Add the alias information for each interface in the interface table. Defaults to false.
2302 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.
2303 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.
2304 interfacetable_delta | **Optional.** Set the delta used for interface throuput calculation in seconds.
2305 interfacetable_ifs | **Optional.** Input field separator. Defaults to ",".
2306 interfacetable_cache | **Optional.** Define the retention time of the cached data in seconds.
2307 interfacetable_noifloadgradient | **Optional.** Disable color gradient from green over yellow to red for the load percentage. Defaults to false.
2308 interfacetable_nohuman | **Optional.** Do not translate bandwidth usage in human readable format. Defaults to false.
2309 interfacetable_snapshot | **Optional.** Force the plugin to run like if it was the first launch. Defaults to false.
2310 interfacetable_timeout | **Optional.** Define the global timeout limit of the plugin in seconds. Defaults to "15s".
2311 interfacetable_css | **Optional.** Define the css stylesheet used by the generated html files. Possible values are "classic", "icinga", "icinga-alternate1" or "nagiosxi".
2312 interfacetable_config | **Optional.** Specify a config file to load.
2313 interfacetable_noconfigtable | **Optional.** Disable configuration table on the generated HTML page. Defaults to false.
2314 interfacetable_notips | **Optional.** Disable the tips in the generated html tables. Defaults to false.
2315 interfacetable_defaulttablesorting | **Optional.** Default table sorting can be "index" (default) or "name".
2316 interfacetable_tablesplit | **Optional.** Generate multiple interface tables, one per interface type. Defaults to false.
2317 interfacetable_notype | **Optional.** Remove the interface type for each interface. Defaults to false.
2319 #### <a id="plugin-contrib-command-iftraffic"></a> iftraffic
2321 The plugin [check_iftraffic](https://exchange.icinga.org/exchange/iftraffic)
2322 checks the utilization of a given interface name using the SNMP protocol.
2324 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
2327 ------------------------|---------------------------------------------------------
2328 iftraffic_address | **Required.** Specifies the remote host. Defaults to "$address$".
2329 iftraffic_community | **Optional.** SNMP community. Defaults to "public'" if omitted.
2330 iftraffic_interface | **Required.** Queried interface name.
2331 iftraffic_bandwidth | **Required.** Interface maximum speed in kilo/mega/giga/bits per second.
2332 iftraffic_units | **Optional.** Interface units can be one of these values: `g` (gigabits/s),`m` (megabits/s), `k` (kilobits/s),`b` (bits/s)
2333 iftraffic_warn | **Optional.** Percent of bandwidth usage necessary to result in warning status (defaults to `85`).
2334 iftraffic_crit | **Optional.** Percent of bandwidth usage necessary to result in critical status (defaults to `98`).
2335 iftraffic_max_counter | **Optional.** Maximum counter value of net devices in kilo/mega/giga/bytes.
2337 #### <a id="plugin-contrib-command-iftraffic64"></a> iftraffic64
2339 The plugin [check_iftraffic64](https://exchange.icinga.org/exchange/iftraffic64)
2340 checks the utilization of a given interface name using the SNMP protocol.
2342 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
2345 ------------------------|---------------------------------------------------------
2346 iftraffic64_address | **Required.** Specifies the remote host. Defaults to "$address$".
2347 iftraffic64_community | **Optional.** SNMP community. Defaults to "public'" if omitted.
2348 iftraffic64_interface | **Required.** Queried interface name.
2349 iftraffic64_bandwidth | **Required.** Interface maximum speed in kilo/mega/giga/bits per second.
2350 iftraffic64_units | **Optional.** Interface units can be one of these values: `g` (gigabits/s),`m` (megabits/s), `k` (kilobits/s),`b` (bits/s)
2351 iftraffic64_warn | **Optional.** Percent of bandwidth usage necessary to result in warning status (defaults to `85`).
2352 iftraffic64_crit | **Optional.** Percent of bandwidth usage necessary to result in critical status (defaults to `98`).
2353 iftraffic64_max_counter | **Optional.** Maximum counter value of net devices in kilo/mega/giga/bytes.
2355 #### <a id="plugin-contrib-command-interfaces"></a> interfaces
2357 The plugin [check_interfaces](https://www.netways.org/projects/check-interfaces)
2358 Check interfaces and utilization.
2360 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
2363 --------------------------|---------------------------------------------------------
2364 interfaces_address | **Optional.** The host's address. Defaults to "$address$" if the host's `address` attribute is set, "$address6$" otherwise.
2365 interfaces_regex | **Optional.** Interface list regexp.
2366 interfaces_exclude_regex | **Optional.** Interface list negative regexp.
2367 interfaces_errors | **Optional.** Number of in errors (CRC errors for cisco) to consider a warning (default 50).
2368 interface_out_errors | **Optional.** Number of out errors (collisions for cisco) to consider a warning (default same as in errors).
2369 interfaces_perfdata | **Optional.** perfdata from last check result.
2370 interfaces_prefix | **Optional.** Prefix interface names with this label.
2371 interfaces_lastcheck | **Optional.** Last checktime (unixtime).
2372 interfaces_bandwidth | **Optional.** Bandwidth warn level in percent.
2373 interfaces_speed | **Optional.** Override speed detection with this value (bits per sec).
2374 interfaces_trim | **Optional.** Cut this number of characters from the start of interface descriptions.
2375 interfaces_mode | **Optional.** Special operating mode (default,cisco,nonbulk,bintec).
2376 interfaces_auth_proto | **Optional.** SNMPv3 Auth Protocol (SHA\|MD5)
2377 interfaces_auth_phrase | **Optional.** SNMPv3 Auth Phrase
2378 interfaces_priv_proto | **Optional.** SNMPv3 Privacy Protocol (AES\|DES)
2379 interfaces_priv_phrase | **Optional.** SNMPv3 Privacy Phrase
2380 interfaces_user | **Optional.** SNMPv3 User
2381 interfaces_down_is_ok | **Optional.** Disables critical alerts for down interfaces.
2382 interfaces_aliases | **Optional.** Retrieves the interface description.
2383 interfaces_match_aliases | **Optional.** Also match against aliases (Option --aliases automatically enabled).
2384 interfaces_timeout | **Optional.** Sets the SNMP timeout (in ms).
2385 interfaces_sleep | **Optional.** Sleep between every SNMP query (in ms).
2387 #### <a id="plugin-contrib-command-nwc_health"></a> nwc_health
2389 The plugin [check_nwc_health](https://labs.consol.de/de/nagios/check_nwc_health/index.html)
2390 Check switches, router, there interfaces and utilization.
2392 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
2395 --------------------------------|---------------------------------------------------------
2396 nwc_health_hostname | **Optional.** The host's address. Defaults to "$address$" if the host's `address` attribute is set, "$address6$" otherwise.
2397 nwc_health_mode | **Optional.** The plugin mode. A list of all available modes can be found in the [plugin documentation](https://labs.consol.de/nagios/check_nwc_health/index.html).
2398 nwc_health_timeout | **Optional.** Seconds before plugin times out (default: 15)
2399 nwc_health_blacklist | **Optional.** Blacklist some (missing/failed) components.
2400 nwc_health_port | **Optional.** The SNMP port to use (default: 161).
2401 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).
2402 nwc_health_protocol | **Optional.** The SNMP protocol to use (default: 2c, other possibilities: 1,3).
2403 nwc_health_community | **Optional.** SNMP community of the server (SNMP v1/2 only).
2404 nwc_health_username | **Optional.** The securityName for the USM security model (SNMPv3 only).
2405 nwc_health_authpassword | **Optional.** The authentication password for SNMPv3.
2406 nwc_health_authprotocol | **Optional.** The authentication protocol for SNMPv3 (md5\|sha).
2407 nwc_health_privpassword | **Optional.** The password for authPriv security level.
2408 nwc_health_privprotocol | **Optional.** The private protocol for SNMPv3 (des\|aes\|aes128\|3des\|3desde).
2409 nwc_health_contextengineid | **Optional.** The context engine id for SNMPv3 (10 to 64 hex characters).
2410 nwc_health_contextname | **Optional.** The context name for SNMPv3 (empty represents the default context).
2411 nwc_health_name | **Optional.** The name of an interface (ifDescr).
2412 nwc_health_drecksptkdb | **Optional.** This parameter must be used instead of --name, because Devel::ptkdb is stealing the latter from the command line.
2413 nwc_health_alias | **Optional.** The alias name of a 64bit-interface (ifAlias)
2414 nwc_health_regexp | **Optional.** A flag indicating that --name is a regular expression
2415 nwc_health_ifspeedin | **Optional.** Override the ifspeed oid of an interface (only inbound)
2416 nwc_health_ifspeedout | **Optional.** Override the ifspeed oid of an interface (only outbound)
2417 nwc_health_ifspeed | **Optional.** Override the ifspeed oid of an interface
2418 nwc_health_units | **Optional.** One of %, B, KB, MB, GB, Bit, KBi, MBi, GBi. (used for e.g. mode interface-usage)
2419 nwc_health_name2 | **Optional.** The secondary name of a component.
2420 nwc_health_role | **Optional.** The role of this device in a hsrp group (active/standby/listen).
2421 nwc_health_report | **Optional.** Can be used to shorten the output.
2422 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.
2423 nwc_health_warning | **Optional.** The warning threshold
2424 nwc_health_critical | **Optional.** The critical threshold
2425 nwc_health_warningx | **Optional.** The extended warning thresholds
2426 nwc_health_criticalx | **Optional.** The extended critical thresholds
2427 nwc_health_mitigation | **Optional.** The parameter allows you to change a critical error to a warning.
2428 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.
2429 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'
2430 nwc_health_negate | **Optional.** The parameter allows you to map exit levels, such as warning=critical.
2431 nwc_health_mymodules-dyn-dir | **Optional.** A directory where own extensions can be found.
2432 nwc_health_servertype | **Optional.** The type of the network device: cisco (default). Use it if auto-detection is not possible.
2433 nwc_health_statefilesdir | **Optional.** An alternate directory where the plugin can save files.
2434 nwc_health_oids | **Optional.** A list of oids which are downloaded and written to a cache file. Use it together with --mode oidcache.
2435 nwc_health_offline | **Optional.** The maximum number of seconds since the last update of cache file before it is considered too old.
2436 nwc_health_multiline | **Optional.** Multiline output
2439 ### <a id="plugin-contrib-web"></a> Web
2441 This category includes all plugins for web-based checks.
2443 #### <a id="plugin-contrib-command-webinject"></a> webinject
2445 Check command object for the [check_webinject](http://www.webinject.org/manual.html) plugin.
2447 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
2450 ------------------------|--------------
2451 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.
2452 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.
2453 webinject_no_output | **Optional.** Suppresses all output to STDOUT except the results summary.
2454 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.
2455 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.
2456 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.
2458 #### <a id="plugin-contrib-command-jmx4perl"></a> jmx4perl
2460 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.
2462 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
2465 -----------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------
2466 jmx4perl_url | **Required.** URL to agent web application. Defaults to "http://$address$:8080/jolokia".
2467 jmx4perl_product | **Optional.** Name of app server product (e.g. jboss), by default is uses an autodetection facility.
2468 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.
2469 jmx4perl_mbean | **Optional.** MBean name (e.g. java.lang:type=Memory).
2470 jmx4perl_attribute | **Optional.** Attribute name (e.g. HeapMemoryUsage).
2471 jmx4perl_operation | **Optional.** Operation to execute.
2472 jmx4perl_value | **Optional.** Shortcut for specifying mbean/attribute/path. Slashes within names must be escaped with backslash.
2473 jmx4perl_delta | **Optional.** Switches on incremental mode. Optional argument are seconds used for normalizing.
2474 jmx4perl_path | **Optional.** Inner path for extracting a single value from a complex attribute or return value (e.g. used).
2475 jmx4perl_target | **Optional.** JSR-160 Service URL specifing the target server.
2476 jmx4perl_target_user | **Optional.** Username to use for JSR-160 connection.
2477 jmx4perl_target_password | **Optional.** Password to use for JSR-160 connection.
2478 jmx4perl_proxy | **Optional.** Proxy to use.
2479 jmx4perl_user | **Optional.** User for HTTP authentication.
2480 jmx4perl_password | **Optional.** Password for HTTP authentication.
2481 jmx4perl_name | **Optional.** Name to use for output, by default a standard value based on the MBean and attribute will be used.
2482 jmx4perl_method | **Optional.** HTTP method to use, either get or post. By default a method is determined automatically based on the request type.
2483 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.
2484 jmx4perl_base_mbean | **Optional.** Base MBean name, interprets critical and warning values as relative in the range 0 .. 100%. Requires "jmx4perl_base_attribute".
2485 jmx4perl_base_attribute | **Optional.** Base attribute for a relative check. Requires "jmx4perl_base_mbean".
2486 jmx4perl_base_path | **Optional.** Base path for relative checks, where this path is used on the base attribute's value.
2487 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.
2488 jmx4perl_null | **Optional.** Value which should be used in case of a null return value of an operation or attribute. Defaults to null.
2489 jmx4perl_string | **Optional.** Force string comparison for critical and warning checks. Defaults to false.
2490 jmx4perl_numeric | **Optional.** Force numeric comparison for critical and warning checks. Defaults to false.
2491 jmx4perl_critical | **Optional.** Critical threshold for value.
2492 jmx4perl_warning | **Optional.** Warning threshold for value.
2493 jmx4perl_label | **Optional.** Label to be used for printing out the result of the check. For placeholders which can be used see the documentation.
2494 jmx4perl_perfdata | **Optional.** Whether performance data should be omitted, which are included by default. Defaults to "on" for numeric values, to "off" for strings.
2495 jmx4perl_unknown_is_critical | **Optional.** Map UNKNOWN errors to errors with a CRITICAL status. Defaults to false.
2496 jmx4perl_timeout | **Optional.** Seconds before plugin times out. Defaults to "15".
2497 jmx4perl_config | **Optional.** Path to configuration file.
2498 jmx4perl_server | **Optional.** Symbolic name of server url to use, which needs to be configured in the configuration file.
2499 jmx4perl_check | **Optional.** Name of a check configuration as defined in the configuration file, use array if you need arguments.
2501 #### <a id="plugin-contrib-command-squid"></a> squid
2503 Plugin for monitoring [Squid](https://exchange.icinga.org/exchange/check_squid).
2505 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
2508 ------------------------|----------------------------------------------------------------------------------
2509 squid_hostname | **Optional.** The host's address. Defaults to "$address$" if the host's `address` attribute is set, "$address6$" otherwise.
2510 squid_data | **Optional.** Data to fetch (default: Connections) available data: Connections Cache Resources Memory FileDescriptors.
2511 squid_port | **Optional.** Port number (default: 3128).
2512 squid_user | **Optional.** WWW user
2513 squid_password | **Optional.** WWW password
2514 squid_warning | **Optional.** Warning threshold. See http://nagiosplug.sourceforge.net/developer-guidelines.html#THRESHOLDFORMAT for the threshold format.
2515 squid_critical | **Optional.** Critical threshold. See http://nagiosplug.sourceforge.net/developer-guidelines.html#THRESHOLDFORMAT for the threshold format.
2516 squid_client | **Optional.** Path of squidclient (default: /usr/bin/squidclient).
2517 squid_timeout | **Optional.** Seconds before plugin times out (default: 15).
2520 #### <a id="plugin-contrib-command-nginx_status"></a> nginx_status
2522 Plugin for monitoring [nginx_status](https://github.com/regilero/check_nginx_status).
2524 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
2527 ------------------------|----------------------------------------------------------------------------------
2528 nginx_status_host_address | **Optional.** The host's address. Defaults to "$address$" if the host's `address` attribute is set, `address6` otherwise.
2529 nginx_status_port | **Optional.** the http port.
2530 nginx_status_url | **Optional.** URL to use, instead of the default (http://`nginx_status_hostname`/nginx_status).
2531 nginx_status_servername | **Optional.** ServerName to use if you specified an IP to match the good Virtualhost in your target
2532 nginx_status_ssl | **Optional.** set to use ssl connection
2533 nginx_status_disable_sslverify | **Optional.** set to disable SSL hostname verification
2534 nginx_status_user | **Optional.** Username for basic auth
2535 nginx_status_pass | **Optional.** Password for basic auth
2536 nginx_status_realm | **Optional.** Realm for basic auth
2537 nginx_status_maxreach | **Optional.** Number of max processes reached (since last check) that should trigger an alert
2538 nginx_status_timeout | **Optional.** timeout in seconds
2539 nginx_status_warn | **Optional.** Warning threshold (number of active connections, ReqPerSec or ConnPerSec that will cause a WARNING) like '10000,100,200'.
2540 nginx_status_critical | **Optional.** Critical threshold (number of active connections, ReqPerSec or ConnPerSec that will cause a CRITICAL) like '20000,200,300'.
2543 #### <a id="plugin-contrib-command-apache_status"></a> apache_status
2545 Plugin for monitoring [apache_status](https://github.com/lbetz/check_apache_status).
2547 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
2550 ------------------------|----------------------------------------------------------------------------------
2551 apache_status_address | **Optional.** The host's address. Defaults to "$address$" if the host's `address` attribute is set, `address6` otherwise.
2552 apache_status_port | **Optional.** the http port.
2553 apache_status_url | **Optional.** URL to use, instead of the default (http://`apache_status_address`/server-status).
2554 apache_status_ssl | **Optional.** set to use ssl connection
2555 apache_status_timeout | **Optional.** timeout in seconds
2556 apache_status_warning | **Optional.** Warning threshold (number of open slots, busy workers and idle workers that will cause a WARNING) like ':20,50,:50'.
2557 apache_status_critical | **Optional.** Critical threshold (number of open slots, busy workers and idle workers that will cause a CRITICAL) like ':10,25,:20'.
2560 #### <a id="plugin-contrib-command-kdc"></a> kdc
2562 Plugin for monitoring [kdc](https://exchange.nagios.org/directory/Plugins/Security/check_kdc/details).
2564 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
2567 ----------------|--------------------------------------------------------------------------
2568 kdc_address | **Optional.** The host's address. Defaults to "$address$" if the host's `address` attribute is set, `address6` otherwise.
2569 kdc_port | **Optional** Port on which KDC runs (default 88).
2570 kdc_principal | **Required** Principal name to authenticate as (including realm).
2571 kdc_keytab | **Required** Keytab file containing principal's key.
2574 #### <a id="plugin-contrib-command-rbl"></a> rbl
2576 Plugin for monitoring [rbl](https://github.com/matteocorti/check_rbl)
2578 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
2581 ----------------|--------------------------------------------------------------------------
2582 rbl_hostname | **Optional.** The address or name of the SMTP server to check. Defaults to "$address$" if the host's `address` attribute is set, `address6` otherwise.
2583 rbl_server | **Required** List of RBL servers as an array.
2584 rbl_warning | **Optional** Number of blacklisting servers for a warning.
2585 rbl_critical | **Optional** Number of blacklisting servers for a critical.
2586 tbl_timeout | **Optional** Seconds before plugin times out (default: 15).
2589 ### <a id="plugin-contrib-operating-system"></a> Operating System
2591 In this category you can find plugins for gathering information about your operating system or the system beneath like memory usage.
2593 #### <a id="plugin-contrib-command-mem"></a> mem
2595 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).
2597 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
2600 -------------|-----------------------------------------------------------------------------------------------------------------------
2601 mem_used | **Optional.** Tell the plugin to check for used memory in opposite of **mem_free**. Must specify one of these as true.
2602 mem_free | **Optional.** Tell the plugin to check for free memory in opposite of **mem_used**. Must specify one of these as true.
2603 mem_cache | **Optional.** If set to true, plugin will count cache as free memory. Defaults to false.
2604 mem_warning | **Required.** Specify the warning threshold as number interpreted as percent.
2605 mem_critical | **Required.** Specify the critical threshold as number interpreted as percent.
2607 #### <a id="plugin-contrib-command-running_kernel"></a> running_kernel
2609 Check command object for the `check_running_kernel` plugin
2610 provided by the `nagios-plugin-contrib` package on Debian.
2615 ---------------------------|-------------
2616 running\_kernel\_use\_sudo | Whether to run the plugin with `sudo`. Defaults to false except on Ubuntu where it defaults to true.
2618 #### <a id="plugin-contrib-command-iostat"></a> iostat
2620 The plugin [check_iostat](https://github.com/dnsmichi/icinga-plugins/blob/master/scripts/check_iostat) is used to monitor I/O with `iostat` on a linux host. The default thresholds are rather high so you can use a grapher for baselining before setting your own.
2622 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
2625 ---------------|-----------------------------------------------------------------------------------------------------------------------
2626 iostat\_disk | **Required.** The device to monitor without path. e.g. sda or vda. (default: sda)
2627 iostat\_wtps | **Required.** Warning threshold for tps (default: 100)
2628 iostat\_wread | **Required.** Warning threshold for KB/s reads (default: 100)
2629 iostat\_wwrite | **Required.** Warning threshold for KB/s writes (default: 100)
2630 iostat\_ctps | **Required.** Critical threshold for tps (default: 200)
2631 iostat\_cread | **Required.** Critical threshold for KB/s reads (default: 200)
2632 iostat\_cwrite | **Required.** Critical threshold for KB/s writes (default: 200)
2634 #### <a id="plugin-contrib-command-yum"></a> yum
2636 The plugin [check_yum](https://github.com/calestyo/check_yum) is used to check the YUM package
2637 management system for package updates.
2638 The plugin requires the `yum-plugin-security` package to differentiate between security and normal updates.
2640 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
2643 ------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
2644 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.
2645 yum_warn_on_any_update | **Optional.** Set to true to warn if there are any (non-security) package updates available. Defaults to false.
2646 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.
2647 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.
2648 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.
2649 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.
2650 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.
2651 yum_installroot | **Optional.** Specifies another installation root directory (for example a chroot).
2652 yum_timeout | **Optional.** Set a timeout in seconds after which the plugin will exit (defaults to 55 seconds).
2654 ### <a id="plugin-contrib-virtualization"></a> Virtualization
2656 This category includes all plugins for various virtualization technologies.
2658 #### <a id="plugin-contrib-command-esxi-hardware"></a> esxi_hardware
2660 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.
2662 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
2665 ------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
2666 esxi_hardware_host | **Required.** Specifies the host to monitor. Defaults to "$address$".
2667 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.
2668 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.
2669 esxi_hardware_port | **Optional.** Specifies the CIM port to connect to. Defaults to 5989.
2670 esxi_hardware_vendor | **Optional.** Defines the vendor of the server: "auto", "dell", "hp", "ibm", "intel", "unknown" (default).
2671 esxi_hardware_html | **Optional.** Add web-links to hardware manuals for Dell servers (use your country extension). Only useful with **esxi_hardware_vendor** = dell.
2672 esxi_hardware_ignore | **Optional.** Comma separated list of elements to ignore.
2673 esxi_hardware_perfdata | **Optional.** Add performcedata for graphers like PNP4Nagios to the output. Defaults to false.
2674 esxi_hardware_nopower | **Optional.** Do not collect power performance data, when **esxi_hardware_perfdata** is set to true. Defaults to false.
2675 esxi_hardware_novolts | **Optional.** Do not collect voltage performance data, when **esxi_hardware_perfdata** is set to true. Defaults to false.
2676 esxi_hardware_nocurrent | **Optional.** Do not collect current performance data, when **esxi_hardware_perfdata** is set to true. Defaults to false.
2677 esxi_hardware_notemp | **Optional.** Do not collect temperature performance data, when **esxi_hardware_perfdata** is set to true. Defaults to false.
2678 esxi_hardware_nofan | **Optional.** Do not collect fan performance data, when **esxi_hardware_perfdata** is set to true. Defaults to false.
2680 ### <a id="plugin-contrib-vmware"></a> VMware
2682 Check commands for the [check_vmware_esx](https://github.com/BaldMansMojo/check_vmware_esx) plugin.
2684 #### <a id="plugin-contrib-vmware-esx-dc-volumes"></a> vmware-esx-dc-volumes
2686 Check command object for the `check_vmware_esx` plugin. Shows all datastore volumes info.
2688 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
2691 ------------------------|--------------
2692 vmware_datacenter | **Required.** Datacenter/vCenter hostname.
2693 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
2694 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
2695 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
2696 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
2697 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
2698 vmware_sessionfile | **Optional.** Session file name enhancement.
2699 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
2700 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
2701 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
2702 vmware_password | **Optional.** The username's password. No value defined as default.
2703 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
2704 vmware_subselect | **Optional.** Volume name to be checked the free space.
2705 vmware_gigabyte | **Optional.** Output in GB instead of MB.
2706 vmware_usedspace | **Optional.** Output used space instead of free. Defaults to "false".
2707 vmware_alertonly | **Optional.** List only alerting volumes. Defaults to "false".
2708 vmware_exclude | **Optional.** Blacklist volumes name. No value defined as default.
2709 vmware_include | **Optional.** Whitelist volumes name. No value defined as default.
2710 vmware_isregexp | **Optional.** Treat blacklist and whitelist expressions as regexp.
2711 vmware_dc_volume_used | **Optional.** Output used space instead of free. Defaults to "true".
2712 vmware_warn | **Optional.** The warning threshold for volumes. Defaults to "80%".
2713 vmware_crit | **Optional.** The critical threshold for volumes. Defaults to "90%".
2716 #### <a id="plugin-contrib-vmware-esx-dc-runtime-info"></a> vmware-esx-dc-runtime-info
2718 Check command object for the `check_vmware_esx` plugin. Shows all runtime info for the datacenter/Vcenter.
2720 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
2723 ------------------------|--------------
2724 vmware_datacenter | **Required.** Datacenter/vCenter hostname.
2725 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
2726 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
2727 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
2728 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
2729 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
2730 vmware_sessionfile | **Optional.** Session file name enhancement.
2731 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
2732 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
2733 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
2734 vmware_password | **Optional.** The username's password. No value defined as default.
2735 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
2738 #### <a id="plugin-contrib-vmware-esx-dc-runtime-listvms"></a> vmware-esx-dc-runtime-listvms
2740 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.
2742 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
2745 ------------------------|--------------
2746 vmware_datacenter | **Required.** Datacenter/vCenter hostname.
2747 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
2748 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
2749 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
2750 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
2751 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
2752 vmware_sessionfile | **Optional.** Session file name enhancement.
2753 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
2754 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
2755 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
2756 vmware_password | **Optional.** The username's password. No value defined as default.
2757 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
2758 vmware_alertonly | **Optional.** List only alerting VMs. Important here to avoid masses of data.
2759 vmware_exclude | **Optional.** Blacklist VMs name. No value defined as default.
2760 vmware_include | **Optional.** Whitelist VMs name. No value defined as default.
2761 vmware_isregexp | **Optional.** Treat blacklist and whitelist expressions as regexp.
2762 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.
2765 #### <a id="plugin-contrib-vmware-esx-dc-runtime-listhost"></a> vmware-esx-dc-runtime-listhost
2767 Check command object for the `check_vmware_esx` plugin. List of VMware ESX hosts and their power state.
2769 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
2772 ------------------------|--------------
2773 vmware_datacenter | **Required.** Datacenter/vCenter hostname.
2774 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
2775 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
2776 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
2777 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
2778 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
2779 vmware_sessionfile | **Optional.** Session file name enhancement.
2780 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
2781 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
2782 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
2783 vmware_password | **Optional.** The username's password. No value defined as default.
2784 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
2785 vmware_alertonly | **Optional.** List only alerting hosts. Important here to avoid masses of data.
2786 vmware_exclude | **Optional.** Blacklist VMware ESX hosts. No value defined as default.
2787 vmware_include | **Optional.** Whitelist VMware ESX hosts. No value defined as default.
2788 vmware_isregexp | **Optional.** Treat blacklist and whitelist expressions as regexp.
2789 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.
2792 #### <a id="plugin-contrib-vmware-esx-dc-runtime-listcluster"></a> vmware-esx-dc-runtime-listcluster
2794 Check command object for the `check_vmware_esx` plugin. List of VMware clusters and their states.
2796 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
2799 ------------------------|--------------
2800 vmware_datacenter | **Required.** Datacenter/vCenter hostname.
2801 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
2802 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
2803 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
2804 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
2805 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
2806 vmware_sessionfile | **Optional.** Session file name enhancement.
2807 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
2808 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
2809 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
2810 vmware_password | **Optional.** The username's password. No value defined as default.
2811 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
2812 vmware_alertonly | **Optional.** List only alerting hosts. Important here to avoid masses of data.
2813 vmware_exclude | **Optional.** Blacklist VMware cluster. No value defined as default.
2814 vmware_include | **Optional.** Whitelist VMware cluster. No value defined as default.
2815 vmware_isregexp | **Optional.** Treat blacklist and whitelist expressions as regexp.
2816 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.
2819 #### <a id="plugin-contrib-vmware-esx-dc-runtime-issues"></a> vmware-esx-dc-runtime-issues
2821 Check command object for the `check_vmware_esx` plugin. All issues for the host.
2823 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
2826 ------------------------|--------------
2827 vmware_datacenter | **Required.** Datacenter/vCenter hostname.
2828 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
2829 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
2830 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
2831 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
2832 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
2833 vmware_sessionfile | **Optional.** Session file name enhancement.
2834 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
2835 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
2836 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
2837 vmware_password | **Optional.** The username's password. No value defined as default.
2838 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
2839 vmware_exclude | **Optional.** Blacklist issues. No value defined as default.
2840 vmware_include | **Optional.** Whitelist issues. No value defined as default.
2841 vmware_isregexp | **Optional.** Treat blacklist and whitelist expressions as regexp.
2842 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.
2845 #### <a id="plugin-contrib-vmware-esx-dc-runtime-status"></a> vmware-esx-dc-runtime-status
2847 Check command object for the `check_vmware_esx` plugin. Overall object status (gray/green/red/yellow).
2849 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
2852 ------------------------|--------------
2853 vmware_datacenter | **Required.** Datacenter/vCenter 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
2867 #### <a id="plugin-contrib-vmware-esx-dc-runtime-tools"></a> vmware-esx-dc-runtime-tools
2869 Check command object for the `check_vmware_esx` plugin. Vmware Tools status.
2871 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
2874 ------------------------|--------------
2875 vmware_datacenter | **Required.** Datacenter/vCenter hostname.
2876 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
2877 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
2878 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
2879 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
2880 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
2881 vmware_sessionfile | **Optional.** Session file name enhancement.
2882 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
2883 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
2884 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
2885 vmware_password | **Optional.** The username's password. No value defined as default.
2886 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
2887 vmware_poweredonly | **Optional.** List only VMs which are powered on. No value defined as default.
2888 vmware_alertonly | **Optional.** List only alerting VMs. Important here to avoid masses of data.
2889 vmware_exclude | **Optional.** Blacklist VMs. No value defined as default.
2890 vmware_include | **Optional.** Whitelist VMs. No value defined as default.
2891 vmware_isregexp | **Optional.** Treat blacklist and whitelist expressions as regexp.
2892 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.
2893 vmware_openvmtools | **Optional** Prevent CRITICAL state for installed and running Open VM Tools.
2896 #### <a id="plugin-contrib-vmware-esx-soap-host-check"></a> vmware-esx-soap-host-check
2898 Check command object for the `check_vmware_esx` plugin. Simple check to verify a successfull connection to VMware SOAP API.
2900 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
2903 ------------------------|--------------
2904 vmware_host | **Required.** ESX or ESXi hostname.
2905 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
2906 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
2907 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
2908 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
2909 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
2910 vmware_sessionfile | **Optional.** Session file name enhancement.
2911 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
2912 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
2913 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
2914 vmware_password | **Optional.** The username's password. No value defined as default.
2915 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
2918 #### <a id="plugin-contrib-vmware-esx-soap-host-uptime"></a> vmware-esx-soap-host-uptime
2920 Check command object for the `check_vmware_esx` plugin. Displays uptime of the VMware host.
2922 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
2925 ------------------------|--------------
2926 vmware_host | **Required.** ESX or ESXi hostname.
2927 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
2928 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
2929 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
2930 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
2931 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
2932 vmware_sessionfile | **Optional.** Session file name enhancement.
2933 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
2934 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
2935 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
2936 vmware_password | **Optional.** The username's password. No value defined as default.
2937 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
2940 #### <a id="plugin-contrib-vmware-esx-soap-host-cpu"></a> vmware-esx-soap-host-cpu
2942 Check command object for the `check_vmware_esx` plugin. CPU usage in percentage.
2944 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
2947 ------------------------|--------------
2948 vmware_host | **Required.** ESX or ESXi hostname.
2949 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
2950 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
2951 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
2952 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
2953 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
2954 vmware_sessionfile | **Optional.** Session file name enhancement.
2955 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
2956 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
2957 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
2958 vmware_password | **Optional.** The username's password. No value defined as default.
2959 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
2960 vmware_warn | **Optional.** The warning threshold in percent. Defaults to "80%".
2961 vmware_crit | **Optional.** The critical threshold in percent. Defaults to "90%".
2964 #### <a id="plugin-contrib-vmware-esx-soap-host-cpu-ready"></a> vmware-esx-soap-host-cpu-ready
2966 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.
2968 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
2971 ------------------------|--------------
2972 vmware_host | **Required.** ESX or ESXi hostname.
2973 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
2974 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
2975 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
2976 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
2977 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
2978 vmware_sessionfile | **Optional.** Session file name enhancement.
2979 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
2980 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
2981 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
2982 vmware_password | **Optional.** The username's password. No value defined as default.
2983 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
2986 #### <a id="plugin-contrib-vmware-esx-soap-host-cpu-wait"></a> vmware-esx-soap-host-cpu-wait
2988 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.
2990 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
2993 ------------------------|--------------
2994 vmware_host | **Required.** ESX or ESXi hostname.
2995 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
2996 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
2997 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
2998 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
2999 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
3000 vmware_sessionfile | **Optional.** Session file name enhancement.
3001 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
3002 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
3003 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
3004 vmware_password | **Optional.** The username's password. No value defined as default.
3005 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
3008 #### <a id="plugin-contrib-vmware-esx-soap-host-cpu-usage"></a> vmware-esx-soap-host-cpu-usage
3010 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.
3012 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
3015 ------------------------|--------------
3016 vmware_host | **Required.** ESX or ESXi hostname.
3017 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
3018 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
3019 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
3020 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
3021 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
3022 vmware_sessionfile | **Optional.** Session file name enhancement.
3023 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
3024 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
3025 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
3026 vmware_password | **Optional.** The username's password. No value defined as default.
3027 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
3028 vmware_warn | **Optional.** The warning threshold in percent. Defaults to "80%".
3029 vmware_crit | **Optional.** The critical threshold in percent. Defaults to "90%".
3032 #### <a id="plugin-contrib-vmware-esx-soap-host-mem"></a> vmware-esx-soap-host-mem
3034 Check command object for the `check_vmware_esx` plugin. All mem info(except overall and no thresholds).
3036 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
3039 ------------------------|--------------
3040 vmware_host | **Required.** ESX or ESXi hostname.
3041 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
3042 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
3043 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
3044 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
3045 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
3046 vmware_sessionfile | **Optional.** Session file name enhancement.
3047 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
3048 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
3049 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
3050 vmware_password | **Optional.** The username's password. No value defined as default.
3051 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
3054 #### <a id="plugin-contrib-vmware-esx-soap-host-mem-usage"></a> vmware-esx-soap-host-mem-usage
3056 Check command object for the `check_vmware_esx` plugin. Average mem usage in percentage.
3058 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
3061 ------------------------|--------------
3062 vmware_host | **Required.** ESX or ESXi hostname.
3063 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
3064 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
3065 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
3066 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
3067 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
3068 vmware_sessionfile | **Optional.** Session file name enhancement.
3069 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
3070 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
3071 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
3072 vmware_password | **Optional.** The username's password. No value defined as default.
3073 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
3074 vmware_warn | **Optional.** The warning threshold in percent. Defaults to "80%".
3075 vmware_crit | **Optional.** The critical threshold in percent. Defaults to "90%".
3078 #### <a id="plugin-contrib-vmware-esx-soap-host-mem-consumed"></a> vmware-esx-soap-host-mem-consumed
3080 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.
3082 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
3085 ------------------------|--------------
3086 vmware_host | **Required.** ESX or ESXi hostname.
3087 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
3088 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
3089 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
3090 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
3091 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
3092 vmware_sessionfile | **Optional.** Session file name enhancement.
3093 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
3094 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
3095 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
3096 vmware_password | **Optional.** The username's password. No value defined as default.
3097 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
3098 vmware_warn | **Optional.** The warning threshold in percent. No value defined as default.
3099 vmware_crit | **Optional.** The critical threshold in percent. No value defined as default.
3102 #### <a id="plugin-contrib-vmware-esx-soap-host-mem-swapused"></a> vmware-esx-soap-host-mem-swapused
3104 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.
3106 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
3109 ------------------------|--------------
3110 vmware_host | **Required.** ESX or ESXi hostname.
3111 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
3112 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
3113 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
3114 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
3115 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
3116 vmware_sessionfile | **Optional.** Session file name enhancement.
3117 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
3118 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
3119 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
3120 vmware_password | **Optional.** The username's password. No value defined as default.
3121 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
3122 vmware_warn | **Optional.** The warning threshold in percent. No value defined as default.
3123 vmware_crit | **Optional.** The critical threshold in percent. No value defined as default.
3124 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.
3127 #### <a id="plugin-contrib-vmware-esx-soap-host-mem-overhead"></a> vmware-esx-soap-host-mem-overhead
3129 Check command object for the `check_vmware_esx` plugin. Additional mem used by VM Server in MB.
3131 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
3134 ------------------------|--------------
3135 vmware_host | **Required.** ESX or ESXi hostname.
3136 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
3137 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
3138 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
3139 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
3140 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
3141 vmware_sessionfile | **Optional.** Session file name enhancement.
3142 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
3143 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
3144 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
3145 vmware_password | **Optional.** The username's password. No value defined as default.
3146 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
3147 vmware_warn | **Optional.** The warning threshold in percent. No value defined as default.
3148 vmware_crit | **Optional.** The critical threshold in percent. No value defined as default.
3151 #### <a id="plugin-contrib-vmware-esx-soap-host-mem-memctl"></a> vmware-esx-soap-host-mem-memctl
3153 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.
3155 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
3158 ------------------------|--------------
3159 vmware_host | **Required.** ESX or ESXi hostname.
3160 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
3161 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
3162 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
3163 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
3164 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
3165 vmware_sessionfile | **Optional.** Session file name enhancement.
3166 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
3167 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
3168 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
3169 vmware_password | **Optional.** The username's password. No value defined as default.
3170 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
3171 vmware_warn | **Optional.** The warning threshold in percent. No value defined as default.
3172 vmware_crit | **Optional.** The critical threshold in percent. No value defined as default.
3173 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.
3176 #### <a id="plugin-contrib-vmware-esx-soap-host-net"></a> vmware-esx-soap-host-net
3178 Check command object for the `check_vmware_esx` plugin. Shows net info.
3180 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
3183 ------------------------|--------------
3184 vmware_host | **Required.** ESX or ESXi hostname.
3185 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
3186 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
3187 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
3188 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
3189 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
3190 vmware_sessionfile | **Optional.** Session file name enhancement.
3191 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
3192 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
3193 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
3194 vmware_password | **Optional.** The username's password. No value defined as default.
3195 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
3196 vmware_exclude | **Optional.** Blacklist NICs. No value defined as default.
3197 vmware_isregexp | **Optional.** Treat blacklist expression as regexp.
3200 #### <a id="plugin-contrib-vmware-esx-soap-host-net-usage"></a> vmware-esx-soap-host-net-usage
3202 Check command object for the `check_vmware_esx` plugin. Overall network usage in KBps(Kilobytes per Second).
3204 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
3207 ------------------------|--------------
3208 vmware_host | **Required.** ESX or ESXi hostname.
3209 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
3210 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
3211 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
3212 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
3213 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
3214 vmware_sessionfile | **Optional.** Session file name enhancement.
3215 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
3216 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
3217 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
3218 vmware_password | **Optional.** The username's password. No value defined as default.
3219 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
3220 vmware_warn | **Optional.** The warning threshold in KBps(Kilobytes per Second). No value defined as default.
3221 vmware_crit | **Optional.** The critical threshold in KBps(Kilobytes per Second). No value defined as default.
3224 #### <a id="plugin-contrib-vmware-esx-soap-host-net-receive"></a> vmware-esx-soap-host-net-receive
3226 Check command object for the `check_vmware_esx` plugin. Data receive in KBps(Kilobytes per Second).
3228 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
3231 ------------------------|--------------
3232 vmware_host | **Required.** ESX or ESXi hostname.
3233 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
3234 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
3235 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
3236 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
3237 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
3238 vmware_sessionfile | **Optional.** Session file name enhancement.
3239 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
3240 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
3241 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
3242 vmware_password | **Optional.** The username's password. No value defined as default.
3243 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
3244 vmware_warn | **Optional.** The warning threshold in KBps(Kilobytes per Second). No value defined as default.
3245 vmware_crit | **Optional.** The critical threshold in KBps(Kilobytes per Second). No value defined as default.
3248 #### <a id="plugin-contrib-vmware-esx-soap-host-net-send"></a> vmware-esx-soap-host-net-send
3250 Check command object for the `check_vmware_esx` plugin. Data send in KBps(Kilobytes per Second).
3252 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
3255 ------------------------|--------------
3256 vmware_host | **Required.** ESX or ESXi hostname.
3257 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
3258 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
3259 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
3260 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
3261 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
3262 vmware_sessionfile | **Optional.** Session file name enhancement.
3263 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
3264 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
3265 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
3266 vmware_password | **Optional.** The username's password. No value defined as default.
3267 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
3268 vmware_warn | **Optional.** The warning threshold in KBps(Kilobytes per Second). No value defined as default.
3269 vmware_crit | **Optional.** The critical threshold in KBps(Kilobytes per Second). No value defined as default.
3272 #### <a id="plugin-contrib-vmware-esx-soap-host-net-nic"></a> vmware-esx-soap-host-net-nic
3274 Check command object for the `check_vmware_esx` plugin. Check all active NICs.
3276 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
3279 ------------------------|--------------
3280 vmware_host | **Required.** ESX or ESXi hostname.
3281 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
3282 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
3283 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
3284 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
3285 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
3286 vmware_sessionfile | **Optional.** Session file name enhancement.
3287 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
3288 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
3289 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
3290 vmware_password | **Optional.** The username's password. No value defined as default.
3291 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
3292 vmware_exclude | **Optional.** Blacklist NICs. No value defined as default.
3293 vmware_isregexp | **Optional.** Treat blacklist expression as regexp.
3296 #### <a id="plugin-contrib-vmware-esx-soap-host-volumes"></a> vmware-esx-soap-host-volumes
3298 Check command object for the `check_vmware_esx` plugin. Shows all datastore volumes info.
3300 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
3303 ------------------------|--------------
3304 vmware_host | **Required.** ESX or ESXi hostname.
3305 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
3306 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
3307 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
3308 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
3309 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
3310 vmware_sessionfile | **Optional.** Session file name enhancement.
3311 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
3312 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
3313 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
3314 vmware_password | **Optional.** The username's password. No value defined as default.
3315 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
3316 vmware_subselect | **Optional.** Volume name to be checked the free space.
3317 vmware_gigabyte | **Optional.** Output in GB instead of MB.
3318 vmware_usedspace | **Optional.** Output used space instead of free. Defaults to "false".
3319 vmware_alertonly | **Optional.** List only alerting volumes. Defaults to "false".
3320 vmware_exclude | **Optional.** Blacklist volumes name. No value defined as default.
3321 vmware_include | **Optional.** Whitelist volumes name. No value defined as default.
3322 vmware_isregexp | **Optional.** Treat blacklist and whitelist expressions as regexp.
3323 vmware_warn | **Optional.** The warning threshold for volumes. Defaults to "80%".
3324 vmware_crit | **Optional.** The critical threshold for volumes. Defaults to "90%".
3325 vmware_spaceleft | **Optional.** This has to be used in conjunction with thresholds as mentioned above.
3328 #### <a id="plugin-contrib-vmware-esx-soap-host-io"></a> vmware-esx-soap-host-io
3330 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.
3332 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
3335 ------------------------|--------------
3336 vmware_host | **Required.** ESX or ESXi hostname.
3337 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
3338 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
3339 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
3340 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
3341 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
3342 vmware_sessionfile | **Optional.** Session file name enhancement.
3343 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
3344 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
3345 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
3346 vmware_password | **Optional.** The username's password. No value defined as default.
3347 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
3350 #### <a id="plugin-contrib-vmware-esx-soap-host-io-aborted"></a> vmware-esx-soap-host-io-aborted
3352 Check command object for the `check_vmware_esx` plugin. Number of aborted SCSI commands.
3354 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
3357 ------------------------|--------------
3358 vmware_host | **Required.** ESX or ESXi hostname.
3359 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
3360 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
3361 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
3362 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
3363 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
3364 vmware_sessionfile | **Optional.** Session file name enhancement.
3365 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
3366 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
3367 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
3368 vmware_password | **Optional.** The username's password. No value defined as default.
3369 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
3370 vmware_warn | **Optional.** The warning threshold. No value defined as default.
3371 vmware_crit | **Optional.** The critical threshold. No value defined as default.
3374 #### <a id="plugin-contrib-vmware-esx-soap-host-io-resets"></a> vmware-esx-soap-host-io-resets
3376 Check command object for the `check_vmware_esx` plugin. Number of SCSI bus resets.
3378 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
3381 ------------------------|--------------
3382 vmware_host | **Required.** ESX or ESXi hostname.
3383 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
3384 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
3385 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
3386 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
3387 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
3388 vmware_sessionfile | **Optional.** Session file name enhancement.
3389 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
3390 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
3391 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
3392 vmware_password | **Optional.** The username's password. No value defined as default.
3393 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
3394 vmware_warn | **Optional.** The warning threshold. No value defined as default.
3395 vmware_crit | **Optional.** The critical threshold. No value defined as default.
3398 #### <a id="plugin-contrib-vmware-esx-soap-host-io-read"></a> vmware-esx-soap-host-io-read
3400 Check command object for the `check_vmware_esx` plugin. Average number of kilobytes read from the disk each second.
3402 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
3405 ------------------------|--------------
3406 vmware_host | **Required.** ESX or ESXi hostname.
3407 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
3408 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
3409 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
3410 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
3411 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
3412 vmware_sessionfile | **Optional.** Session file name enhancement.
3413 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
3414 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
3415 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
3416 vmware_password | **Optional.** The username's password. No value defined as default.
3417 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
3418 vmware_warn | **Optional.** The warning threshold. No value defined as default.
3419 vmware_crit | **Optional.** The critical threshold. No value defined as default.
3422 #### <a id="plugin-contrib-vmware-esx-soap-host-io-read-latency"></a> vmware-esx-soap-host-io-read-latency
3424 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.
3426 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
3429 ------------------------|--------------
3430 vmware_host | **Required.** ESX or ESXi hostname.
3431 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
3432 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
3433 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
3434 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
3435 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
3436 vmware_sessionfile | **Optional.** Session file name enhancement.
3437 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
3438 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
3439 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
3440 vmware_password | **Optional.** The username's password. No value defined as default.
3441 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
3442 vmware_warn | **Optional.** The warning threshold. No value defined as default.
3443 vmware_crit | **Optional.** The critical threshold. No value defined as default.
3446 #### <a id="plugin-contrib-vmware-esx-soap-host-io-write"></a> vmware-esx-soap-host-io-write
3448 Check command object for the `check_vmware_esx` plugin. Average number of kilobytes written to disk each second.
3450 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
3453 ------------------------|--------------
3454 vmware_host | **Required.** ESX or ESXi hostname.
3455 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
3456 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
3457 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
3458 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
3459 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
3460 vmware_sessionfile | **Optional.** Session file name enhancement.
3461 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
3462 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
3463 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
3464 vmware_password | **Optional.** The username's password. No value defined as default.
3465 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
3466 vmware_warn | **Optional.** The warning threshold. No value defined as default.
3467 vmware_crit | **Optional.** The critical threshold. No value defined as default.
3470 #### <a id="plugin-contrib-vmware-esx-soap-host-io-write-latency"></a> vmware-esx-soap-host-io-write-latency
3472 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.
3474 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
3477 ------------------------|--------------
3478 vmware_host | **Required.** ESX or ESXi hostname.
3479 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
3480 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
3481 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
3482 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
3483 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
3484 vmware_sessionfile | **Optional.** Session file name enhancement.
3485 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
3486 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
3487 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
3488 vmware_password | **Optional.** The username's password. No value defined as default.
3489 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
3490 vmware_warn | **Optional.** The warning threshold. No value defined as default.
3491 vmware_crit | **Optional.** The critical threshold. No value defined as default.
3494 #### <a id="plugin-contrib-vmware-esx-soap-host-io-usage"></a> vmware-esx-soap-host-io-usage
3496 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.
3498 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
3501 ------------------------|--------------
3502 vmware_host | **Required.** ESX or ESXi hostname.
3503 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
3504 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
3505 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
3506 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
3507 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
3508 vmware_sessionfile | **Optional.** Session file name enhancement.
3509 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
3510 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
3511 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
3512 vmware_password | **Optional.** The username's password. No value defined as default.
3513 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
3514 vmware_warn | **Optional.** The warning threshold. No value defined as default.
3515 vmware_crit | **Optional.** The critical threshold. No value defined as default.
3518 #### <a id="plugin-contrib-vmware-esx-soap-host-io-kernel-latency"></a> vmware-esx-soap-host-io-kernel-latency
3520 Check command object for the `check_vmware_esx` plugin. Average amount of time (ms) spent by VMkernel processing each SCSI command.
3522 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
3525 ------------------------|--------------
3526 vmware_host | **Required.** ESX or ESXi hostname.
3527 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
3528 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
3529 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
3530 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
3531 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
3532 vmware_sessionfile | **Optional.** Session file name enhancement.
3533 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
3534 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
3535 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
3536 vmware_password | **Optional.** The username's password. No value defined as default.
3537 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
3538 vmware_warn | **Optional.** The warning threshold. No value defined as default.
3539 vmware_crit | **Optional.** The critical threshold. No value defined as default.
3542 #### <a id="plugin-contrib-vmware-esx-soap-host-io-device-latency"></a> vmware-esx-soap-host-io-device-latency
3544 Check command object for the `check_vmware_esx` plugin. Average amount of time (ms) to complete a SCSI command from the physical device.
3546 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
3549 ------------------------|--------------
3550 vmware_host | **Required.** ESX or ESXi hostname.
3551 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
3552 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
3553 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
3554 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
3555 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
3556 vmware_sessionfile | **Optional.** Session file name enhancement.
3557 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
3558 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
3559 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
3560 vmware_password | **Optional.** The username's password. No value defined as default.
3561 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
3562 vmware_warn | **Optional.** The warning threshold. No value defined as default.
3563 vmware_crit | **Optional.** The critical threshold. No value defined as default.
3566 #### <a id="plugin-contrib-vmware-esx-soap-host-io-queue-latency"></a> vmware-esx-soap-host-io-queue-latency
3568 Check command object for the `check_vmware_esx` plugin. Average amount of time (ms) spent in the VMkernel queue.
3570 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
3573 ------------------------|--------------
3574 vmware_host | **Required.** ESX or ESXi hostname.
3575 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
3576 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
3577 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
3578 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
3579 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
3580 vmware_sessionfile | **Optional.** Session file name enhancement.
3581 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
3582 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
3583 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
3584 vmware_password | **Optional.** The username's password. No value defined as default.
3585 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
3586 vmware_warn | **Optional.** The warning threshold. No value defined as default.
3587 vmware_crit | **Optional.** The critical threshold. No value defined as default.
3590 #### <a id="plugin-contrib-vmware-esx-soap-host-io-total-latency"></a> vmware-esx-soap-host-io-total-latency
3592 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.
3594 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
3597 ------------------------|--------------
3598 vmware_host | **Required.** ESX or ESXi hostname.
3599 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
3600 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
3601 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
3602 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
3603 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
3604 vmware_sessionfile | **Optional.** Session file name enhancement.
3605 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
3606 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
3607 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
3608 vmware_password | **Optional.** The username's password. No value defined as default.
3609 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
3610 vmware_warn | **Optional.** The warning threshold. No value defined as default.
3611 vmware_crit | **Optional.** The critical threshold. No value defined as default.
3614 #### <a id="plugin-contrib-vmware-esx-soap-host-media"></a> vmware-esx-soap-host-media
3616 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.
3618 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
3621 ------------------------|--------------
3622 vmware_host | **Required.** ESX or ESXi hostname.
3623 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
3624 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
3625 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
3626 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
3627 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
3628 vmware_sessionfile | **Optional.** Session file name enhancement.
3629 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
3630 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
3631 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
3632 vmware_password | **Optional.** The username's password. No value defined as default.
3633 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
3634 vmware_exclude | **Optional.** Blacklist VMs name. No value defined as default.
3635 vmware_include | **Optional.** Whitelist VMs name. No value defined as default.
3636 vmware_isregexp | **Optional.** Treat blacklist and whitelist expressions as regexp.
3637 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.
3640 #### <a id="plugin-contrib-vmware-esx-soap-host-service"></a> vmware-esx-soap-host-service
3642 Check command object for the `check_vmware_esx` plugin. Shows host service info.
3644 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
3647 ------------------------|--------------
3648 vmware_host | **Required.** ESX or ESXi hostname.
3649 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
3650 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
3651 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
3652 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
3653 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
3654 vmware_sessionfile | **Optional.** Session file name enhancement.
3655 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
3656 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
3657 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
3658 vmware_password | **Optional.** The username's password. No value defined as default.
3659 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
3660 vmware_exclude | **Optional.** Blacklist services name. No value defined as default.
3661 vmware_include | **Optional.** Whitelist services name. No value defined as default.
3662 vmware_isregexp | **Optional.** Treat blacklist and whitelist expressions as regexp.
3663 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.
3666 #### <a id="plugin-contrib-vmware-esx-soap-host-runtime"></a> vmware-esx-soap-host-runtime
3668 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.
3670 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
3673 ------------------------|--------------
3674 vmware_host | **Required.** ESX or ESXi hostname.
3675 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
3676 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
3677 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
3678 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
3679 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
3680 vmware_sessionfile | **Optional.** Session file name enhancement.
3681 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
3682 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
3683 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
3684 vmware_password | **Optional.** The username's password. No value defined as default.
3685 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
3688 #### <a id="plugin-contrib-vmware-esx-soap-host-runtime-con"></a> vmware-esx-soap-host-runtime-con
3690 Check command object for the `check_vmware_esx` plugin. Shows connection state.
3692 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
3695 ------------------------|--------------
3696 vmware_host | **Required.** ESX or ESXi hostname.
3697 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
3698 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
3699 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
3700 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
3701 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
3702 vmware_sessionfile | **Optional.** Session file name enhancement.
3703 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
3704 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
3705 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
3706 vmware_password | **Optional.** The username's password. No value defined as default.
3707 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
3710 #### <a id="plugin-contrib-vmware-esx-soap-host-runtime-listvms"></a> vmware-esx-soap-host-runtime-listvms
3712 Check command object for the `check_vmware_esx` plugin. List of VMware machines and their status.
3714 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
3717 ------------------------|--------------
3718 vmware_host | **Required.** ESX or ESXi hostname.
3719 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
3720 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
3721 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
3722 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
3723 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
3724 vmware_sessionfile | **Optional.** Session file name enhancement.
3725 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
3726 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
3727 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
3728 vmware_password | **Optional.** The username's password. No value defined as default.
3729 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
3730 vmware_exclude | **Optional.** Blacklist VMs name. No value defined as default.
3731 vmware_include | **Optional.** Whitelist VMs name. No value defined as default.
3732 vmware_isregexp | **Optional.** Treat blacklist and whitelist expressions as regexp.
3733 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.
3736 #### <a id="plugin-contrib-vmware-esx-soap-host-runtime-status"></a> vmware-esx-soap-host-runtime-status
3738 Check command object for the `check_vmware_esx` plugin. Overall object status (gray/green/red/yellow).
3740 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
3743 ------------------------|--------------
3744 vmware_host | **Required.** ESX or ESXi hostname.
3745 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
3746 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
3747 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
3748 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
3749 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
3750 vmware_sessionfile | **Optional.** Session file name enhancement.
3751 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
3752 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
3753 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
3754 vmware_password | **Optional.** The username's password. No value defined as default.
3755 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
3758 #### <a id="plugin-contrib-vmware-esx-soap-host-runtime-health"></a> vmware-esx-soap-host-runtime-health
3760 Check command object for the `check_vmware_esx` plugin. Checks cpu/storage/memory/sensor status.
3762 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
3765 ------------------------|--------------
3766 vmware_host | **Required.** ESX or ESXi hostname.
3767 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
3768 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
3769 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
3770 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
3771 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
3772 vmware_sessionfile | **Optional.** Session file name enhancement.
3773 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
3774 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
3775 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
3776 vmware_password | **Optional.** The username's password. No value defined as default.
3777 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
3778 vmware_exclude | **Optional.** Blacklist status name. No value defined as default.
3779 vmware_include | **Optional.** Whitelist status name. No value defined as default.
3780 vmware_isregexp | **Optional.** Treat blacklist and whitelist expressions as regexp.
3783 #### <a id="plugin-contrib-vmware-esx-soap-host-runtime-health-listsensors"></a> vmware-esx-soap-host-runtime-health-listsensors
3785 Check command object for the `check_vmware_esx` plugin. List all available sensors(use for listing purpose only).
3787 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
3790 ------------------------|--------------
3791 vmware_host | **Required.** ESX or ESXi hostname.
3792 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
3793 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
3794 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
3795 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
3796 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
3797 vmware_sessionfile | **Optional.** Session file name enhancement.
3798 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
3799 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
3800 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
3801 vmware_password | **Optional.** The username's password. No value defined as default.
3802 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
3803 vmware_exclude | **Optional.** Blacklist status name. No value defined as default.
3804 vmware_include | **Optional.** Whitelist status name. No value defined as default.
3805 vmware_isregexp | **Optional.** Treat blacklist and whitelist expressions as regexp.
3808 #### <a id="plugin-contrib-vmware-esx-soap-host-runtime-health-nostoragestatus"></a> vmware-esx-soap-host-runtime-health-nostoragestatus
3810 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**.
3812 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
3815 ------------------------|--------------
3816 vmware_host | **Required.** ESX or ESXi hostname.
3817 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
3818 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
3819 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
3820 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
3821 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
3822 vmware_sessionfile | **Optional.** Session file name enhancement.
3823 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
3824 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
3825 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
3826 vmware_password | **Optional.** The username's password. No value defined as default.
3827 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
3828 vmware_exclude | **Optional.** Blacklist status name. No value defined as default.
3829 vmware_include | **Optional.** Whitelist status name. No value defined as default.
3830 vmware_isregexp | **Optional.** Treat blacklist and whitelist expressions as regexp.
3833 #### <a id="plugin-contrib-vmware-esx-soap-host-runtime-storagehealth"></a> vmware-esx-soap-host-runtime-storagehealth
3835 Check command object for the `check_vmware_esx` plugin. Local storage status check.
3837 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
3840 ------------------------|--------------
3841 vmware_host | **Required.** ESX or ESXi hostname.
3842 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
3843 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
3844 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
3845 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
3846 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
3847 vmware_sessionfile | **Optional.** Session file name enhancement.
3848 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
3849 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
3850 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
3851 vmware_password | **Optional.** The username's password. No value defined as default.
3852 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
3853 vmware_exclude | **Optional.** Blacklist storage name. No value defined as default.
3854 vmware_include | **Optional.** Whitelist storage name. No value defined as default.
3855 vmware_isregexp | **Optional.** Treat blacklist and whitelist expressions as regexp.
3856 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.
3859 #### <a id="plugin-contrib-vmware-esx-soap-host-runtime-temp"></a> vmware-esx-soap-host-runtime-temp
3861 Check command object for the `check_vmware_esx` plugin. Lists all temperature sensors.
3863 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
3866 ------------------------|--------------
3867 vmware_host | **Required.** ESX or ESXi hostname.
3868 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
3869 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
3870 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
3871 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
3872 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
3873 vmware_sessionfile | **Optional.** Session file name enhancement.
3874 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
3875 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
3876 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
3877 vmware_password | **Optional.** The username's password. No value defined as default.
3878 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
3879 vmware_exclude | **Optional.** Blacklist sensor name. No value defined as default.
3880 vmware_include | **Optional.** Whitelist sensor name. No value defined as default.
3881 vmware_isregexp | **Optional.** Treat blacklist and whitelist expressions as regexp.
3882 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.
3885 #### <a id="plugin-contrib-vmware-esx-soap-host-runtime-issues"></a> vmware-esx-soap-host-runtime-issues
3887 Check command object for the `check_vmware_esx` plugin. Lists all configuration issues for the host.
3889 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
3892 ------------------------|--------------
3893 vmware_host | **Required.** ESX or ESXi hostname.
3894 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
3895 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
3896 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
3897 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
3898 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
3899 vmware_sessionfile | **Optional.** Session file name enhancement.
3900 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
3901 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
3902 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
3903 vmware_password | **Optional.** The username's password. No value defined as default.
3904 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
3905 vmware_exclude | **Optional.** Blacklist configuration issues. No value defined as default.
3906 vmware_include | **Optional.** Whitelist configuration issues. No value defined as default.
3907 vmware_isregexp | **Optional.** Treat blacklist and whitelist expressions as regexp.
3908 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.
3911 #### <a id="plugin-contrib-vmware-esx-soap-host-storage"></a> vmware-esx-soap-host-storage
3913 Check command object for the `check_vmware_esx` plugin. Shows Host storage info.
3915 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
3918 ------------------------|--------------
3919 vmware_host | **Required.** ESX or ESXi hostname.
3920 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
3921 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
3922 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
3923 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
3924 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
3925 vmware_sessionfile | **Optional.** Session file name enhancement.
3926 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
3927 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
3928 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
3929 vmware_password | **Optional.** The username's password. No value defined as default.
3930 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
3931 vmware_exclude | **Optional.** Blacklist adapters, luns and paths. No value defined as default.
3932 vmware_include | **Optional.** Whitelist adapters, luns and paths. No value defined as default.
3933 vmware_isregexp | **Optional.** Treat blacklist and whitelist expressions as regexp.
3936 #### <a id="plugin-contrib-vmware-esx-soap-host-storage-adapter"></a> vmware-esx-soap-host-storage-adapter
3938 Check command object for the `check_vmware_esx` plugin. List host bus adapters.
3940 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
3943 ------------------------|--------------
3944 vmware_host | **Required.** ESX or ESXi hostname.
3945 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
3946 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
3947 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
3948 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
3949 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
3950 vmware_sessionfile | **Optional.** Session file name enhancement.
3951 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
3952 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
3953 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
3954 vmware_password | **Optional.** The username's password. No value defined as default.
3955 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
3956 vmware_exclude | **Optional.** Blacklist adapters. No value defined as default.
3957 vmware_include | **Optional.** Whitelist adapters. No value defined as default.
3958 vmware_isregexp | **Optional.** Treat blacklist and whitelist expressions as regexp.
3959 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.
3962 #### <a id="plugin-contrib-vmware-esx-soap-host-storage-lun"></a> vmware-esx-soap-host-storage-lun
3964 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.
3966 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
3969 ------------------------|--------------
3970 vmware_host | **Required.** ESX or ESXi hostname.
3971 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
3972 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
3973 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
3974 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
3975 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
3976 vmware_sessionfile | **Optional.** Session file name enhancement.
3977 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
3978 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
3979 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
3980 vmware_password | **Optional.** The username's password. No value defined as default.
3981 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
3982 vmware_exclude | **Optional.** Blacklist luns. No value defined as default.
3983 vmware_include | **Optional.** Whitelist luns. No value defined as default.
3984 vmware_isregexp | **Optional.** Treat blacklist and whitelist expressions as regexp.
3985 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.
3988 #### <a id="plugin-contrib-vmware-esx-soap-host-storage-path"></a> vmware-esx-soap-host-storage-path
3990 Check command object for the `check_vmware_esx` plugin. List multipaths and the associated paths.
3992 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
3995 ------------------------|--------------
3996 vmware_host | **Required.** ESX or ESXi hostname.
3997 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
3998 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
3999 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
4000 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
4001 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
4002 vmware_sessionfile | **Optional.** Session file name enhancement.
4003 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
4004 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
4005 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
4006 vmware_password | **Optional.** The username's password. No value defined as default.
4007 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
4008 vmware_alertonly | **Optional.** List only alerting units. Important here to avoid masses of data. Defaults to "false".
4009 vmware_exclude | **Optional.** Blacklist paths. No value defined as default.
4010 vmware_include | **Optional.** Whitelist paths. No value defined as default.
4011 vmware_isregexp | **Optional.** Treat blacklist and whitelist expressions as regexp.
4012 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.
4015 #### <a id="plugin-contrib-vmware-esx-soap-vm-cpu"></a> vmware-esx-soap-vm-cpu
4017 Check command object for the `check_vmware_esx` plugin. Shows all CPU usage info.
4019 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
4022 ------------------------|--------------
4023 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. Conflicts with **vmware_host**.
4024 vmware_host | **Optional.** ESX or ESXi hostname. Conflicts with **vmware_datacenter**.
4025 vmware_vmname | **Required.** Virtual machine name.
4026 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
4027 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
4028 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
4029 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
4030 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
4031 vmware_sessionfile | **Optional.** Session file name enhancement.
4032 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
4033 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
4034 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
4035 vmware_password | **Optional.** The username's password. No value defined as default.
4036 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
4040 #### <a id="plugin-contrib-vmware-esx-soap-vm-cpu-ready"></a> vmware-esx-soap-vm-cpu-ready
4042 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.
4044 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
4047 ------------------------|--------------
4048 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. Conflicts with **vmware_host**.
4049 vmware_host | **Optional.** ESX or ESXi hostname. Conflicts with **vmware_datacenter**.
4050 vmware_vmname | **Required.** Virtual machine name.
4051 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
4052 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
4053 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
4054 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
4055 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
4056 vmware_sessionfile | **Optional.** Session file name enhancement.
4057 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
4058 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
4059 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
4060 vmware_password | **Optional.** The username's password. No value defined as default.
4061 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
4062 vmware_warn | **Optional.** The warning threshold. No value defined as default.
4063 vmware_crit | **Optional.** The critical threshold. No value defined as default.
4066 #### <a id="plugin-contrib-vmware-esx-soap-vm-cpu-wait"></a> vmware-esx-soap-vm-cpu-wait
4068 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.
4070 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
4073 ------------------------|--------------
4074 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. Conflicts with **vmware_host**.
4075 vmware_host | **Optional.** ESX or ESXi hostname. Conflicts with **vmware_datacenter**.
4076 vmware_vmname | **Required.** Virtual machine name.
4077 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
4078 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
4079 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
4080 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
4081 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
4082 vmware_sessionfile | **Optional.** Session file name enhancement.
4083 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
4084 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
4085 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
4086 vmware_password | **Optional.** The username's password. No value defined as default.
4087 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
4088 vmware_warn | **Optional.** The warning threshold. No value defined as default.
4089 vmware_crit | **Optional.** The critical threshold. No value defined as default.
4092 #### <a id="plugin-contrib-vmware-esx-soap-vm-cpu-usage"></a> vmware-esx-soap-vm-cpu-usage
4094 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.
4096 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
4099 ------------------------|--------------
4100 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. Conflicts with **vmware_host**.
4101 vmware_host | **Optional.** ESX or ESXi hostname. Conflicts with **vmware_datacenter**.
4102 vmware_vmname | **Required.** Virtual machine name.
4103 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
4104 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
4105 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
4106 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
4107 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
4108 vmware_sessionfile | **Optional.** Session file name enhancement.
4109 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
4110 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
4111 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
4112 vmware_password | **Optional.** The username's password. No value defined as default.
4113 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
4114 vmware_warn | **Optional.** Warning threshold in percent. Defaults to "80%".
4115 vmware_crit | **Optional.** Critical threshold in percent. Defaults to "90%".
4118 #### <a id="plugin-contrib-vmware-esx-soap-vm-mem"></a> vmware-esx-soap-vm-mem
4120 Check command object for the `check_vmware_esx` plugin. Shows all memory info, except overall.
4122 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
4125 ------------------------|--------------
4126 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. Conflicts with **vmware_host**.
4127 vmware_host | **Optional.** ESX or ESXi hostname. Conflicts with **vmware_datacenter**.
4128 vmware_vmname | **Required.** Virtual machine name.
4129 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
4130 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
4131 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
4132 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
4133 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
4134 vmware_sessionfile | **Optional.** Session file name enhancement.
4135 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
4136 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
4137 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
4138 vmware_password | **Optional.** The username's password. No value defined as default.
4139 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
4142 #### <a id="plugin-contrib-vmware-esx-soap-vm-mem-usage"></a> vmware-esx-soap-vm-mem-usage
4144 Check command object for the `check_vmware_esx` plugin. Average mem usage in percentage of configured virtual machine "physical" memory.
4146 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
4149 ------------------------|--------------
4150 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. Conflicts with **vmware_host**.
4151 vmware_host | **Optional.** ESX or ESXi hostname. Conflicts with **vmware_datacenter**.
4152 vmware_vmname | **Required.** Virtual machine name.
4153 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
4154 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
4155 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
4156 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
4157 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
4158 vmware_sessionfile | **Optional.** Session file name enhancement.
4159 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
4160 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
4161 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
4162 vmware_password | **Optional.** The username's password. No value defined as default.
4163 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
4164 vmware_warn | **Optional.** Warning threshold in percent. Defaults to "80%".
4165 vmware_crit | **Optional.** Critical threshold in percent. Defaults to "90%".
4168 #### <a id="plugin-contrib-vmware-esx-soap-vm-mem-consumed"></a> vmware-esx-soap-vm-mem-consumed
4170 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>
4171 **vm consumed memory = memory granted -- memory saved**
4173 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
4176 ------------------------|--------------
4177 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. Conflicts with **vmware_host**.
4178 vmware_host | **Optional.** ESX or ESXi hostname. Conflicts with **vmware_datacenter**.
4179 vmware_vmname | **Required.** Virtual machine name.
4180 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
4181 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
4182 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
4183 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
4184 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
4185 vmware_sessionfile | **Optional.** Session file name enhancement.
4186 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
4187 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
4188 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
4189 vmware_password | **Optional.** The username's password. No value defined as default.
4190 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
4191 vmware_warn | **Optional.** The warning threshold. No value defined as default.
4192 vmware_crit | **Optional.** The critical threshold. No value defined as default.
4195 #### <a id="plugin-contrib-vmware-esx-soap-vm-mem-memctl"></a> vmware-esx-soap-vm-mem-memctl
4197 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.
4199 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
4202 ------------------------|--------------
4203 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. Conflicts with **vmware_host**.
4204 vmware_host | **Optional.** ESX or ESXi hostname. Conflicts with **vmware_datacenter**.
4205 vmware_vmname | **Required.** Virtual machine name.
4206 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
4207 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
4208 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
4209 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
4210 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
4211 vmware_sessionfile | **Optional.** Session file name enhancement.
4212 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
4213 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
4214 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
4215 vmware_password | **Optional.** The username's password. No value defined as default.
4216 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
4217 vmware_warn | **Optional.** The warning threshold. No value defined as default.
4218 vmware_crit | **Optional.** The critical threshold. No value defined as default.
4222 #### <a id="plugin-contrib-vmware-esx-soap-vm-net"></a> vmware-esx-soap-vm-net
4224 Check command object for the `check_vmware_esx` plugin. Shows net info.
4226 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
4229 ------------------------|--------------
4230 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. Conflicts with **vmware_host**.
4231 vmware_host | **Optional.** ESX or ESXi hostname. Conflicts with **vmware_datacenter**.
4232 vmware_vmname | **Required.** Virtual machine name.
4233 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
4234 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
4235 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
4236 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
4237 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
4238 vmware_sessionfile | **Optional.** Session file name enhancement.
4239 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
4240 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
4241 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
4242 vmware_password | **Optional.** The username's password. No value defined as default.
4243 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
4246 #### <a id="plugin-contrib-vmware-esx-soap-vm-net-usage"></a> vmware-esx-soap-vm-net-usage
4248 Check command object for the `check_vmware_esx` plugin. Overall network usage in KBps(Kilobytes per Second).
4250 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
4253 ------------------------|--------------
4254 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. Conflicts with **vmware_host**.
4255 vmware_host | **Optional.** ESX or ESXi hostname. Conflicts with **vmware_datacenter**.
4256 vmware_vmname | **Required.** Virtual machine name.
4257 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
4258 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
4259 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
4260 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
4261 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
4262 vmware_sessionfile | **Optional.** Session file name enhancement.
4263 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
4264 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
4265 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
4266 vmware_password | **Optional.** The username's password. No value defined as default.
4267 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
4268 vmware_warn | **Optional.** The warning threshold. No value defined as default.
4269 vmware_crit | **Optional.** The critical threshold. No value defined as default.
4272 #### <a id="plugin-contrib-vmware-esx-soap-vm-net-receive"></a> vmware-esx-soap-vm-net-receive
4274 Check command object for the `check_vmware_esx` plugin. Receive in KBps(Kilobytes per Second).
4276 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
4279 ------------------------|--------------
4280 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. Conflicts with **vmware_host**.
4281 vmware_host | **Optional.** ESX or ESXi hostname. Conflicts with **vmware_datacenter**.
4282 vmware_vmname | **Required.** Virtual machine name.
4283 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
4284 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
4285 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
4286 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
4287 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
4288 vmware_sessionfile | **Optional.** Session file name enhancement.
4289 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
4290 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
4291 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
4292 vmware_password | **Optional.** The username's password. No value defined as default.
4293 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
4294 vmware_warn | **Optional.** The warning threshold. No value defined as default.
4295 vmware_crit | **Optional.** The critical threshold. No value defined as default.
4298 #### <a id="plugin-contrib-vmware-esx-soap-vm-net-send"></a> vmware-esx-soap-vm-net-send
4300 Check command object for the `check_vmware_esx` plugin. Send in KBps(Kilobytes per Second).
4302 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
4305 ------------------------|--------------
4306 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. Conflicts with **vmware_host**.
4307 vmware_host | **Optional.** ESX or ESXi hostname. Conflicts with **vmware_datacenter**.
4308 vmware_vmname | **Required.** Virtual machine name.
4309 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
4310 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
4311 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
4312 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
4313 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
4314 vmware_sessionfile | **Optional.** Session file name enhancement.
4315 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
4316 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
4317 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
4318 vmware_password | **Optional.** The username's password. No value defined as default.
4319 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
4320 vmware_warn | **Optional.** The warning threshold. No value defined as default.
4321 vmware_crit | **Optional.** The critical threshold. No value defined as default.
4324 #### <a id="plugin-contrib-vmware-esx-soap-vm-io"></a> vmware-esx-soap-vm-io
4326 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.
4328 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
4331 ------------------------|--------------
4332 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. Conflicts with **vmware_host**.
4333 vmware_host | **Optional.** ESX or ESXi hostname. Conflicts with **vmware_datacenter**.
4334 vmware_vmname | **Required.** Virtual machine name.
4335 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
4336 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
4337 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
4338 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
4339 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
4340 vmware_sessionfile | **Optional.** Session file name enhancement.
4341 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
4342 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
4343 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
4344 vmware_password | **Optional.** The username's password. No value defined as default.
4345 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
4348 #### <a id="plugin-contrib-vmware-esx-soap-vm-io-read"></a> vmware-esx-soap-vm-io-read
4350 Check command object for the `check_vmware_esx` plugin. Average number of kilobytes read from the disk each second.
4352 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
4355 ------------------------|--------------
4356 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. Conflicts with **vmware_host**.
4357 vmware_host | **Optional.** ESX or ESXi hostname. Conflicts with **vmware_datacenter**.
4358 vmware_vmname | **Required.** Virtual machine name.
4359 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
4360 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
4361 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
4362 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
4363 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
4364 vmware_sessionfile | **Optional.** Session file name enhancement.
4365 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
4366 vmware_nosession | **Optional.** No auth session - IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
4367 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
4368 vmware_password | **Optional.** The username's password. No value defined as default.
4369 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
4370 vmware_warn | **Optional.** The warning threshold. No value defined as default.
4371 vmware_crit | **Optional.** The critical threshold. No value defined as default.
4374 #### <a id="plugin-contrib-vmware-esx-soap-vm-io-write"></a> vmware-esx-soap-vm-io-write
4376 Check command object for the `check_vmware_esx` plugin. Average number of kilobytes written to disk each second.
4378 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
4381 ------------------------|--------------
4382 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. Conflicts with **vmware_host**.
4383 vmware_host | **Optional.** ESX or ESXi hostname. Conflicts with **vmware_datacenter**.
4384 vmware_vmname | **Required.** Virtual machine name.
4385 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
4386 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
4387 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
4388 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
4389 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
4390 vmware_sessionfile | **Optional.** Session file name enhancement.
4391 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
4392 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
4393 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
4394 vmware_password | **Optional.** The username's password. No value defined as default.
4395 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
4396 vmware_warn | **Optional.** The warning threshold. No value defined as default.
4397 vmware_crit | **Optional.** The critical threshold. No value defined as default.
4400 #### <a id="plugin-contrib-vmware-esx-soap-vm-io-usage"></a> vmware-esx-soap-vm-io-usage
4402 Check command object for the `check_vmware_esx` plugin. Aggregated disk I/O rate.
4404 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
4407 ------------------------|--------------
4408 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. Conflicts with **vmware_host**.
4409 vmware_host | **Optional.** ESX or ESXi hostname. Conflicts with **vmware_datacenter**.
4410 vmware_vmname | **Required.** Virtual machine name.
4411 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
4412 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
4413 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
4414 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
4415 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
4416 vmware_sessionfile | **Optional.** Session file name enhancement.
4417 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
4418 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
4419 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
4420 vmware_password | **Optional.** The username's password. No value defined as default.
4421 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
4422 vmware_warn | **Optional.** The warning threshold. No value defined as default.
4423 vmware_crit | **Optional.** The critical threshold. No value defined as default.
4426 #### <a id="plugin-contrib-vmware-esx-soap-vm-runtime"></a> vmware-esx-soap-vm-runtime
4428 Check command object for the `check_vmware_esx` plugin. Shows virtual machine runtime info.
4430 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
4433 ------------------------|--------------
4434 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. Conflicts with **vmware_host**.
4435 vmware_host | **Optional.** ESX or ESXi hostname. Conflicts with **vmware_datacenter**.
4436 vmware_vmname | **Required.** Virtual machine name.
4437 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
4438 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
4439 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
4440 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
4441 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
4442 vmware_sessionfile | **Optional.** Session file name enhancement.
4443 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
4444 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
4445 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
4446 vmware_password | **Optional.** The username's password. No value defined as default.
4447 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
4450 #### <a id="plugin-contrib-vmware-esx-soap-vm-runtime-con"></a> vmware-esx-soap-vm-runtime-con
4452 Check command object for the `check_vmware_esx` plugin. Shows the connection state.
4454 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
4457 ------------------------|--------------
4458 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. Conflicts with **vmware_host**.
4459 vmware_host | **Optional.** ESX or ESXi hostname. Conflicts with **vmware_datacenter**.
4460 vmware_vmname | **Required.** Virtual machine name.
4461 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
4462 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
4463 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
4464 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
4465 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
4466 vmware_sessionfile | **Optional.** Session file name enhancement.
4467 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
4468 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
4469 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
4470 vmware_password | **Optional.** The username's password. No value defined as default.
4471 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
4474 #### <a id="plugin-contrib-vmware-esx-soap-vm-runtime-powerstate"></a> vmware-esx-soap-vm-runtime-powerstate
4476 Check command object for the `check_vmware_esx` plugin. Shows virtual machine power state: poweredOn, poweredOff or suspended.
4478 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
4481 ------------------------|--------------
4482 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. Conflicts with **vmware_host**.
4483 vmware_host | **Optional.** ESX or ESXi hostname. Conflicts with **vmware_datacenter**.
4484 vmware_vmname | **Required.** Virtual machine name.
4485 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
4486 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
4487 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
4488 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
4489 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
4490 vmware_sessionfile | **Optional.** Session file name enhancement.
4491 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
4492 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
4493 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
4494 vmware_password | **Optional.** The username's password. No value defined as default.
4495 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
4498 #### <a id="plugin-contrib-vmware-esx-soap-vm-runtime-status"></a> vmware-esx-soap-vm-runtime-status
4500 Check command object for the `check_vmware_esx` plugin. Overall object status (gray/green/red/yellow).
4502 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
4505 ------------------------|--------------
4506 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. Conflicts with **vmware_host**.
4507 vmware_host | **Optional.** ESX or ESXi hostname. Conflicts with **vmware_datacenter**.
4508 vmware_vmname | **Required.** Virtual machine name.
4509 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
4510 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
4511 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
4512 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
4513 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
4514 vmware_sessionfile | **Optional.** Session file name enhancement.
4515 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
4516 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
4517 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
4518 vmware_password | **Optional.** The username's password. No value defined as default.
4519 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
4522 #### <a id="plugin-contrib-vmware-esx-soap-vm-runtime-consoleconnections"></a> vmware-esx-soap-vm-runtime-consoleconnections
4524 Check command object for the `check_vmware_esx` plugin. Console connections to virtual machine.
4526 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
4529 ------------------------|--------------
4530 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. Conflicts with **vmware_host**.
4531 vmware_host | **Optional.** ESX or ESXi hostname. Conflicts with **vmware_datacenter**.
4532 vmware_vmname | **Required.** Virtual machine name.
4533 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
4534 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
4535 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
4536 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
4537 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
4538 vmware_sessionfile | **Optional.** Session file name enhancement.
4539 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
4540 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
4541 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
4542 vmware_password | **Optional.** The username's password. No value defined as default.
4543 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
4544 vmware_warn | **Optional.** The warning threshold. No value defined as default.
4545 vmware_crit | **Optional.** The critical threshold. No value defined as default.
4548 #### <a id="plugin-contrib-vmware-esx-soap-vm-runtime-gueststate"></a> vmware-esx-soap-vm-runtime-gueststate
4550 Check command object for the `check_vmware_esx` plugin. Guest OS status. Needs VMware Tools installed and running.
4552 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
4555 ------------------------|--------------
4556 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. Conflicts with **vmware_host**.
4557 vmware_host | **Optional.** ESX or ESXi hostname. Conflicts with **vmware_datacenter**.
4558 vmware_vmname | **Required.** Virtual machine name.
4559 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
4560 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
4561 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
4562 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
4563 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
4564 vmware_sessionfile | **Optional.** Session file name enhancement.
4565 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
4566 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
4567 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
4568 vmware_password | **Optional.** The username's password. No value defined as default.
4569 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
4571 #### <a id="plugin-contrib-vmware-esx-soap-vm-runtime-tools"></a> vmware-esx-soap-vm-runtime-tools
4573 Check command object for the `check_vmware_esx` plugin. Guest OS status. VMware tools status.
4575 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
4578 ------------------------|--------------
4579 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. Conflicts with **vmware_host**.
4580 vmware_host | **Optional.** ESX or ESXi hostname. Conflicts with **vmware_datacenter**.
4581 vmware_vmname | **Required.** Virtual machine name.
4582 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
4583 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
4584 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
4585 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
4586 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
4587 vmware_sessionfile | **Optional.** Session file name enhancement.
4588 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
4589 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
4590 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
4591 vmware_password | **Optional.** The username's password. No value defined as default.
4592 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
4593 vmware_openvmtools | **Optional** Prevent CRITICAL state for installed and running Open VM Tools.
4596 #### <a id="plugin-contrib-vmware-esx-soap-vm-runtime-issues"></a> vmware-esx-soap-vm-runtime-issues
4598 Check command object for the `check_vmware_esx` plugin. All issues for the virtual machine.
4600 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
4603 ------------------------|--------------
4604 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. Conflicts with **vmware_host**.
4605 vmware_host | **Optional.** ESX or ESXi hostname. Conflicts with **vmware_datacenter**.
4606 vmware_vmname | **Required.** Virtual machine name.
4607 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
4608 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
4609 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
4610 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
4611 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
4612 vmware_sessionfile | **Optional.** Session file name enhancement.
4613 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
4614 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
4615 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
4616 vmware_password | **Optional.** The username's password. No value defined as default.
4617 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
4618 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.