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-radius"></a> radius
1044 The [check_radius](https://www.monitoring-plugins.org/doc/man/check_radius.html) plugin
1045 checks a RADIUS server to see if it is accepting connections. The server to test
1046 must be specified in the invocation, as well as a user name and password. A configuration
1047 file may also be present. The format of the configuration file is described in the
1048 radiusclient library sources. The password option presents a substantial security
1049 issue because the password can possibly be determined by careful watching of the
1050 command line in a process listing. This risk is exacerbated because the plugin will
1051 typically be executed at regular predictable intervals. Please be sure that the
1052 password used does not allow access to sensitive system resources.
1055 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
1058 -------------------|--------------
1059 radius_address | **Optional.** The radius server's address. Defaults to "$address$" if the host's `address` attribute is set, "$address6$" otherwise.
1060 radius_config_file | **Required.** The radius configuration file.
1061 radius_username | **Required.** The radius username to test.
1062 radius_password | **Required.** The radius password to test.
1063 radius_port | **Optional.** The radius port number (default 1645).
1064 radius_nas_id | **Optional.** The NAS identifier.
1065 radius_nas_address | **Optional.** The NAS IP address.
1066 radius_expect | **Optional.** The response string to expect from the server.
1067 radius_retries | **Optional.** The number of times to retry a failed connection.
1068 radius_timeout | **Optional.** The number of seconds before connection times out (default: 10).
1071 ### <a id="plugin-check-command-simap"></a> simap
1073 The [check_simap](https://www.monitoring-plugins.org/doc/man/check_simap.html) plugin
1074 tests SIMAP connections with the specified host (or unix socket).
1076 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
1079 -----------------------|--------------
1080 simap_address | **Optional.** The host's address. Defaults to "$address$" if the host's `address` attribute is set, "$address6$" otherwise.
1081 simap_port | **Optional.** The port that should be checked. Defaults to 993.
1082 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.
1083 simap_send | **Optional.** String to send to the server.
1084 simap_expect | **Optional.** String to expect in server response. Multiple strings must be defined as array.
1085 simap_all | **Optional.** All expect strings need to occur in server response. Default is any.
1086 simap_quit | **Optional.** String to send server to initiate a clean close of the connection.
1087 simap_refuse | **Optional.** Accept TCP refusals with states ok, warn, crit (default: crit).
1088 simap_mismatch | **Optional.** Accept expected string mismatches with states ok, warn, crit (default: warn).
1089 simap_jail | **Optional.** Hide output from TCP socket.
1090 simap_maxbytes | **Optional.** Close connection once more than this number of bytes are received.
1091 simap_delay | **Optional.** Seconds to wait between sending string and polling for response.
1092 simap_certificate_age | **Optional.** Minimum number of days a certificate has to be valid.
1093 simap_ssl | **Optional.** Use SSL for the connection.
1094 simap_warning | **Optional.** Response time to result in warning status (seconds).
1095 simap_critical | **Optional.** Response time to result in critical status (seconds).
1096 simap_timeout | **Optional.** Seconds before connection times out (default: 10).
1097 simap_ipv4 | **Optional.** Use IPv4 connection. Defaults to false.
1098 simap_ipv6 | **Optional.** Use IPv6 connection. Defaults to false.
1100 ### <a id="plugin-check-command-smart"></a> smart
1102 The [check_ide_smart](https://www.monitoring-plugins.org/doc/man/check_ide_smart.html) plugin
1103 checks a local hard drive with the (Linux specific) SMART interface. Requires installation of `smartctl`.
1105 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
1108 ----------------|--------------
1109 smart_device | **Required.** The name of a local hard drive to monitor.
1112 ### <a id="plugin-check-command-smtp"></a> smtp
1114 The [check_smtp](https://www.monitoring-plugins.org/doc/man/check_smtp.html) plugin
1115 will attempt to open an SMTP connection with the host.
1117 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
1120 ----------------------|--------------
1121 smtp_address | **Optional.** The host's address. Defaults to "$address$" if the host's `address` attribute is set, "$address6$" otherwise.
1122 smtp_port | **Optional.** The port that should be checked. Defaults to 25.
1123 smtp_mail_from | **Optional.** Test a MAIL FROM command with the given email address.
1124 smtp_expect | **Optional.** String to expect in first line of server response (default: '220').
1125 smtp_command | **Optional.** SMTP command (may be used repeatedly).
1126 smtp_response | **Optional.** Expected response to command (may be used repeatedly).
1127 smtp_helo_fqdn | **Optional.** FQDN used for HELO
1128 smtp_certificate_age | **Optional.** Minimum number of days a certificate has to be valid.
1129 smtp_starttls | **Optional.** Use STARTTLS for the connection.
1130 smtp_authtype | **Optional.** SMTP AUTH type to check (default none, only LOGIN supported).
1131 smtp_authuser | **Optional.** SMTP AUTH username.
1132 smtp_authpass | **Optional.** SMTP AUTH password.
1133 smtp_ignore_quit | **Optional.** Ignore failure when sending QUIT command to server.
1134 smtp_warning | **Optional.** Response time to result in warning status (seconds).
1135 smtp_critical | **Optional.** Response time to result in critical status (seconds).
1136 smtp_timeout | **Optional.** Seconds before connection times out (default: 10).
1137 smtp_ipv4 | **Optional.** Use IPv4 connection. Defaults to false.
1138 smtp_ipv6 | **Optional.** Use IPv6 connection. Defaults to false.
1141 ### <a id="plugin-check-command-snmp"></a> snmp
1143 The [check_snmp](https://www.monitoring-plugins.org/doc/man/check_snmp.html) plugin
1144 checks the status of remote machines and obtains system information via SNMP.
1146 **Note**: This plugin uses the `snmpget` command included with the NET-SNMP package.
1148 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
1151 --------------------|--------------
1152 snmp_address | **Optional.** The host's address. Defaults to "$address$" if the host's `address` attribute is set, "$address6$" otherwise.
1153 snmp_oid | **Required.** The SNMP OID.
1154 snmp_community | **Optional.** The SNMP community. Defaults to "public".
1155 snmp_port | **Optional.** The SNMP port. Defaults to "161".
1156 snmp_retries | **Optional.** Number of retries to be used in the SNMP requests.
1157 snmp_warn | **Optional.** The warning threshold.
1158 snmp_crit | **Optional.** The critical threshold.
1159 snmp_string | **Optional.** Return OK state if the string matches exactly with the output value
1160 snmp_ereg | **Optional.** Return OK state if extended regular expression REGEX matches with the output value
1161 snmp_eregi | **Optional.** Return OK state if case-insensitive extended REGEX matches with the output value
1162 snmp_label | **Optional.** Prefix label for output value
1163 snmp_invert_search | **Optional.** Invert search result and return CRITICAL state if found
1164 snmp_units | **Optional.** Units label(s) for output value (e.g., 'sec.').
1165 snmp_version | **Optional.** Version to use. E.g. 1, 2, 2c or 3.
1166 snmp_miblist | **Optional.** MIB's to use, comma separated. Defaults to "ALL".
1167 snmp_rate_multiplier | **Optional.** Converts rate per second. For example, set to 60 to convert to per minute.
1168 snmp_rate | **Optional.** Boolean. Enable rate calculation.
1169 snmp_getnext | **Optional.** Boolean. Use SNMP GETNEXT. Defaults to false.
1170 snmp_timeout | **Optional.** The command timeout in seconds. Defaults to 10 seconds.
1172 ### <a id="plugin-check-command-snmpv3"></a> snmpv3
1174 Check command object for the [check_snmp](https://www.monitoring-plugins.org/doc/man/check_snmp.html)
1175 plugin, using SNMPv3 authentication and encryption options.
1177 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
1180 ---------------------|--------------
1181 snmpv3_address | **Optional.** The host's address. Defaults to "$address$" if the host's `address` attribute is set, "$address6$" otherwise.
1182 snmpv3_getnext | **Optional.** Use SNMP GETNEXT instead of SNMP GET.
1183 snmpv3_seclevel | **Optional.** The security level. Defaults to authPriv.
1184 snmpv3_auth_alg | **Optional.** The authentication algorithm. Defaults to SHA.
1185 snmpv3_user | **Required.** The username to log in with.
1186 snmpv3_auth_key | **Required,** The authentication key. Required if `snmpv3_seclevel` is set to `authPriv` otherwise optional.
1187 snmpv3_priv_key | **Required.** The encryption key.
1188 snmpv3_oid | **Required.** The SNMP OID.
1189 snmpv3_priv_alg | **Optional.** The encryption algorithm. Defaults to AES.
1190 snmpv3_warn | **Optional.** The warning threshold.
1191 snmpv3_crit | **Optional.** The critical threshold.
1192 snmpv3_string | **Optional.** Return OK state (for that OID) if STRING is an exact match.
1193 snmpv3_ereg | **Optional.** Return OK state (for that OID) if extended regular expression REGEX matches.
1194 snmpv3_eregi | **Optional.** Return OK state (for that OID) if case-insensitive extended REGEX matches.
1195 snmpv3_invert_search | **Optional.** Invert search result and return CRITICAL if found
1196 snmpv3_label | **Optional.** Prefix label for output value.
1197 snmpv3_units | **Optional.** Units label(s) for output value (e.g., 'sec.').
1198 snmpv3_rate_multiplier | **Optional.** Converts rate per second. For example, set to 60 to convert to per minute.
1199 snmpv3_rate | **Optional.** Boolean. Enable rate calculation.
1200 snmpv3_timeout | **Optional.** The command timeout in seconds. Defaults to 10 seconds.
1202 ### <a id="plugin-check-command-snmp-uptime"></a> snmp-uptime
1204 Check command object for the [check_snmp](https://www.monitoring-plugins.org/doc/man/check_snmp.html)
1205 plugin, using the uptime OID by default.
1207 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
1210 ----------------|--------------
1211 snmp_address | **Optional.** The host's address. Defaults to "$address$" if the host's `address` attribute is set, "$address6$" otherwise.
1212 snmp_oid | **Optional.** The SNMP OID. Defaults to "1.3.6.1.2.1.1.3.0".
1213 snmp_community | **Optional.** The SNMP community. Defaults to "public".
1216 ### <a id="plugin-check-command-spop"></a> spop
1218 The [check_spop](https://www.monitoring-plugins.org/doc/man/check_spop.html) plugin
1219 tests SPOP connections with the specified host (or unix socket).
1221 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
1224 ----------------------|--------------
1225 spop_address | **Optional.** The host's address. Defaults to "$address$" if the host's `address` attribute is set, "$address6$" otherwise.
1226 spop_port | **Optional.** The port that should be checked. Defaults to 995.
1227 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.
1228 spop_send | **Optional.** String to send to the server.
1229 spop_expect | **Optional.** String to expect in server response. Multiple strings must be defined as array.
1230 spop_all | **Optional.** All expect strings need to occur in server response. Default is any.
1231 spop_quit | **Optional.** String to send server to initiate a clean close of the connection.
1232 spop_refuse | **Optional.** Accept TCP refusals with states ok, warn, crit (default: crit).
1233 spop_mismatch | **Optional.** Accept expected string mismatches with states ok, warn, crit (default: warn).
1234 spop_jail | **Optional.** Hide output from TCP socket.
1235 spop_maxbytes | **Optional.** Close connection once more than this number of bytes are received.
1236 spop_delay | **Optional.** Seconds to wait between sending string and polling for response.
1237 spop_certificate_age | **Optional.** Minimum number of days a certificate has to be valid.
1238 spop_ssl | **Optional.** Use SSL for the connection.
1239 spop_warning | **Optional.** Response time to result in warning status (seconds).
1240 spop_critical | **Optional.** Response time to result in critical status (seconds).
1241 spop_timeout | **Optional.** Seconds before connection times out (default: 10).
1242 spop_ipv4 | **Optional.** Use IPv4 connection. Defaults to false.
1243 spop_ipv6 | **Optional.** Use IPv6 connection. Defaults to false.
1246 ### <a id="plugin-check-command-ssh"></a> ssh
1248 The [check_ssh](https://www.monitoring-plugins.org/doc/man/check_ssh.html) plugin
1249 connects to an SSH server at a specified host and port.
1251 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
1254 ----------------|--------------
1255 ssh_address | **Optional.** The host's address. Defaults to "$address$" if the host's `address` attribute is set, "$address6$" otherwise.
1256 ssh_port | **Optional.** The port that should be checked. Defaults to 22.
1257 ssh_timeout | **Optional.** Seconds before connection times out. Defaults to 10.
1258 ssh_ipv4 | **Optional.** Use IPv4 connection. Defaults to false.
1259 ssh_ipv6 | **Optional.** Use IPv6 connection. Defaults to false.
1262 ### <a id="plugin-check-command-ssl"></a> ssl
1264 Check command object for the [check_tcp](https://www.monitoring-plugins.org/doc/man/check_tcp.html) plugin,
1265 using ssl-related options.
1267 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
1270 ------------------------------|--------------
1271 ssl_address | **Optional.** The host's address. Defaults to "$address$" if the host's `address` attribute is set, "$address6$" otherwise.
1272 ssl_port | **Required.** The port that should be checked.
1273 ssl_timeout | **Optional.** Timeout in seconds for the connect and handshake. The plugin default is 10 seconds.
1274 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.
1275 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.
1278 ### <a id="plugin-check-command-ssmtp"></a> ssmtp
1280 The [check_ssmtp](https://www.monitoring-plugins.org/doc/man/check_ssmtp.html) plugin
1281 tests SSMTP connections with the specified host (or unix socket).
1283 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
1286 -----------------------|--------------
1287 ssmtp_address | **Optional.** The host's address. Defaults to "$address$" if the host's `address` attribute is set, "$address6$" otherwise.
1288 ssmtp_port | **Optional.** The port that should be checked. Defaults to 465.
1289 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.
1290 ssmtp_send | **Optional.** String to send to the server.
1291 ssmtp_expect | **Optional.** String to expect in server response. Multiple strings must be defined as array.
1292 ssmtp_all | **Optional.** All expect strings need to occur in server response. Default is any.
1293 ssmtp_quit | **Optional.** String to send server to initiate a clean close of the connection.
1294 ssmtp_refuse | **Optional.** Accept TCP refusals with states ok, warn, crit (default: crit).
1295 ssmtp_mismatch | **Optional.** Accept expected string mismatches with states ok, warn, crit (default: warn).
1296 ssmtp_jail | **Optional.** Hide output from TCP socket.
1297 ssmtp_maxbytes | **Optional.** Close connection once more than this number of bytes are received.
1298 ssmtp_delay | **Optional.** Seconds to wait between sending string and polling for response.
1299 ssmtp_certificate_age | **Optional.** Minimum number of days a certificate has to be valid.
1300 ssmtp_ssl | **Optional.** Use SSL for the connection.
1301 ssmtp_warning | **Optional.** Response time to result in warning status (seconds).
1302 ssmtp_critical | **Optional.** Response time to result in critical status (seconds).
1303 ssmtp_timeout | **Optional.** Seconds before connection times out (default: 10).
1304 ssmtp_ipv4 | **Optional.** Use IPv4 connection. Defaults to false.
1305 ssmtp_ipv6 | **Optional.** Use IPv6 connection. Defaults to false.
1308 ### <a id="plugin-check-command-swap"></a> swap
1310 The [check_swap](https://www.monitoring-plugins.org/doc/man/check_swap.html) plugin
1311 checks the swap space on a local machine.
1313 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
1316 ----------------|--------------
1317 swap_wfree | **Optional.** The free swap space warning threshold in % (enable `swap_integer` for number values). Defaults to `50%`.
1318 swap_cfree | **Optional.** The free swap space critical threshold in % (enable `swap_integer` for number values). Defaults to `25%`.
1319 swap_integer | **Optional.** Specifies whether the thresholds are passed as number or percent value. Defaults to false (percent values).
1320 swap_allswaps | **Optional.** Conduct comparisons for all swap partitions, one by one. Defaults to false.
1321 swap_noswap | **Optional.** Resulting state when there is no swap regardless of thresholds. Possible values are "ok", "warning", "critical", "unknown". Defaults to "critical".
1324 ### <a id="plugin-check-command-tcp"></a> tcp
1326 The [check_tcp](https://www.monitoring-plugins.org/doc/man/check_tcp.html) plugin
1327 tests TCP connections with the specified host (or unix socket).
1329 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
1332 ----------------|--------------
1333 tcp_address | **Optional.** The host's address. Defaults to "$address$" if the host's `address` attribute is set, "$address6$" otherwise.
1334 tcp_port | **Required.** The port that should be checked.
1335 tcp_expect | **Optional.** String to expect in server response. Multiple strings must be defined as array.
1336 tcp_all | **Optional.** All expect strings need to occur in server response. Defaults to false.
1337 tcp_escape_send | **Optional.** Enable usage of \\n, \\r, \\t or \\\\ in send string.
1338 tcp_send | **Optional.** String to send to the server.
1339 tcp_escape_quit | **Optional.** Enable usage of \\n, \\r, \\t or \\\\ in quit string.
1340 tcp_quit | **Optional.** String to send server to initiate a clean close of the connection.
1341 tcp_refuse | **Optional.** Accept TCP refusals with states ok, warn, crit. Defaults to crit.
1342 tcp_mismatch | **Optional.** Accept expected string mismatches with states ok, warn, crit. Defaults to warn.
1343 tcp_jail | **Optional.** Hide output from TCP socket.
1344 tcp_maxbytes | **Optional.** Close connection once more than this number of bytes are received.
1345 tcp_delay | **Optional.** Seconds to wait between sending string and polling for response.
1346 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.
1347 tcp_ssl | **Optional.** Use SSL for the connection. Defaults to false.
1348 tcp_wtime | **Optional.** Response time to result in warning status (seconds).
1349 tcp_ctime | **Optional.** Response time to result in critical status (seconds).
1350 tcp_timeout | **Optional.** Seconds before connection times out. Defaults to 10.
1351 tcp_ipv4 | **Optional.** Use IPv4 connection. Defaults to false.
1352 tcp_ipv6 | **Optional.** Use IPv6 connection. Defaults to false.
1355 ### <a id="plugin-check-command-udp"></a> udp
1357 The [check_udp](https://www.monitoring-plugins.org/doc/man/check_udp.html) plugin
1358 tests UDP connections with the specified host (or unix socket).
1360 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
1363 ----------------|--------------
1364 udp_address | **Optional.** The host's address. Defaults to "$address$" if the host's `address` attribute is set, "$address6$" otherwise.
1365 udp_port | **Required.** The port that should be checked.
1366 udp_send | **Required.** The payload to send in the UDP datagram.
1367 udp_expect | **Required.** The payload to expect in the response datagram.
1368 udp_quit | **Optional.** The payload to send to 'close' the session.
1369 udp_ipv4 | **Optional.** Use IPv4 connection. Defaults to false.
1370 udp_ipv6 | **Optional.** Use IPv6 connection. Defaults to false.
1373 ### <a id="plugin-check-command-ups"></a> ups
1375 The [check_ups](https://www.monitoring-plugins.org/doc/man/check_ups.html) plugin
1376 tests the UPS service on the specified host. [Network UPS Tools](http://www.networkupstools.org)
1377 must be running for this plugin to work.
1379 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
1382 ----------------|--------------
1383 ups_address | **Required.** The address of the host running upsd. Defaults to "$address$" if the host's `address` attribute is set, "$address6$" otherwise.
1384 ups_name | **Required.** The UPS name. Defaults to `ups`.
1385 ups_port | **Optional.** The port to which to connect. Defaults to 3493.
1386 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`.
1387 ups_warning | **Optional.** The warning threshold for the selected variable.
1388 ups_critical | **Optional.** The critical threshold for the selected variable.
1389 ups_celsius | **Optional.** Display the temperature in degrees Celsius instead of Fahrenheit. Defaults to `false`.
1390 ups_timeout | **Optional.** The number of seconds before the connection times out. Defaults to 10.
1393 ### <a id="plugin-check-command-users"></a> users
1395 The [check_users](https://www.monitoring-plugins.org/doc/man/check_users.html) plugin
1396 checks the number of users currently logged in on the local system and generates an
1397 error if the number exceeds the thresholds specified.
1399 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
1402 ----------------|--------------
1403 users_wgreater | **Optional.** The user count warning threshold. Defaults to 20.
1404 users_cgreater | **Optional.** The user count critical threshold. Defaults to 50.
1406 ## <a id="windows-plugins"></a> Windows Plugins for Icinga 2
1408 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.
1410 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:
1412 include <windows-plugins>
1414 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.
1417 ### <a id="windows-plugins-thresholds"></a> Threshold syntax
1419 So not specified differently the thresholds for the plugins all follow the same pattern
1422 :------------|:----------
1423 "29" | The threshold is 29.
1424 "!29" | The threshold is 29, but the negative of the result is returned.
1425 "[10-40]" | The threshold is a range from (including) 20 to 40, a value inside means the threshold has been exceeded.
1426 "![10-40]" | Same as above, but the result is inverted.
1429 ### <a id="windows-plugins-disk-windows"></a> disk-windows
1431 Check command object for the `check_disk.exe` plugin.
1432 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.).
1437 :-------------------|:------------
1438 disk\_win\_warn | **Optional**. The warning threshold.
1439 disk\_win\_crit | **Optional**. The critical threshold.
1440 disk\_win\_path | **Optional**. Check only these paths, default checks all.
1441 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.
1442 disk\_win\_exclude | **Optional**. Exclude these drives from check.
1444 ### <a id="windows-plugins-load-windows"></a> load-windows
1446 Check command object for the `check_load.exe` plugin.
1447 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).
1452 :---------------|:------------
1453 load\_win\_warn | **Optional**. The warning threshold.
1454 load\_win\_crit | **Optional**. The critical threshold.
1457 ### <a id="windows-plugins-memory-windows"></a> memory-windows
1459 Check command object for the `check_memory.exe` plugin.
1460 The memory collection is instant.
1464 > Percentage based thresholds can be used by adding a '%' to the threshold
1465 > value. Keep in mind that memory\_win\_unit is applied before the
1466 > value is calculated.
1471 :-----------------|:------------
1472 memory\_win\_warn | **Optional**. The warning threshold.
1473 memory\_win\_crit | **Optional**. The critical threshold.
1474 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.
1477 ### <a id="windows-plugins-network-windows"></a> network-windows
1479 Check command object for the `check_network.exe` plugin.
1480 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).
1485 :-------------------|:------------
1486 network\_win\_warn | **Optional**. The warning threshold.
1487 network\_win\_crit | **Optional**. The critical threshold.
1488 network\_no\_isatap | **Optional**. Do not print ISATAP interfaces.
1491 ### <a id="windows-plugins-perfmon-windows"></a> perfmon-windows
1493 Check command object for the `check_perfmon.exe` plugin.
1494 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`.
1496 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"`
1501 :---------------------|:------------
1502 perfmon\_win\_warn | **Optional**. The warning threshold.
1503 perfmon\_win\_crit | **Optional**. The critical threshold.
1504 perfmon\_win\_counter | **Required**. The Performance Counter to use. Ex. `\Processor(_Total)\% Idle Time`.
1505 perfmon\_win\_wait | **Optional**. Time in milliseconds to wait between data collection (default: 1000).
1506 perfmon\_win\_type | **Optional**. Format in which to expect perfomance values. Possible are: long, int64 and double (default).
1509 ### <a id="windows-plugins-ping-windows"></a> ping-windows
1511 Check command object for the `check_ping.exe` plugin.
1512 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.
1517 :------------------|:------------
1518 ping\_win\_warn | **Optional**. The warning threshold. RTA and package loss separated by comma.
1519 ping\_win\_crit | **Optional**. The critical threshold. RTA and package loss separated by comma.
1520 ping\_win\_address | **Required**. An IPv4 or IPv6 address
1521 ping\_win\_packets | **Optional**. Number of packages to send. Default: 5.
1522 ping\_win\_timeout | **Optional**. The timeout in milliseconds. Default: 1000
1525 ### <a id="windows-plugins-procs-windows"></a> procs-windows
1527 Check command object for `check_procs.exe` plugin.
1528 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.
1533 :----------------|:------------
1534 procs\_win\_warn | **Optional**. The warning threshold.
1535 procs\_win\_crit | **Optional**. The critical threshold.
1536 procs\_win\_user | **Optional**. Count this useres processes.
1539 ### <a id="windows-plugins-service-windows"></a> service-windows
1541 Check command object for `check_service.exe` plugin.
1542 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.
1547 :---------------------|:------------
1548 service\_win\_warn | **Optional**. Warn when service is not running.
1549 service\_win\_service | **Required**. The critical threshold.
1552 ### <a id="windows-plugins-swap-windows"></a> swap-windows
1554 Check command object for `check_swap.exe` plugin.
1555 The data collection is instant.
1560 :---------------|:------------
1561 swap\_win\_warn | **Optional**. The warning threshold.
1562 swap\_win\_crit | **Optional**. The critical threshold.
1563 swap\_win\_unit | **Optional**. The unit to display the received value in, thresholds are interpreted in this unit. Defaults to "mb" (megabyte).
1566 ### <a id="windows-plugins-update-windows"></a> update-windows
1568 Check command object for `check_update.exe` plugin.
1569 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.
1573 > The Network Services Account which runs Icinga 2 by default does not have the required
1574 > permissions to run this check.
1579 :-------------------|:------------
1580 update\_win\_warn | If set, returns warning when important updates are available
1581 update\_win\_crit | If set, return critical when important updates that require a reboot are available.
1582 update\_win\_reboot | Set to treat 'may need update' as 'definitely needs update'
1585 ### <a id="windows-plugins-uptime-windows"></a> uptime-windows
1587 Check command opject for `check_uptime.exe` plugin.
1588 Uses GetTickCount64 to get the uptime, so boot time is not included.
1593 :-----------------|:------------
1594 uptime\_win\_warn | **Optional**. The warning threshold.
1595 uptime\_win\_crit | **Optional**. The critical threshold.
1596 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).
1599 ### <a id="windows-plugins-users-windows"></a> users-windows
1601 Check command object for `check_users.exe` plugin.
1606 :----------------|:------------
1607 users\_win\_warn | **Optional**. The warning threshold.
1608 users\_win\_crit | **Optional**. The critical threshold.
1611 ## <a id="nscp-plugin-check-commands"></a> Plugin Check Commands for NSClient++
1613 Icinga 2 can use the `nscp client` command to run arbitrary NSClient++ checks.
1615 You can enable these check commands by adding the following the include directive in your
1616 [icinga2.conf](4-configuring-icinga-2.md#icinga2-conf) configuration file:
1620 You can also optionally specify an alternative installation directory for NSClient++ by adding
1621 the NscpPath constant in your [constants.conf](4-configuring-icinga-2.md#constants-conf) configuration
1624 const NscpPath = "C:\\Program Files (x86)\\NSClient++"
1626 By default Icinga 2 uses the Microsoft Installer API to determine where NSClient++ is installed. It should
1627 not be necessary to manually set this constant.
1629 Note that it is not necessary to run NSClient++ as a Windows service for these commands to work.
1631 ### <a id="nscp-check-local"></a> nscp-local
1633 Check command object for NSClient++
1635 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
1638 ----------------|--------------
1639 nscp_log_level | **Optional.** The log level. Defaults to "critical".
1640 nscp_load_all | **Optional.** Whether to load all modules. Defaults to false.
1641 nscp_modules | **Optional.** An array of NSClient++ modules to load. Defaults to `[ "CheckSystem" ]`.
1642 nscp_boot | **Optional.** Whether to use the --boot option. Defaults to true.
1643 nscp_query | **Required.** The NSClient++ query. Try `nscp client -q x` for a list.
1644 nscp_arguments | **Optional.** An array of query arguments.
1645 nscp_showall | **Optional.** Shows more details in plugin output, default to false.
1647 ### <a id="nscp-check-local-cpu"></a> nscp-local-cpu
1649 Check command object for the `check_cpu` NSClient++ plugin.
1652 --------------------|------------------
1653 nscp_cpu_time | **Optional.** Calculate avarage usage for the given time intervals. Value has to be an array, default to [ "1m", "5m", "15m" ].
1654 nscp_cpu_warning | **Optional.** Threshold for WARNING state in percent, default to 80.
1655 nscp_cpu_critical | **Optional.** Threshold for CRITICAL state in percent, default to 90.
1656 nscp_cpu_arguments | **Optional.** Additional arguments.
1657 nscp_cpu_showall | **Optional.** Shows more details in plugin output, default to false.
1659 ### <a id="nscp-check-local-memory"></a> nscp-local-memory
1661 Check command object for the `check_memory` NSClient++ plugin.
1664 ----------------------|------------------
1665 nscp_memory_committed | **Optional.** Check for committed memory, default to false.
1666 nscp_memory_physical | **Optional.** Check for physical memory, default to true.
1667 nscp_memory_free | **Optional.** Switch between checking free (true) or used memory (false), default to false.
1668 nscp_memory_warning | **Optional.** Threshold for WARNING state in percent or absolut (use MB, GB, ...), default to 80 (free=false) or 20 (free=true).
1669 nscp_memory_critical | **Optional.** Threshold for CRITICAL state in percent or absolut (use MB, GB, ...), default to 90 (free=false) or 10 (free=true).
1670 nscp_memory_arguments | **Optional.** Additional arguments.
1671 nscp_memory_showall | **Optional.** Shows more details in plugin output, default to false.
1673 ### <a id="nscp-check-local-os-version"></a> nscp-local-os-version
1675 Check command object for the `check_os_version` NSClient++ plugin.
1677 This command has the same custom attributes like the `nscp-local` check command.
1679 ### <a id="nscp-check-local-pagefile"></a> nscp-local-pagefile
1681 Check command object for the `check_pagefile` NSClient++ plugin.
1683 This command has the same custom attributes like the `nscp-local` check command.
1685 ### <a id="nscp-check-local-process"></a> nscp-local-process
1687 Check command object for the `check_process` NSClient++ plugin.
1689 This command has the same custom attributes like the `nscp-local` check command.
1691 ### <a id="nscp-check-local-service"></a> nscp-local-service
1693 Check command object for the `check_service` NSClient++ plugin.
1696 -----------------------|------------------
1697 nscp_service_name | **Required.** Name of service to check.
1698 nscp_service_type | **Optional.** Type to check, default to state.
1699 nscp_service_ok | **Optional.** State for return an OK, i.e. for type=state running, stopped, ...
1700 nscp_service_otype | **Optional.** Dedicate type for nscp_service_ok, default to nscp_service_state.
1701 nscp_service_warning | **Optional.** State for return an WARNING.
1702 nscp_service_wtype | **Optional.** Dedicate type for nscp_service_warning, default to nscp_service_state.
1703 nscp_service_critical | **Optional.** State for return an CRITICAL.
1704 nscp_service_ctype | **Optional.** Dedicate type for nscp_service_critical, default to nscp_service_state.
1705 nscp_service_arguments | **Optional.** Additional arguments.
1706 nscp_service_showall | **Optional.** Shows more details in plugin output, default to true.
1708 ### <a id="nscp-check-local-uptime"></a> nscp-local-uptime
1710 Check command object for the `check_uptime` NSClient++ plugin.
1712 This command has the same custom attributes like the `nscp-local` check command.
1714 ### <a id="nscp-check-local-version"></a> nscp-local-version
1716 Check command object for the `check_version` NSClient++ plugin.
1718 This command has the same custom attributes like the `nscp-local` check command.
1719 In addition to that the default value for `nscp_modules` is set to `[ "CheckHelpers" ]`.
1721 ### <a id="nscp-check-local-disk"></a> nscp-local-disk
1723 Check command object for the `check_drivesize` NSClient++ plugin.
1726 -----------------------|------------------
1727 nscp_disk_drive | **Optional.** Drive character, default to all drives.
1728 nscp_disk_free | **Optional.** Switch between checking free space (free=true) or used space (free=false), default to false.
1729 nscp_disk_warning | **Optional.** Threshold for WARNING in percent or absolut (use MB, GB, ...), default to 80 (used) or 20 percent (free).
1730 nscp_disk_critical | **Optional.** Threshold for CRITICAL in percent or absolut (use MB, GB, ...), default to 90 (used) or 10 percent (free).
1731 nscp_disk_arguments | **Optional.** Additional arguments.
1732 nscp_disk_showall | **Optional.** Shows more details in plugin output, default to true.
1733 nscp_modules | **Optional.** An array of NSClient++ modules to load. Defaults to `[ "CheckDisk" ]`.
1735 ### <a id="nscp-check-local-counter"></a> nscp-local-counter
1737 Check command object for the `check_pdh` NSClient++ plugin.
1740 -----------------------|------------------
1741 nscp_counter_name | **Required.** Performance counter name.
1742 nscp_counter_warning | **Optional.** WARNING Threshold.
1743 nscp_counter_critical | **Optional.** CRITICAL Threshold.
1744 nscp_counter_arguments | **Optional.** Additional arguments.
1745 nscp_counter_showall | **Optional.** Shows more details in plugin output, default to false.
1746 nscp_counter_perfsyntax | **Optional.** Apply performance data label, e.g. `Total Processor Time` to avoid special character problems. Defaults to `nscp_counter_name`.
1750 ## <a id="snmp-manubulon-plugin-check-commands"></a> Plugin Check Commands for Manubulon SNMP
1752 The `SNMP Manubulon Plugin Check Commands` provide configuration for plugin check
1753 commands provided by the [SNMP Manubulon project](http://nagios.manubulon.com/index_snmp.html).
1755 **Note:** Some plugin parameters are only available in Debian packages or in a
1756 [forked repository](https://github.com/dnsmichi/manubulon-snmp) with patches applied.
1758 The SNMP manubulon plugin check commands assume that the global constant named `ManubulonPluginDir`
1759 is set to the path where the Manubublon SNMP plugins are installed.
1761 You can enable these plugin check commands by adding the following the include directive in your
1762 [icinga2.conf](4-configuring-icinga-2.md#icinga2-conf) configuration file:
1766 ### Checks by Host Type
1768 **N/A** : Not available for this type.
1770 **SNMP** : Available for simple SNMP query.
1774 **Specific** : Script name for platform specific checks.
1777 Host type | Interface | storage | load/cpu | mem | process | env | specific
1778 ------------------------|------------|----------|-----------|-----|----------|-----|-------------------------
1779 Linux | Yes | Yes | Yes | Yes | Yes | No |
1780 Windows | Yes | Yes | Yes | Yes | Yes | No | check_snmp_win.pl
1781 Cisco router/switch | Yes | N/A | Yes | Yes | N/A | Yes |
1782 HP router/switch | Yes | N/A | Yes | Yes | N/A | No |
1783 Bluecoat proxy | Yes | SNMP | Yes | SNMP| No | Yes |
1784 CheckPoint on SPLAT | Yes | Yes | Yes | Yes | Yes | No | check_snmp_cpfw.pl
1785 CheckPoint on Nokia IP | Yes | Yes | Yes | No | ?? | No | check_snmp_vrrp.pl
1786 Boostedge | Yes | Yes | Yes | Yes | ?? | No | check_snmp_boostedge.pl
1787 AS400 | Yes | Yes | Yes | Yes | No | No |
1788 NetsecureOne Netbox | Yes | Yes | Yes | ?? | Yes | No |
1789 Radware Linkproof | Yes | N/A | SNMP | SNMP| No | No | check_snmp_linkproof_nhr <br> check_snmp_vrrp.pl
1790 IronPort | Yes | SNMP | SNMP | SNMP| No | Yes |
1791 Cisco CSS | Yes | ?? | Yes | Yes | No | ?? | check_snmp_css.pl
1794 ### <a id="plugin-check-command-snmp-load"></a> snmp-load
1796 Check command object for the [check_snmp_load.pl](http://nagios.manubulon.com/snmp_load.html) plugin.
1798 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
1802 ------------------------|--------------
1803 snmp_address | **Optional.** The host's address. Defaults to "$address$" if the host's `address` attribute is set, "$address6$" otherwise.
1804 snmp_nocrypt | **Optional.** Define SNMP encryption. If set, **snmp_v3** needs to be set. Defaults to false.
1805 snmp_community | **Optional.** The SNMP community. Defaults to "public".
1806 snmp_port | **Optional.** The SNMP port connection.
1807 snmp_v2 | **Optional.** SNMP version to 2c. Defaults to false.
1808 snmp_v3 | **Optional.** SNMP version to 3. Defaults to false.
1809 snmp_login | **Optional.** SNMP version 3 username. Defaults to "snmpuser".
1810 snmp_password | **Required.** SNMP version 3 password. No value defined as default.
1811 snmp_v3_use_privpass | **Optional.** Define to use SNMP version 3 priv password. Defaults to false.
1812 snmp_authprotocol | **Optional.** SNMP version 3 authentication protocol. Defaults to "md5,des".
1813 snmp_privpass | **Required.** SNMP version 3 priv password. No value defined as default.
1814 snmp_warn | **Optional.** The warning threshold. Change the `snmp_load_type` var to "netsl" for using 3 values.
1815 snmp_crit | **Optional.** The critical threshold. Change the `snmp_load_type` var to "netsl" for using 3 values.
1816 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.
1817 snmp_perf | **Optional.** Enable perfdata values. Defaults to true.
1818 snmp_timeout | **Optional.** The command timeout in seconds. Defaults to 5 seconds.
1820 ### <a id="plugin-check-command-snmp-memory"></a> snmp-memory
1822 Check command object for the [check_snmp_mem.pl](http://nagios.manubulon.com/snmp_mem.html) plugin.
1824 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
1827 ------------------------|--------------
1828 snmp_address | **Optional.** The host's address. Defaults to "$address$" if the host's `address` attribute is set, "$address6$" otherwise.
1829 snmp_nocrypt | **Optional.** Define SNMP encryption. If set, **snmp_v3** needs to be set. Defaults to false.
1830 snmp_community | **Optional.** The SNMP community. Defaults to "public".
1831 snmp_port | **Optional.** The SNMP port connection.
1832 snmp_v2 | **Optional.** SNMP version to 2c. Defaults to false.
1833 snmp_v3 | **Optional.** SNMP version to 3. Defaults to false.
1834 snmp_login | **Optional.** SNMP version 3 username. Defaults to "snmpuser".
1835 snmp_password | **Required.** SNMP version 3 password. No value defined as default.
1836 snmp_v3_use_privpass | **Optional.** Define to use SNMP version 3 priv password. Defaults to false.
1837 snmp_authprotocol | **Optional.** SNMP version 3 authentication protocol. Defaults to "md5,des".
1838 snmp_privpass | **Required.** SNMP version 3 priv password. No value defined as default.
1839 snmp_warn | **Optional.** The warning threshold.
1840 snmp_crit | **Optional.** The critical threshold.
1841 snmp_is_cisco | **Optional.** Change OIDs for Cisco switches. Defaults to false.
1842 snmp_is_hp | **Optional.** Change OIDs for HP/Procurve switches. Defaults to false.
1843 snmp_perf | **Optional.** Enable perfdata values. Defaults to true.
1844 snmp_timeout | **Optional.** The command timeout in seconds. Defaults to 5 seconds.
1846 ### <a id="plugin-check-command-snmp-storage"></a> snmp-storage
1848 Check command object for the [check_snmp_storage.pl](http://nagios.manubulon.com/snmp_storage.html) plugin.
1850 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
1853 ------------------------|--------------
1854 snmp_address | **Optional.** The host's address. Defaults to "$address$" if the host's `address` attribute is set, "$address6$" otherwise.
1855 snmp_nocrypt | **Optional.** Define SNMP encryption. If set, **snmp_v3** needs to be set. Defaults to false.
1856 snmp_community | **Optional.** The SNMP community. Defaults to "public".
1857 snmp_port | **Optional.** The SNMP port connection.
1858 snmp_v2 | **Optional.** SNMP version to 2c. Defaults to false.
1859 snmp_v3 | **Optional.** SNMP version to 3. Defaults to false.
1860 snmp_login | **Optional.** SNMP version 3 username. Defaults to "snmpuser".
1861 snmp_password | **Required.** SNMP version 3 password. No value defined as default.
1862 snmp_v3_use_privpass | **Optional.** Define to use SNMP version 3 priv password. Defaults to false.
1863 snmp_authprotocol | **Optional.** SNMP version 3 authentication protocol. Defaults to "md5,des".
1864 snmp_privpass | **Required.** SNMP version 3 priv password. No value defined as default.
1865 snmp_warn | **Optional.** The warning threshold.
1866 snmp_crit | **Optional.** The critical threshold.
1867 snmp_storage_name | **Optional.** Storage name. Default to regex "^/$$". More options available in the [snmp storage](http://nagios.manubulon.com/snmp_storage.html) documentation.
1868 snmp_perf | **Optional.** Enable perfdata values. Defaults to true.
1869 snmp_timeout | **Optional.** The command timeout in seconds. Defaults to 5 seconds.
1871 ### <a id="plugin-check-command-snmp-interface"></a> snmp-interface
1873 Check command object for the [check_snmp_int.pl](http://nagios.manubulon.com/snmp_int.html) plugin.
1875 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
1878 ----------------------------|--------------
1879 snmp_address | **Optional.** The host's address. Defaults to "$address$" if the host's `address` attribute is set, "$address6$" otherwise.
1880 snmp_nocrypt | **Optional.** Define SNMP encryption. If set, **snmp_v3** needs to be set. Defaults to false.
1881 snmp_community | **Optional.** The SNMP community. Defaults to "public".
1882 snmp_port | **Optional.** The SNMP port connection.
1883 snmp_v2 | **Optional.** SNMP version to 2c. Defaults to false.
1884 snmp_v3 | **Optional.** SNMP version to 3. Defaults to false.
1885 snmp_login | **Optional.** SNMP version 3 username. Defaults to "snmpuser".
1886 snmp_password | **Required.** SNMP version 3 password. No value defined as default.
1887 snmp_v3_use_privpass | **Optional.** Define to use SNMP version 3 priv password. Defaults to false.
1888 snmp_authprotocol | **Optional.** SNMP version 3 authentication protocol. Defaults to "md5,des".
1889 snmp_privpass | **Required.** SNMP version 3 priv password. No value defined as default.
1890 snmp_warn | **Optional.** The warning threshold.
1891 snmp_crit | **Optional.** The critical threshold.
1892 snmp_interface | **Optional.** Network interface name. Default to regex "eth0".
1893 snmp_interface_perf | **Optional.** Check the input/ouput bandwidth of the interface. Defaults to true.
1894 snmp_interface_label | **Optional.** Add label before speed in output: in=, out=, errors-out=, etc.
1895 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.
1896 snmp_interface_percent | **Optional.** Output performance data in % of max speed. Defaults to false.
1897 snmp_interface_kbits | **Optional.** Make the warning and critical levels in KBits/s. Defaults to true.
1898 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.
1899 snmp_interface_64bit | **Optional.** Use 64 bits counters instead of the standard counters when checking bandwidth & performance data for interface >= 1Gbps. Defaults to false.
1900 snmp_interface_errors | **Optional.** Add error & discard to Perfparse output. Defaults to true.
1901 snmp_interface_noregexp | **Optional.** Do not use regexp to match interface name in description OID. Defaults to false.
1902 snmp_interface_delta | **Optional.** Delta time of perfcheck. Defaults to "300" (5 min).
1903 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.
1904 snmp_interface_ifname | **Optional.** Switch from IF-MIB::ifDescr to IF-MIB::ifName when looking up the interface's name
1905 snmp_perf | **Optional.** Enable perfdata values. Defaults to true.
1906 snmp_timeout | **Optional.** The command timeout in seconds. Defaults to 5 seconds.
1908 ### <a id="plugin-check-command-snmp-process"></a> snmp-process
1910 Check command object for the [check_snmp_process.pl](http://nagios.manubulon.com/snmp_process.html) plugin.
1912 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
1915 ------------------------|--------------
1916 snmp_address | **Optional.** The host's address. Defaults to "$address$" if the host's `address` attribute is set, "$address6$" otherwise.
1917 snmp_nocrypt | **Optional.** Define SNMP encryption. If set, **snmp_v3** needs to be set. Defaults to false.
1918 snmp_community | **Optional.** The SNMP community. Defaults to "public".
1919 snmp_port | **Optional.** The SNMP port connection.
1920 snmp_v2 | **Optional.** SNMP version to 2c. Defaults to false.
1921 snmp_v3 | **Optional.** SNMP version to 3. Defaults to false.
1922 snmp_login | **Optional.** SNMP version 3 username. Defaults to "snmpuser".
1923 snmp_password | **Required.** SNMP version 3 password. No value defined as default.
1924 snmp_v3_use_privpass | **Optional.** Define to use SNMP version 3 priv password. Defaults to false.
1925 snmp_authprotocol | **Optional.** SNMP version 3 authentication protocol. Defaults to "md5,des".
1926 snmp_privpass | **Required.** SNMP version 3 priv password. No value defined as default..
1927 snmp_warn | **Optional.** The warning threshold.
1928 snmp_crit | **Optional.** The critical threshold.
1929 snmp_process_name | **Optional.** Name of the process (regexp). No trailing slash!. Defaults to ".*".
1930 snmp_perf | **Optional.** Enable perfdata values. Defaults to true.
1931 snmp_timeout | **Optional.** The command timeout in seconds. Defaults to 5 seconds.
1932 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.
1936 ## <a id="plugin-contrib"></a> Contributed Plugin Check Commands
1938 The contributed Plugin Check Commands provides various additional command definitions
1939 contributed by community members.
1941 These check commands assume that the global constant named `PluginContribDir`
1942 is set to the path where the user installs custom plugins and can be enabled by
1943 uncommenting the corresponding line in [icinga2.conf](4-configuring-icinga-2.md#icinga2-conf):
1945 include <plugin-contrib>
1947 ### <a id="plugin-contrib-databases"></a> Databases
1949 All database plugins go in this category.
1951 #### <a id="plugin-contrib-command-db2_health"></a> db2_health
1953 The plugin `db2_health` utilises Perl DBD::DB2.
1954 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).
1956 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
1959 ---------------------------------|------------------------------------------------------------------------------------------------------------------------------
1960 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)
1961 db2_health_username | **Optional.** The username for the database connection.
1962 db2_health_password | **Optional.** The password for the database connection.
1963 db2_health_port | **Optional.** The port where DB2 is listening.
1964 db2_health_warning | **Optional.** The warning threshold depending on the mode.
1965 db2_health_critical | **Optional.** The critical threshold depending on the mode.
1966 db2_health_mode | **Required.** The mode uses predefined keywords for the different checks. For example "connection-time", "database-usage" or "sql".
1967 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).
1968 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.
1969 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.
1970 db2_health_regexp | **Optional.** If set to true, "db2_health_name" will be interpreted as a regular expression. Defaults to false.
1971 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".
1972 db2_health_maxinactivity | **Optional.** Used for the maximum amount of time a certain event has not happened.
1973 db2_health_mitigation | **Optional.** Classifies the severity of an offline tablespace.
1974 db2_health_lookback | **Optional.** How many days in the past db2_health check should look back to calculate exitcode.
1975 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".
1976 db2_health_env_db2_version | **Optional.** Specifies the DB2 version as environment variable `DB2_VERSION`.
1978 #### <a id="plugin-contrib-command-mssql_health"></a> mssql_health
1980 The plugin `mssql_health` utilises Perl DBD::Sybase based on FreeTDS to connect to MSSQL databases for monitoring.
1981 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).
1983 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
1986 ---------------------------------|------------------------------------------------------------------------------------------------------------------------------
1987 mssql_health_hostname | **Optional.** Specifies the database hostname or address. No default because you typically use "mssql_health_server".
1988 mssql_health_port | **Optional.** Specifies the database port. No default because you typically use "mssql_health_server".
1989 mssql_health_server | **Optional.** The name of a predefined connection (in freetds.conf).
1990 mssql_health_currentdb | **Optional.** The name of a database which is used as the current database for the connection.
1991 mssql_health_username | **Optional.** The username for the database connection.
1992 mssql_health_password | **Optional.** The password for the database connection.
1993 mssql_health_warning | **Optional.** The warning threshold depending on the mode.
1994 mssql_health_critical | **Optional.** The critical threshold depending on the mode.
1995 mssql_health_mode | **Required.** The mode uses predefined keywords for the different checks. For example "connection-time", "database-free" or "sql".
1996 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).
1997 mssql_health_name | **Optional.** Depending on the mode this could be the database name or a SQL statement.
1998 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.
1999 mssql_health_regexp | **Optional.** If set to true, "mssql_health_name" will be interpreted as a regular expression. Defaults to false.
2000 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".
2001 mssql_health_offlineok | **Optional.** Set this to true if offline databases are perfectly ok for you. Defaults to false.
2002 mssql_health_commit | **Optional.** Set this to true to turn on autocommit for the dbd::sybase module. Defaults to false.
2004 #### <a id="plugin-contrib-command-mysql_health"></a> mysql_health
2006 The plugin `mysql_health` utilises Perl DBD::MySQL to connect to MySQL databases for monitoring.
2007 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).
2009 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
2012 ---------------------------------|------------------------------------------------------------------------------------------------------------------------------
2013 mysql_health_hostname | **Required.** Specifies the database hostname or address. Defaults to "$address$" or "$address6$" if the `address` attribute is not set.
2014 mysql_health_port | **Optional.** Specifies the database port. Defaults to 3306 (or 1186 for "mysql_health_mode" cluster).
2015 mysql_health_socket | **Optional.** Specifies the database unix socket. No default.
2016 mysql_health_username | **Optional.** The username for the database connection.
2017 mysql_health_password | **Optional.** The password for the database connection.
2018 mysql_health_database | **Optional.** The database to connect to. Defaults to information_schema.
2019 mysql_health_warning | **Optional.** The warning threshold depending on the mode.
2020 mysql_health_critical | **Optional.** The critical threshold depending on the mode.
2021 mysql_health_warningx | **Optional.** The extended warning thresholds depending on the mode.
2022 mysql_health_criticalx | **Optional.** The extended critical thresholds depending on the mode.
2023 mysql_health_mode | **Required.** The mode uses predefined keywords for the different checks. For example "connection-time", "slave-lag" or "sql".
2024 mysql_health_method | **Optional.** How the plugin should connect to the database (`dbi` for using DBD::Mysql (default), `mysql` for using the mysql-Tool).
2025 mysql_health_commit | **Optional.** Turns on autocommit for the dbd::* module.
2026 mysql_health_notemp | **Optional.** Ignore temporary databases/tablespaces.
2027 mysql_health_nooffline | **Optional.** Skip the offline databases.
2028 mysql_health_regexp | **Optional.** Parameter name/name2/name3 will be interpreted as (perl) regular expression.
2029 mysql_health_name | **Optional.** The name of a specific component to check.
2030 mysql_health_name2 | **Optional.** The secondary name of a component.
2031 mysql_health_name3 | **Optional.** The tertiary name of a component.
2032 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".
2033 mysql_health_labelformat | **Optional.** One of those formats pnp4nagios or groundwork. Defaults to pnp4nagios.
2034 mysql_health_extraopts | **Optional.** Read command line arguments from an external file.
2035 mysql_health_blacklist | **Optional.** Blacklist some (missing/failed) components"
2036 mysql_health_mitigation | **Optional.** "The parameter allows you to change a critical error to a warning."
2037 mysql_health_lookback | **Optional.** The amount of time you want to look back when calculating average rates."
2038 mysql_health_environment | **Optional.** Add a variable to the plugin's environment."
2039 mysql_health_morphmessage | **Optional.** Modify the final output message."
2040 mysql_health_morphperfdata | **Optional.** The parameter allows you to change performance data labels."
2041 mysql_health_selectedperfdata | **Optional.** The parameter allows you to limit the list of performance data."
2042 mysql_health_report | **Optional.** Can be used to shorten the output."
2043 mysql_health_multiline | **Optional.** Multiline output."
2044 mysql_health_negate | **Optional.** Emulate the negate plugin. --negate warning=critical --negate unknown=critical."
2045 mysql_health_withmymodulesdyndir | **Optional.** Add-on modules for the my-modes will be searched in this directory."
2046 mysql_health_statefilesdir | **Optional.** An alternate directory where the plugin can save files."
2047 mysql_health_isvalidtime | **Optional.** Signals the plugin to return OK if now is not a valid check time."
2048 mysql_health_timeout | **Optional.** Plugin timeout. Defaults to 60s.
2050 #### <a id="plugin-contrib-command-oracle_health"></a> oracle_health
2052 The plugin `oracle_health` utilises Perl DBD::Oracle based on oracle-instantclient-sdk or sqlplus to connect to Oracle databases for monitoring.
2053 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).
2055 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
2058 ---------------------------------|------------------------------------------------------------------------------------------------------------------------------
2059 oracle_health_connect | **Required.** Specifies the database connection string (from tnsnames.ora).
2060 oracle_health_username | **Optional.** The username for the database connection.
2061 oracle_health_password | **Optional.** The password for the database connection.
2062 oracle_health_warning | **Optional.** The warning threshold depending on the mode.
2063 oracle_health_critical | **Optional.** The critical threshold depending on the mode.
2064 oracle_health_mode | **Required.** The mode uses predefined keywords for the different checks. For example "connection-time", "flash-recovery-area-usage" or "sql".
2065 oracle_health_method | **Optional.** How the plugin should connect to the database (`dbi` for using DBD::Oracle (default), `sqlplus` for using the sqlplus-Tool).
2066 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.
2067 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.
2068 oracle_health_regexp | **Optional.** If set to true, "oracle_health_name" will be interpreted as a regular expression. Defaults to false.
2069 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".
2070 oracle_health_ident | **Optional.** If set to true, outputs instance and database names. Defaults to false.
2071 oracle_health_commit | **Optional.** Set this to true to turn on autocommit for the dbd::oracle module. Defaults to false.
2072 oracle_health_noperfdata | **Optional.** Set this to true if you want to disable perfdata. Defaults to false.
2073 oracle_health_timeout | **Optional.** Plugin timeout. Defaults to 60s.
2078 --------------------|------------------------------------------------------------------------------------------------------------------------------------------
2079 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".
2080 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".
2082 #### <a id="plugin-contrib-command-postgres"></a> postgres
2084 The plugin `postgres` utilises the psql binary to connect to PostgreSQL databases for monitoring.
2085 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).
2087 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
2090 ---------------------------------|------------------------------------------------------------------------------------------------------------------------------
2091 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.
2092 postgres_port | **Optional.** Specifies the database port. Defaults to 5432.
2093 postgres_dbname | **Optional.** Specifies the database name to connect to. Defaults to "postgres" or "template1".
2094 postgres_dbuser | **Optional.** The username for the database connection. Defaults to "postgres".
2095 postgres_dbpass | **Optional.** The password for the database connection. You can use a .pgpass file instead.
2096 postgres_dbservice | **Optional.** Specifies the service name to use inside of pg_service.conf.
2097 postgres_warning | **Optional.** Specifies the warning threshold, range depends on the action.
2098 postgres_critical | **Optional.** Specifies the critical threshold, range depends on the action.
2099 postgres_include | **Optional.** Specifies name(s) items to specifically include (e.g. tables), depends on the action.
2100 postgres_exclude | **Optional.** Specifies name(s) items to specifically exclude (e.g. tables), depends on the action.
2101 postgres_includeuser | **Optional.** Include objects owned by certain users.
2102 postgres_excludeuser | **Optional.** Exclude objects owned by certain users.
2103 postgres_standby | **Optional.** Assume that the server is in continious WAL recovery mode if set to true. Defaults to false.
2104 postgres_production | **Optional.** Assume that the server is in production mode if set to true. Defaults to false.
2105 postgres_action | **Required.** Determines the test executed.
2106 postgres_unixsocket | **Optional.** If "postgres_unixsocket" is set to true, the unix socket is used instead of an address. Defaults to false.
2107 postgres_query | **Optional.** Query for "custom_query" action.
2108 postgres_valtype | **Optional.** Value type of query result for "custom_query".
2109 postgres_reverse | **Optional.** If "postgres_reverse" is set, warning and critical values are reversed for "custom_query" action.
2111 #### <a id="plugin-contrib-command-mongodb"></a> mongodb
2113 The plugin `mongodb` utilises Python PyMongo.
2114 For development check [https://github.com](https://github.com/mzupan/nagios-plugin-mongodb).
2116 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
2119 ---------------------------------|------------------------------------------------------------------------------------------------------------------------------
2120 mongodb_host | **Required.** Specifies the hostname or address.
2121 mongodb_port | **Required.** The port mongodb is runnung on.
2122 mongodb_user | **Optional.** The username you want to login as
2123 mongodb_passwd | **Optional.** The password you want to use for that user
2124 mongodb_warning | **Optional.** The warning threshold we want to set
2125 mongodb_critical | **Optional.** The critical threshold we want to set
2126 mongodb_action | **Required.** The action you want to take
2127 mongodb_maxlag | **Optional.** Get max replication lag (for replication_lag action only)
2128 mongodb_mappedmemory | **Optional.** Get mapped memory instead of resident (if resident memory can not be read)
2129 mongodb_perfdata | **Optional.** Enable output of Nagios performance data
2130 mongodb_database | **Optional.** Specify the database to check
2131 mongodb_alldatabases | **Optional.** Check all databases (action database_size)
2132 mongodb_ssl | **Optional.** Connect using SSL
2133 mongodb_replicaset | **Optional.** Connect to replicaset
2134 mongodb_replcheck | **Optional.** If set to true, will enable the mongodb_replicaset value needed for "replica_primary" check
2135 mongodb_querytype | **Optional.** The query type to check [query\|insert\|update\|delete\|getmore\|command] from queries_per_second
2136 mongodb_collection | **Optional.** Specify the collection to check
2137 mongodb_sampletime | **Optional.** Time used to sample number of pages faults
2139 #### <a id="plugin-contrib-command-elasticsearch"></a> elasticsearch
2141 An [ElasticSearch](https://www.elastic.co/products/elasticsearch) availability
2142 and performance monitoring plugin available for download at [GitHub](https://github.com/anchor/nagios-plugin-elasticsearch).
2143 The plugin requires the HTTP API enabled on your ElasticSearch node.
2146 -----------------------------|-------------------------------------------------------------------------------------------------------
2147 elasticsearch_failuredomain | **Optional.** A comma-separated list of ElasticSearch attributes that make up your cluster's failure domain.
2148 elasticsearch_host | **Optional.** Hostname or network address to probe. Defaults to 'localhost'.
2149 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.
2150 elasticsearch_port | **Optional.** TCP port to probe. The ElasticSearch API should be listening here. Defaults to 9200.
2151 elasticsearch_prefix | **Optional.** Optional prefix (e.g. 'es') for the ElasticSearch API. Defaults to ''.
2152 elasticsearch_yellowcritical | **Optional.** Instead of issuing a 'warning' for a yellow cluster state, issue a 'critical' alert. Defaults to false.
2154 #### <a id="plugin-contrib-command-redis"></a> redis
2156 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).
2157 It is provided by `William Leibzon` at [https://github.com](https://github.com/willixix/naglio-plugins/blob/master/check_redis.pl).
2160 -------------------------|--------------------------------------------------------------------------------------------------------------
2161 redis_hostname | **Required.** Hostname or IP Address to check. Defaults to "127.0.0.1".
2162 redis_port | **Optional.** Port number to query. Default to "6379".
2163 redis_database | **Optional.** Database name (usually a number) to query, needed for **redis_query**.
2164 redis_password | **Optional.** Password for Redis authentication. Safer alternative is to put them in a file and use **redis_credentials**.
2165 redis_credentials | **Optional.** Credentials file to read for Redis authentication.
2166 redis_timeout | **Optional.** Allows to set timeout for execution of this plugin.
2167 redis_variables | **Optional.** List of variables from info data to do threshold checks on.
2168 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.
2169 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.
2170 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.
2171 redis_perfvars | **Optional.** This allows to list variables which values will go only into perfparse output (and not for threshold checking).
2172 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.
2173 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".
2174 redis_query | **Optional.** Option specifies key to query and optional variable name to assign the results to after.
2175 redis_option | **Optional.** Specifiers are separated by "," and must include NAME or PATTERN.
2176 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.
2177 redis_hitrate | **Optional.** Calculates Hitrate and specify values are interpreted as WARNING and CRITICAL thresholds.
2178 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.
2179 redis_total_memory | **Optional.** Amount of memory on a system for memory utilization calculation. Use system memory or max_memory setting of redis.
2180 redis_replication_delay | **Optional.** Allows to set threshold on replication delay info.
2183 ### <a id="plugin-contrib-hardware"></a> Hardware
2185 This category includes all plugins for various hardware checks.
2187 #### <a id="plugin-contrib-command-hpasm"></a> hpasm
2189 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.
2191 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
2194 --------------------------------|-----------------------------------------------------------------------
2195 hpasm_hostname | **Optional.** The host's address. Defaults to "$address$" if the host's `address` attribute is set, "$address6$" otherwise.
2196 hpasm_community | **Optional.** SNMP community of the server (SNMP v1/2 only).
2197 hpasm_protocol | **Optional.** The SNMP protocol to use (default: 2c, other possibilities: 1,3).
2198 hpasm_port | **Optional.** The SNMP port to use (default: 161).
2199 hpasm_blacklist | **Optional.** Blacklist some (missing/failed) components.
2200 hpasm_ignore-dimms | **Optional.** Ignore "N/A"-DIMM status on misc. servers (e.g. older DL320).
2201 hpasm_ignore-fan-redundancy | **Optional.** Ignore missing redundancy partners.
2202 hpasm_customthresholds | **Optional.** Use custom thresholds for certain temperatures.
2203 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.
2204 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.
2205 hpasm_username | **Optional.** The securityName for the USM security model (SNMPv3 only).
2206 hpasm_authpassword | **Optional.** The authentication password for SNMPv3.
2207 hpasm_authprotocol | **Optional.** The authentication protocol for SNMPv3 (md5\|sha).
2208 hpasm_privpassword | **Optional.** The password for authPriv security level.
2209 hpasm_privprotocol | **Optional.** The private protocol for SNMPv3 (des\|aes\|aes128\|3des\|3desde).
2210 hpasm_servertype | **Optional.** The type of the server: proliant (default) or bladesystem.
2211 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.
2214 ### <a id="plugin-contrib-icingacli"></a> IcingaCLI
2216 This category includes all plugins using the icingacli provided by Icinga Web 2.
2218 #### <a id="plugin-contrib-icingacli-businessprocess"></a> Business Process
2220 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).
2222 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
2225 ------------------------------------------|-----------------------------------------------------------------------------------------
2226 icingacli_businessprocess_process | **Required.** Business process to monitor.
2227 icingacli_businessprocess_config | **Optional.** Configuration file containing your business process without file extension.
2228 icingacli_businessprocess_details | **Optional.** Get details for root cause analyses. Defaults to false.
2231 ### <a id="plugin-contrib-ipmi"></a> IPMI Devices
2233 This category includes all plugins for IPMI devices.
2235 #### <a id="plugin-contrib-command-ipmi-sensor"></a> ipmi-sensor
2237 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.
2239 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
2242 ---------------------------------|-----------------------------------------------------------------------------------------------------
2243 ipmi_address | **Required.** Specifies the remote host (IPMI device) to check. Defaults to "$address$".
2244 ipmi_config_file | **Optional.** Path to the FreeIPMI configuration file. It should contain IPMI username, IPMI password, and IPMI privilege-level.
2245 ipmi_username | **Optional.** The IPMI username.
2246 ipmi_password | **Optional.** The IPMI password.
2247 ipmi_privilege_level | **Optional.** The IPMI privilege level of the IPMI user.
2248 ipmi_backward_compatibility_mode | **Optional.** Enable backward compatibility mode, useful for FreeIPMI 0.5.\* (this omits FreeIPMI options "--quiet-cache" and "--sdr-cache-recreate").
2249 ipmi_sensor_type | **Optional.** Limit sensors to query based on IPMI sensor type. Examples for IPMI sensor types are 'Fan', 'Temperature' and 'Voltage'.
2250 ipmi_exclude_sensor_id | **Optional.** Exclude sensor matching ipmi_sensor_id.
2251 ipmi_sensor_id | **Optional.** Include sensor matching ipmi_sensor_id.
2252 ipmi_protocal_lan_version | **Optional.** Change the protocol LAN version. Defaults to "LAN_2_0".
2253 ipmi_number_of_active_fans | **Optional.** Number of fans that should be active. Otherwise a WARNING state is returned.
2254 ipmi_show_fru | **Optional.** Print the product serial number if it is available in the IPMI FRU data.
2255 ipmi_no_sel_checking | **Optional.** Turn off system event log checking via ipmi-sel.
2258 ### <a id="plugins-contrib-log-management"></a> Log Management
2260 This category includes all plugins for log management, for example [Logstash](https://www.elastic.co/products/logstash).
2262 #### <a id="plugins-contrib-command-logstash"></a> logstash
2264 The [logstash](https://github.com/widhalmt/check_logstash) plugin connects to
2265 the Node API of Logstash. This plugin requires at least Logstash version 5.0.x.
2267 The Node API is not activated by default. You have to configure your Logstash
2268 installation in order to allow plugin connections.
2271 ---------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
2272 logstash_hostname | **Optional.** Hostname where Logstash is running. Defaults to `check_address`
2273 logstash_port | **Optional.** Port where Logstash is listening for API requests. Defaults to 9600
2274 logstash_filedesc_warn | **Optional.** Warning threshold of file descriptor usage in percent. Defaults to 85 (percent).
2275 logstash_filedesc_crit | **Optional.** Critical threshold of file descriptor usage in percent. Defaults to 95 (percent).
2276 logstash_heap_warn | **Optional.** Warning threshold of heap usage in percent. Defaults to 70 (percent).
2277 logstash_heap_crit | **Optional.** Critical threshold of heap usage in percent Defaults to 80 (percent).
2278 logstash_inflight_warn | **Optional.** Warning threshold of inflight events.
2279 logstash_inflight_crit | **Optional.** Critical threshold of inflight events.
2280 logstash_cpu_warn | **Optional.** Warning threshold for cpu usage in percent.
2281 logstash_cpu_crit | **Optional.** Critical threshold for cpu usage in percent.
2284 ### <a id="plugin-contrib-metrics"></a> Metrics
2286 This category includes all plugins for metric-based checks.
2288 #### <a id="plugin-contrib-command-graphite"></a> graphite
2290 Check command object for the [check_graphite](https://github.com/obfuscurity/nagios-scripts) plugin.
2292 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
2295 ------------------------------------|-----------------------------------------------------------------------------------------------------
2296 graphite_url | **Required.** Target url.
2297 graphite_metric | **Required.** Metric path string.
2298 graphite_shortname | **Optional.** Metric short name (used for performance data).
2299 graphite_duration | **Optional.** Length, in minute of data to parse (default: 5).
2300 graphite_function | **Optional.** Function applied to metrics for thresholds (default: average).
2301 graphite_warning | **Required.** Warning threshold.
2302 graphite_critical | **Required.** Critical threshold.
2303 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.
2304 graphite_message | **Optional.** Text message to output (default: "metric count:").
2305 graphite_zero_on_error | **Optional.** Return 0 on a graphite 500 error.
2306 graphite_link_graph | **Optional.** Add a link in the plugin output, showing a 24h graph for this metric in graphite.
2308 ### <a id="plugin-contrib-network-components"></a> Network Components
2310 This category includes all plugins for various network components like routers, switches and firewalls.
2312 #### <a id="plugin-contrib-command-interfacetable"></a> interfacetable
2314 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).
2316 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
2319 ------------------------------------|-----------------------------------------------------------------------------------------------------
2320 interfacetable_hostquery | **Required.** Specifies the remote host to poll. Defaults to "$address$".
2321 interfacetable_hostdisplay | **Optional.** Specifies the hostname to display in the HTML link. Defaults to "$host.display_name$".
2322 interfacetable_regex | **Optional.** Interface names and property names for some other options will be interpreted as regular expressions. Defaults to false.
2323 interfacetable_outputshort | **Optional.** Reduce the verbosity of the plugin output. Defaults to false.
2324 interfacetable_exclude | **Optional.** Comma separated list of interfaces globally excluded from the monitoring.
2325 interfacetable_include | **Optional.** Comma separated list of interfaces globally included in the monitoring.
2326 interfacetable_aliasmatching | **Optional.** Allow you to specify alias in addition to interface names. Defaults to false.
2327 interfacetable_excludetraffic | **Optional.** Comma separated list of interfaces excluded from traffic checks.
2328 interfacetable_includetraffic | **Optional.** Comma separated list of interfaces included for traffic checks.
2329 interfacetable_warningtraffic | **Optional.** Interface traffic load percentage leading to a warning alert.
2330 interfacetable_criticaltraffic | **Optional.** Interface traffic load percentage leading to a critical alert.
2331 interfacetable_pkt | **Optional.** Add unicast/non-unicast pkt stats for each interface.
2332 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.
2333 interfacetable_trackproperty | **Optional.** List of tracked properties.
2334 interfacetable_excludeproperty | **Optional.** Comma separated list of interfaces excluded from the property tracking.
2335 interfacetable_includeproperty | **Optional.** Comma separated list of interfaces included in the property tracking.
2336 interfacetable_community | **Optional.** Specifies the snmp v1/v2c community string. Defaults to "public" if using snmp v1/v2c, ignored using v3.
2337 interfacetable_snmpv2 | **Optional.** Use snmp v2c. Defaults to false.
2338 interfacetable_login | **Optional.** Login for snmpv3 authentication.
2339 interfacetable_passwd | **Optional.** Auth password for snmpv3 authentication.
2340 interfacetable_privpass | **Optional.** Priv password for snmpv3 authentication.
2341 interfacetable_protocols | **Optional.** Authentication protocol,Priv protocol for snmpv3 authentication.
2342 interfacetable_domain | **Optional.** SNMP transport domain.
2343 interfacetable_contextname | **Optional.** Context name for the snmp requests.
2344 interfacetable_port | **Optional.** SNMP port. Defaults to standard port.
2345 interfacetable_64bits | **Optional.** Use SNMP 64-bits counters. Defaults to false.
2346 interfacetable_maxrepetitions | **Optional.** Increasing this value may enhance snmp query performances by gathering more results at one time.
2347 interfacetable_snmptimeout | **Optional.** Define the Transport Layer timeout for the snmp queries.
2348 interfacetable_snmpretries | **Optional.** Define the number of times to retry sending a SNMP message.
2349 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.
2350 interfacetable_unixsnmp | **Optional.** Use unix snmp utilities for snmp requests. Defaults to false, which means use the perl bindings.
2351 interfacetable_enableperfdata | **Optional.** Enable port performance data. Defaults to false.
2352 interfacetable_perfdataformat | **Optional.** Define which performance data will be generated. Possible values are "full" (default), "loadonly", "globalonly".
2353 interfacetable_perfdatathreshold | **Optional.** Define which thresholds are printed in the generated performance data. Possible values are "full" (default), "loadonly", "globalonly".
2354 interfacetable_perfdatadir | **Optional.** When specified, the performance data are also written directly to a file, in the specified location.
2355 interfacetable_perfdataservicedesc | **Optional.** Specify additional parameters for output performance data to PNP. Defaults to "$service.name$", only affects **interfacetable_perfdatadir**.
2356 interfacetable_grapher | **Optional.** Specify the used graphing solution. Possible values are "pnp4nagios" (default), "nagiosgrapher", "netwaysgrapherv2" and "ingraph".
2357 interfacetable_grapherurl | **Optional.** Graphing system url. Default depends on **interfacetable_grapher**.
2358 interfacetable_portperfunit | **Optional.** Traffic could be reported in bits (counters) or in bps (calculated value).
2359 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".
2360 interfacetable_duplex | **Optional.** Add the duplex mode property for each interface in the interface table. Defaults to false.
2361 interfacetable_stp | **Optional.** Add the stp state property for each interface in the interface table. Defaults to false.
2362 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"
2363 interfacetable_noipinfo | **Optional.** Remove the ip information for each interface from the interface table. Defaults to false.
2364 interfacetable_alias | **Optional.** Add the alias information for each interface in the interface table. Defaults to false.
2365 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.
2366 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.
2367 interfacetable_delta | **Optional.** Set the delta used for interface throuput calculation in seconds.
2368 interfacetable_ifs | **Optional.** Input field separator. Defaults to ",".
2369 interfacetable_cache | **Optional.** Define the retention time of the cached data in seconds.
2370 interfacetable_noifloadgradient | **Optional.** Disable color gradient from green over yellow to red for the load percentage. Defaults to false.
2371 interfacetable_nohuman | **Optional.** Do not translate bandwidth usage in human readable format. Defaults to false.
2372 interfacetable_snapshot | **Optional.** Force the plugin to run like if it was the first launch. Defaults to false.
2373 interfacetable_timeout | **Optional.** Define the global timeout limit of the plugin in seconds. Defaults to "15s".
2374 interfacetable_css | **Optional.** Define the css stylesheet used by the generated html files. Possible values are "classic", "icinga", "icinga-alternate1" or "nagiosxi".
2375 interfacetable_config | **Optional.** Specify a config file to load.
2376 interfacetable_noconfigtable | **Optional.** Disable configuration table on the generated HTML page. Defaults to false.
2377 interfacetable_notips | **Optional.** Disable the tips in the generated html tables. Defaults to false.
2378 interfacetable_defaulttablesorting | **Optional.** Default table sorting can be "index" (default) or "name".
2379 interfacetable_tablesplit | **Optional.** Generate multiple interface tables, one per interface type. Defaults to false.
2380 interfacetable_notype | **Optional.** Remove the interface type for each interface. Defaults to false.
2382 #### <a id="plugin-contrib-command-iftraffic"></a> iftraffic
2384 The plugin [check_iftraffic](https://exchange.icinga.org/exchange/iftraffic)
2385 checks the utilization of a given interface name using the SNMP protocol.
2387 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
2390 ------------------------|---------------------------------------------------------
2391 iftraffic_address | **Required.** Specifies the remote host. Defaults to "$address$".
2392 iftraffic_community | **Optional.** SNMP community. Defaults to "public'" if omitted.
2393 iftraffic_interface | **Required.** Queried interface name.
2394 iftraffic_bandwidth | **Required.** Interface maximum speed in kilo/mega/giga/bits per second.
2395 iftraffic_units | **Optional.** Interface units can be one of these values: `g` (gigabits/s),`m` (megabits/s), `k` (kilobits/s),`b` (bits/s)
2396 iftraffic_warn | **Optional.** Percent of bandwidth usage necessary to result in warning status (defaults to `85`).
2397 iftraffic_crit | **Optional.** Percent of bandwidth usage necessary to result in critical status (defaults to `98`).
2398 iftraffic_max_counter | **Optional.** Maximum counter value of net devices in kilo/mega/giga/bytes.
2400 #### <a id="plugin-contrib-command-iftraffic64"></a> iftraffic64
2402 The plugin [check_iftraffic64](https://exchange.icinga.org/exchange/iftraffic64)
2403 checks the utilization of a given interface name using the SNMP protocol.
2405 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
2408 ------------------------|---------------------------------------------------------
2409 iftraffic64_address | **Required.** Specifies the remote host. Defaults to "$address$".
2410 iftraffic64_community | **Optional.** SNMP community. Defaults to "public'" if omitted.
2411 iftraffic64_interface | **Required.** Queried interface name.
2412 iftraffic64_bandwidth | **Required.** Interface maximum speed in kilo/mega/giga/bits per second.
2413 iftraffic64_units | **Optional.** Interface units can be one of these values: `g` (gigabits/s),`m` (megabits/s), `k` (kilobits/s),`b` (bits/s)
2414 iftraffic64_warn | **Optional.** Percent of bandwidth usage necessary to result in warning status (defaults to `85`).
2415 iftraffic64_crit | **Optional.** Percent of bandwidth usage necessary to result in critical status (defaults to `98`).
2416 iftraffic64_max_counter | **Optional.** Maximum counter value of net devices in kilo/mega/giga/bytes.
2418 #### <a id="plugin-contrib-command-interfaces"></a> interfaces
2420 The plugin [check_interfaces](https://www.netways.org/projects/check-interfaces)
2421 Check interfaces and utilization.
2423 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
2426 --------------------------|---------------------------------------------------------
2427 interfaces_address | **Optional.** The host's address. Defaults to "$address$" if the host's `address` attribute is set, "$address6$" otherwise.
2428 interfaces_regex | **Optional.** Interface list regexp.
2429 interfaces_exclude_regex | **Optional.** Interface list negative regexp.
2430 interfaces_errors | **Optional.** Number of in errors (CRC errors for cisco) to consider a warning (default 50).
2431 interface_out_errors | **Optional.** Number of out errors (collisions for cisco) to consider a warning (default same as in errors).
2432 interfaces_perfdata | **Optional.** perfdata from last check result.
2433 interfaces_prefix | **Optional.** Prefix interface names with this label.
2434 interfaces_lastcheck | **Optional.** Last checktime (unixtime).
2435 interfaces_bandwidth | **Optional.** Bandwidth warn level in percent.
2436 interfaces_speed | **Optional.** Override speed detection with this value (bits per sec).
2437 interfaces_trim | **Optional.** Cut this number of characters from the start of interface descriptions.
2438 interfaces_mode | **Optional.** Special operating mode (default,cisco,nonbulk,bintec).
2439 interfaces_auth_proto | **Optional.** SNMPv3 Auth Protocol (SHA\|MD5)
2440 interfaces_auth_phrase | **Optional.** SNMPv3 Auth Phrase
2441 interfaces_priv_proto | **Optional.** SNMPv3 Privacy Protocol (AES\|DES)
2442 interfaces_priv_phrase | **Optional.** SNMPv3 Privacy Phrase
2443 interfaces_user | **Optional.** SNMPv3 User
2444 interfaces_down_is_ok | **Optional.** Disables critical alerts for down interfaces.
2445 interfaces_aliases | **Optional.** Retrieves the interface description.
2446 interfaces_match_aliases | **Optional.** Also match against aliases (Option --aliases automatically enabled).
2447 interfaces_timeout | **Optional.** Sets the SNMP timeout (in ms).
2448 interfaces_sleep | **Optional.** Sleep between every SNMP query (in ms).
2450 #### <a id="plugin-contrib-command-nwc_health"></a> nwc_health
2452 The plugin [check_nwc_health](https://labs.consol.de/de/nagios/check_nwc_health/index.html)
2453 Check switches, router, there interfaces and utilization.
2455 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
2458 --------------------------------|---------------------------------------------------------
2459 nwc_health_hostname | **Optional.** The host's address. Defaults to "$address$" if the host's `address` attribute is set, "$address6$" otherwise.
2460 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).
2461 nwc_health_timeout | **Optional.** Seconds before plugin times out (default: 15)
2462 nwc_health_blacklist | **Optional.** Blacklist some (missing/failed) components.
2463 nwc_health_port | **Optional.** The SNMP port to use (default: 161).
2464 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).
2465 nwc_health_protocol | **Optional.** The SNMP protocol to use (default: 2c, other possibilities: 1,3).
2466 nwc_health_community | **Optional.** SNMP community of the server (SNMP v1/2 only).
2467 nwc_health_username | **Optional.** The securityName for the USM security model (SNMPv3 only).
2468 nwc_health_authpassword | **Optional.** The authentication password for SNMPv3.
2469 nwc_health_authprotocol | **Optional.** The authentication protocol for SNMPv3 (md5\|sha).
2470 nwc_health_privpassword | **Optional.** The password for authPriv security level.
2471 nwc_health_privprotocol | **Optional.** The private protocol for SNMPv3 (des\|aes\|aes128\|3des\|3desde).
2472 nwc_health_contextengineid | **Optional.** The context engine id for SNMPv3 (10 to 64 hex characters).
2473 nwc_health_contextname | **Optional.** The context name for SNMPv3 (empty represents the default context).
2474 nwc_health_name | **Optional.** The name of an interface (ifDescr).
2475 nwc_health_drecksptkdb | **Optional.** This parameter must be used instead of --name, because Devel::ptkdb is stealing the latter from the command line.
2476 nwc_health_alias | **Optional.** The alias name of a 64bit-interface (ifAlias)
2477 nwc_health_regexp | **Optional.** A flag indicating that --name is a regular expression
2478 nwc_health_ifspeedin | **Optional.** Override the ifspeed oid of an interface (only inbound)
2479 nwc_health_ifspeedout | **Optional.** Override the ifspeed oid of an interface (only outbound)
2480 nwc_health_ifspeed | **Optional.** Override the ifspeed oid of an interface
2481 nwc_health_units | **Optional.** One of %, B, KB, MB, GB, Bit, KBi, MBi, GBi. (used for e.g. mode interface-usage)
2482 nwc_health_name2 | **Optional.** The secondary name of a component.
2483 nwc_health_role | **Optional.** The role of this device in a hsrp group (active/standby/listen).
2484 nwc_health_report | **Optional.** Can be used to shorten the output.
2485 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.
2486 nwc_health_warning | **Optional.** The warning threshold
2487 nwc_health_critical | **Optional.** The critical threshold
2488 nwc_health_warningx | **Optional.** The extended warning thresholds
2489 nwc_health_criticalx | **Optional.** The extended critical thresholds
2490 nwc_health_mitigation | **Optional.** The parameter allows you to change a critical error to a warning.
2491 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.
2492 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'
2493 nwc_health_negate | **Optional.** The parameter allows you to map exit levels, such as warning=critical.
2494 nwc_health_mymodules-dyn-dir | **Optional.** A directory where own extensions can be found.
2495 nwc_health_servertype | **Optional.** The type of the network device: cisco (default). Use it if auto-detection is not possible.
2496 nwc_health_statefilesdir | **Optional.** An alternate directory where the plugin can save files.
2497 nwc_health_oids | **Optional.** A list of oids which are downloaded and written to a cache file. Use it together with --mode oidcache.
2498 nwc_health_offline | **Optional.** The maximum number of seconds since the last update of cache file before it is considered too old.
2499 nwc_health_multiline | **Optional.** Multiline output
2502 ### <a id="plugin-contrib-operating-system"></a> Operating System
2504 In this category you can find plugins for gathering information about your operating system or the system beneath like memory usage.
2506 #### <a id="plugin-contrib-command-mem"></a> mem
2508 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).
2510 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
2513 -------------|-----------------------------------------------------------------------------------------------------------------------
2514 mem_used | **Optional.** Tell the plugin to check for used memory in opposite of **mem_free**. Must specify one of these as true.
2515 mem_free | **Optional.** Tell the plugin to check for free memory in opposite of **mem_used**. Must specify one of these as true.
2516 mem_cache | **Optional.** If set to true, plugin will count cache as free memory. Defaults to false.
2517 mem_warning | **Required.** Specify the warning threshold as number interpreted as percent.
2518 mem_critical | **Required.** Specify the critical threshold as number interpreted as percent.
2520 #### <a id="plugin-contrib-command-running_kernel"></a> running_kernel
2522 Check command object for the `check_running_kernel` plugin
2523 provided by the `nagios-plugin-contrib` package on Debian.
2528 ---------------------------|-------------
2529 running\_kernel\_use\_sudo | Whether to run the plugin with `sudo`. Defaults to false except on Ubuntu where it defaults to true.
2531 #### <a id="plugin-contrib-command-iostats"></a> iostats
2533 The plugin [check_iostats](https://github.com/dnsmichi/icinga-plugins/blob/master/scripts/check_iostats) is used to monitor I/O with `iostats` on a Linux host. The default thresholds are rather high so you can use a grapher for baselining before setting your own.
2535 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
2538 ---------------|-----------------------------------------------------------------------------------------------------------------------
2539 iostats\_disk | **Required.** The device to monitor without path. e.g. sda or vda. (default: sda)
2540 iostats\_warning\_tps | **Required.** Warning threshold for tps (default: 3000)
2541 iostats\_warning\_read | **Required.** Warning threshold for KB/s reads (default: 50000)
2542 iostats\_warning\_write | **Required.** Warning threshold for KB/s writes (default: 10000)
2543 iostats\_warning\_wait | **Required.** Warning threshold for % iowait (default: 50)
2544 iostats\_critical\_tps | **Required.** Critical threshold for tps (default: 5000)
2545 iostats\_critical\_read | **Required.** Critical threshold for KB/s reads (default: 80000)
2546 iostats\_critical\_write | **Required.** Critical threshold for KB/s writes (default: 25000)
2547 iostats\_critical\_wait | **Required.** Critical threshold for % iowait (default: 80)
2549 #### <a id="plugin-contrib-command-iostat"></a> iostat
2551 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.
2553 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
2556 ---------------|-----------------------------------------------------------------------------------------------------------------------
2557 iostat\_disk | **Required.** The device to monitor without path. e.g. sda or vda. (default: sda)
2558 iostat\_wtps | **Required.** Warning threshold for tps (default: 100)
2559 iostat\_wread | **Required.** Warning threshold for KB/s reads (default: 100)
2560 iostat\_wwrite | **Required.** Warning threshold for KB/s writes (default: 100)
2561 iostat\_ctps | **Required.** Critical threshold for tps (default: 200)
2562 iostat\_cread | **Required.** Critical threshold for KB/s reads (default: 200)
2563 iostat\_cwrite | **Required.** Critical threshold for KB/s writes (default: 200)
2565 #### <a id="plugin-contrib-command-yum"></a> yum
2567 The plugin [check_yum](https://github.com/calestyo/check_yum) is used to check the YUM package
2568 management system for package updates.
2569 The plugin requires the `yum-plugin-security` package to differentiate between security and normal updates.
2571 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
2574 ------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
2575 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.
2576 yum_warn_on_any_update | **Optional.** Set to true to warn if there are any (non-security) package updates available. Defaults to false.
2577 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.
2578 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.
2579 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.
2580 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.
2581 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.
2582 yum_installroot | **Optional.** Specifies another installation root directory (for example a chroot).
2583 yum_timeout | **Optional.** Set a timeout in seconds after which the plugin will exit (defaults to 55 seconds).
2585 ### <a id="plugins-contrib-storage"></a> Storage
2587 This category includes all plugins for various storage and object storage technologies.
2589 #### <a id="plugins-contrib-command-glusterfs"></a> glusterfs
2591 The plugin [glusterfs](https://www.unixadm.org/software/nagios-stuff/checks/check_glusterfs) is used to check the GlusterFS storage health on the server.
2592 The plugin requires `sudo` permissions.
2595 ---------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
2596 glusterfs_perfdata | **Optional.** Print perfdata of all or the specified volume.
2597 glusterfs_warnonfailedheal | **Optional.** Warn if the *heal-failed* log contains entries. The log can be cleared by restarting glusterd.
2598 glusterfs_volume | **Optional.** Only check the specified *VOLUME*. If --volume is not set, all volumes are checked.
2599 glusterfs_disk_warning | **Optional.** Warn if disk usage is above *DISKWARN*. Defaults to 90 (percent).
2600 glusterfs_disk_critical | **Optional.** Return a critical error if disk usage is above *DISKCRIT*. Defaults to 95 (percent).
2601 glusterfs_inode_warning | **Optional.** Warn if inode usage is above *DISKWARN*. Defaults to 90 (percent).
2602 glusterfs_inode_critical | **Optional.** Return a critical error if inode usage is above *DISKCRIT*. Defaults to 95 (percent).
2605 ### <a id="plugin-contrib-virtualization"></a> Virtualization
2607 This category includes all plugins for various virtualization technologies.
2609 #### <a id="plugin-contrib-command-esxi-hardware"></a> esxi_hardware
2611 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.
2613 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
2616 ------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
2617 esxi_hardware_host | **Required.** Specifies the host to monitor. Defaults to "$address$".
2618 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.
2619 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.
2620 esxi_hardware_port | **Optional.** Specifies the CIM port to connect to. Defaults to 5989.
2621 esxi_hardware_vendor | **Optional.** Defines the vendor of the server: "auto", "dell", "hp", "ibm", "intel", "unknown" (default).
2622 esxi_hardware_html | **Optional.** Add web-links to hardware manuals for Dell servers (use your country extension). Only useful with **esxi_hardware_vendor** = dell.
2623 esxi_hardware_ignore | **Optional.** Comma separated list of elements to ignore.
2624 esxi_hardware_perfdata | **Optional.** Add performcedata for graphers like PNP4Nagios to the output. Defaults to false.
2625 esxi_hardware_nopower | **Optional.** Do not collect power performance data, when **esxi_hardware_perfdata** is set to true. Defaults to false.
2626 esxi_hardware_novolts | **Optional.** Do not collect voltage performance data, when **esxi_hardware_perfdata** is set to true. Defaults to false.
2627 esxi_hardware_nocurrent | **Optional.** Do not collect current performance data, when **esxi_hardware_perfdata** is set to true. Defaults to false.
2628 esxi_hardware_notemp | **Optional.** Do not collect temperature performance data, when **esxi_hardware_perfdata** is set to true. Defaults to false.
2629 esxi_hardware_nofan | **Optional.** Do not collect fan performance data, when **esxi_hardware_perfdata** is set to true. Defaults to false.
2631 #### <a id="plugin-contrib-vmware"></a> VMware
2633 Check commands for the [check_vmware_esx](https://github.com/BaldMansMojo/check_vmware_esx) plugin.
2635 ##### <a id="plugin-contrib-vmware-esx-dc-volumes"></a> vmware-esx-dc-volumes
2637 Check command object for the `check_vmware_esx` plugin. Shows all datastore volumes info.
2639 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
2642 ------------------------|--------------
2643 vmware_datacenter | **Required.** Datacenter/vCenter hostname.
2644 vmware_cluster | **Optional.** ESX or ESXi clustername.
2645 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
2646 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
2647 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
2648 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
2649 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
2650 vmware_sessionfile | **Optional.** Session file name enhancement.
2651 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
2652 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
2653 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
2654 vmware_password | **Optional.** The username's password. No value defined as default.
2655 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
2656 vmware_subselect | **Optional.** Volume name to be checked the free space.
2657 vmware_gigabyte | **Optional.** Output in GB instead of MB.
2658 vmware_usedspace | **Optional.** Output used space instead of free. Defaults to "false".
2659 vmware_alertonly | **Optional.** List only alerting volumes. Defaults to "false".
2660 vmware_exclude | **Optional.** Blacklist volumes name. No value defined as default.
2661 vmware_include | **Optional.** Whitelist volumes name. No value defined as default.
2662 vmware_isregexp | **Optional.** Treat blacklist and whitelist expressions as regexp.
2663 vmware_dc_volume_used | **Optional.** Output used space instead of free. Defaults to "true".
2664 vmware_warn | **Optional.** The warning threshold for volumes. Defaults to "80%".
2665 vmware_crit | **Optional.** The critical threshold for volumes. Defaults to "90%".
2668 ##### <a id="plugin-contrib-vmware-esx-dc-runtime-info"></a> vmware-esx-dc-runtime-info
2670 Check command object for the `check_vmware_esx` plugin. Shows all runtime info for the datacenter/Vcenter.
2672 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
2675 ------------------------|--------------
2676 vmware_datacenter | **Required.** Datacenter/vCenter hostname.
2677 vmware_cluster | **Optional.** ESX or ESXi clustername.
2678 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
2679 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
2680 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
2681 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
2682 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
2683 vmware_sessionfile | **Optional.** Session file name enhancement.
2684 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
2685 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
2686 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
2687 vmware_password | **Optional.** The username's password. No value defined as default.
2688 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
2691 ##### <a id="plugin-contrib-vmware-esx-dc-runtime-listvms"></a> vmware-esx-dc-runtime-listvms
2693 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.
2695 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
2698 ------------------------|--------------
2699 vmware_datacenter | **Required.** Datacenter/vCenter hostname.
2700 vmware_cluster | **Optional.** ESX or ESXi clustername.
2701 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
2702 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
2703 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
2704 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
2705 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
2706 vmware_sessionfile | **Optional.** Session file name enhancement.
2707 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
2708 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
2709 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
2710 vmware_password | **Optional.** The username's password. No value defined as default.
2711 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
2712 vmware_alertonly | **Optional.** List only alerting VMs. Important here to avoid masses of data.
2713 vmware_exclude | **Optional.** Blacklist VMs name. No value defined as default.
2714 vmware_include | **Optional.** Whitelist VMs name. No value defined as default.
2715 vmware_isregexp | **Optional.** Treat blacklist and whitelist expressions as regexp.
2716 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.
2719 ##### <a id="plugin-contrib-vmware-esx-dc-runtime-listhost"></a> vmware-esx-dc-runtime-listhost
2721 Check command object for the `check_vmware_esx` plugin. List of VMware ESX hosts and their power state.
2723 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
2726 ------------------------|--------------
2727 vmware_datacenter | **Required.** Datacenter/vCenter hostname.
2728 vmware_cluster | **Optional.** ESX or ESXi clustername.
2729 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
2730 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
2731 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
2732 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
2733 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
2734 vmware_sessionfile | **Optional.** Session file name enhancement.
2735 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
2736 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
2737 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
2738 vmware_password | **Optional.** The username's password. No value defined as default.
2739 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
2740 vmware_alertonly | **Optional.** List only alerting hosts. Important here to avoid masses of data.
2741 vmware_exclude | **Optional.** Blacklist VMware ESX hosts. No value defined as default.
2742 vmware_include | **Optional.** Whitelist VMware ESX hosts. No value defined as default.
2743 vmware_isregexp | **Optional.** Treat blacklist and whitelist expressions as regexp.
2744 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.
2747 ##### <a id="plugin-contrib-vmware-esx-dc-runtime-listcluster"></a> vmware-esx-dc-runtime-listcluster
2749 Check command object for the `check_vmware_esx` plugin. List of VMware clusters and their states.
2751 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
2754 ------------------------|--------------
2755 vmware_datacenter | **Required.** Datacenter/vCenter hostname.
2756 vmware_cluster | **Optional.** ESX or ESXi clustername.
2757 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
2758 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
2759 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
2760 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
2761 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
2762 vmware_sessionfile | **Optional.** Session file name enhancement.
2763 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
2764 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
2765 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
2766 vmware_password | **Optional.** The username's password. No value defined as default.
2767 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
2768 vmware_alertonly | **Optional.** List only alerting hosts. Important here to avoid masses of data.
2769 vmware_exclude | **Optional.** Blacklist VMware cluster. No value defined as default.
2770 vmware_include | **Optional.** Whitelist VMware cluster. No value defined as default.
2771 vmware_isregexp | **Optional.** Treat blacklist and whitelist expressions as regexp.
2772 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.
2775 ##### <a id="plugin-contrib-vmware-esx-dc-runtime-issues"></a> vmware-esx-dc-runtime-issues
2777 Check command object for the `check_vmware_esx` plugin. All issues for the host.
2779 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
2782 ------------------------|--------------
2783 vmware_datacenter | **Required.** Datacenter/vCenter hostname.
2784 vmware_cluster | **Optional.** ESX or ESXi clustername.
2785 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
2786 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
2787 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
2788 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
2789 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
2790 vmware_sessionfile | **Optional.** Session file name enhancement.
2791 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
2792 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
2793 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
2794 vmware_password | **Optional.** The username's password. No value defined as default.
2795 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
2796 vmware_exclude | **Optional.** Blacklist issues. No value defined as default.
2797 vmware_include | **Optional.** Whitelist issues. No value defined as default.
2798 vmware_isregexp | **Optional.** Treat blacklist and whitelist expressions as regexp.
2799 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.
2802 ##### <a id="plugin-contrib-vmware-esx-dc-runtime-status"></a> vmware-esx-dc-runtime-status
2804 Check command object for the `check_vmware_esx` plugin. Overall object status (gray/green/red/yellow).
2806 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
2809 ------------------------|--------------
2810 vmware_datacenter | **Required.** Datacenter/vCenter hostname.
2811 vmware_cluster | **Optional.** ESX or ESXi clustername.
2812 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
2813 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
2814 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
2815 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
2816 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
2817 vmware_sessionfile | **Optional.** Session file name enhancement.
2818 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
2819 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
2820 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
2821 vmware_password | **Optional.** The username's password. No value defined as default.
2822 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
2825 ##### <a id="plugin-contrib-vmware-esx-dc-runtime-tools"></a> vmware-esx-dc-runtime-tools
2827 Check command object for the `check_vmware_esx` plugin. Vmware Tools status.
2829 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
2832 ------------------------|--------------
2833 vmware_datacenter | **Required.** Datacenter/vCenter hostname.
2834 vmware_cluster | **Optional.** ESX or ESXi clustername.
2835 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
2836 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
2837 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
2838 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
2839 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
2840 vmware_sessionfile | **Optional.** Session file name enhancement.
2841 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
2842 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
2843 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
2844 vmware_password | **Optional.** The username's password. No value defined as default.
2845 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
2846 vmware_poweredonly | **Optional.** List only VMs which are powered on. No value defined as default.
2847 vmware_alertonly | **Optional.** List only alerting VMs. Important here to avoid masses of data.
2848 vmware_exclude | **Optional.** Blacklist VMs. No value defined as default.
2849 vmware_include | **Optional.** Whitelist VMs. No value defined as default.
2850 vmware_isregexp | **Optional.** Treat blacklist and whitelist expressions as regexp.
2851 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.
2852 vmware_openvmtools | **Optional** Prevent CRITICAL state for installed and running Open VM Tools.
2855 ##### <a id="plugin-contrib-vmware-esx-soap-host-check"></a> vmware-esx-soap-host-check
2857 Check command object for the `check_vmware_esx` plugin. Simple check to verify a successfull connection to VMware SOAP API.
2859 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
2862 ------------------------|--------------
2863 vmware_host | **Required.** ESX or ESXi hostname.
2864 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. In case the check is done through a Datacenter/vCenter host.
2865 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
2866 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
2867 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
2868 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
2869 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
2870 vmware_sessionfile | **Optional.** Session file name enhancement.
2871 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
2872 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
2873 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
2874 vmware_password | **Optional.** The username's password. No value defined as default.
2875 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
2878 ##### <a id="plugin-contrib-vmware-esx-soap-host-uptime"></a> vmware-esx-soap-host-uptime
2880 Check command object for the `check_vmware_esx` plugin. Displays uptime of the VMware host.
2882 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
2885 ------------------------|--------------
2886 vmware_host | **Required.** ESX or ESXi hostname.
2887 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. In case the check is done through a Datacenter/vCenter host.
2888 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
2889 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
2890 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
2891 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
2892 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
2893 vmware_sessionfile | **Optional.** Session file name enhancement.
2894 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
2895 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
2896 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
2897 vmware_password | **Optional.** The username's password. No value defined as default.
2898 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
2901 ##### <a id="plugin-contrib-vmware-esx-soap-host-cpu"></a> vmware-esx-soap-host-cpu
2903 Check command object for the `check_vmware_esx` plugin. CPU usage in percentage.
2905 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
2908 ------------------------|--------------
2909 vmware_host | **Required.** ESX or ESXi hostname.
2910 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. In case the check is done through a Datacenter/vCenter host.
2911 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
2912 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
2913 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
2914 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
2915 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
2916 vmware_sessionfile | **Optional.** Session file name enhancement.
2917 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
2918 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
2919 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
2920 vmware_password | **Optional.** The username's password. No value defined as default.
2921 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
2922 vmware_warn | **Optional.** The warning threshold in percent. Defaults to "80%".
2923 vmware_crit | **Optional.** The critical threshold in percent. Defaults to "90%".
2926 ##### <a id="plugin-contrib-vmware-esx-soap-host-cpu-ready"></a> vmware-esx-soap-host-cpu-ready
2928 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.
2930 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
2933 ------------------------|--------------
2934 vmware_host | **Required.** ESX or ESXi hostname.
2935 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. In case the check is done through a Datacenter/vCenter host.
2936 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
2937 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
2938 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
2939 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
2940 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
2941 vmware_sessionfile | **Optional.** Session file name enhancement.
2942 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
2943 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
2944 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
2945 vmware_password | **Optional.** The username's password. No value defined as default.
2946 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
2949 ##### <a id="plugin-contrib-vmware-esx-soap-host-cpu-wait"></a> vmware-esx-soap-host-cpu-wait
2951 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.
2953 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
2956 ------------------------|--------------
2957 vmware_host | **Required.** ESX or ESXi hostname.
2958 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. In case the check is done through a Datacenter/vCenter host.
2959 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
2960 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
2961 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
2962 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
2963 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
2964 vmware_sessionfile | **Optional.** Session file name enhancement.
2965 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
2966 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
2967 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
2968 vmware_password | **Optional.** The username's password. No value defined as default.
2969 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
2972 ##### <a id="plugin-contrib-vmware-esx-soap-host-cpu-usage"></a> vmware-esx-soap-host-cpu-usage
2974 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.
2976 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
2979 ------------------------|--------------
2980 vmware_host | **Required.** ESX or ESXi hostname.
2981 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. In case the check is done through a Datacenter/vCenter host.
2982 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
2983 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
2984 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
2985 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
2986 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
2987 vmware_sessionfile | **Optional.** Session file name enhancement.
2988 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
2989 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
2990 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
2991 vmware_password | **Optional.** The username's password. No value defined as default.
2992 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
2993 vmware_warn | **Optional.** The warning threshold in percent. Defaults to "80%".
2994 vmware_crit | **Optional.** The critical threshold in percent. Defaults to "90%".
2997 ##### <a id="plugin-contrib-vmware-esx-soap-host-mem"></a> vmware-esx-soap-host-mem
2999 Check command object for the `check_vmware_esx` plugin. All mem info(except overall and no thresholds).
3001 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
3004 ------------------------|--------------
3005 vmware_host | **Required.** ESX or ESXi hostname.
3006 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. In case the check is done through a Datacenter/vCenter host.
3007 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
3008 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
3009 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
3010 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
3011 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
3012 vmware_sessionfile | **Optional.** Session file name enhancement.
3013 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
3014 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
3015 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
3016 vmware_password | **Optional.** The username's password. No value defined as default.
3017 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
3020 ##### <a id="plugin-contrib-vmware-esx-soap-host-mem-usage"></a> vmware-esx-soap-host-mem-usage
3022 Check command object for the `check_vmware_esx` plugin. Average mem usage in percentage.
3024 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
3027 ------------------------|--------------
3028 vmware_host | **Required.** ESX or ESXi hostname.
3029 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. In case the check is done through a Datacenter/vCenter host.
3030 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
3031 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
3032 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
3033 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
3034 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
3035 vmware_sessionfile | **Optional.** Session file name enhancement.
3036 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
3037 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
3038 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
3039 vmware_password | **Optional.** The username's password. No value defined as default.
3040 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
3041 vmware_warn | **Optional.** The warning threshold in percent. Defaults to "80%".
3042 vmware_crit | **Optional.** The critical threshold in percent. Defaults to "90%".
3045 ##### <a id="plugin-contrib-vmware-esx-soap-host-mem-consumed"></a> vmware-esx-soap-host-mem-consumed
3047 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.
3049 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
3052 ------------------------|--------------
3053 vmware_host | **Required.** ESX or ESXi hostname.
3054 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. In case the check is done through a Datacenter/vCenter host.
3055 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
3056 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
3057 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
3058 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
3059 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
3060 vmware_sessionfile | **Optional.** Session file name enhancement.
3061 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
3062 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
3063 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
3064 vmware_password | **Optional.** The username's password. No value defined as default.
3065 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
3066 vmware_warn | **Optional.** The warning threshold in percent. No value defined as default.
3067 vmware_crit | **Optional.** The critical threshold in percent. No value defined as default.
3070 ##### <a id="plugin-contrib-vmware-esx-soap-host-mem-swapused"></a> vmware-esx-soap-host-mem-swapused
3072 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.
3074 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
3077 ------------------------|--------------
3078 vmware_host | **Required.** ESX or ESXi hostname.
3079 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. In case the check is done through a Datacenter/vCenter host.
3080 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
3081 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
3082 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
3083 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
3084 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
3085 vmware_sessionfile | **Optional.** Session file name enhancement.
3086 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
3087 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
3088 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
3089 vmware_password | **Optional.** The username's password. No value defined as default.
3090 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
3091 vmware_warn | **Optional.** The warning threshold in percent. No value defined as default.
3092 vmware_crit | **Optional.** The critical threshold in percent. No value defined as default.
3093 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.
3096 ##### <a id="plugin-contrib-vmware-esx-soap-host-mem-overhead"></a> vmware-esx-soap-host-mem-overhead
3098 Check command object for the `check_vmware_esx` plugin. Additional mem used by VM Server in MB.
3100 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
3103 ------------------------|--------------
3104 vmware_host | **Required.** ESX or ESXi hostname.
3105 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. In case the check is done through a Datacenter/vCenter host.
3106 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
3107 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
3108 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
3109 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
3110 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
3111 vmware_sessionfile | **Optional.** Session file name enhancement.
3112 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
3113 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
3114 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
3115 vmware_password | **Optional.** The username's password. No value defined as default.
3116 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
3117 vmware_warn | **Optional.** The warning threshold in percent. No value defined as default.
3118 vmware_crit | **Optional.** The critical threshold in percent. No value defined as default.
3121 ##### <a id="plugin-contrib-vmware-esx-soap-host-mem-memctl"></a> vmware-esx-soap-host-mem-memctl
3123 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.
3125 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
3128 ------------------------|--------------
3129 vmware_host | **Required.** ESX or ESXi hostname.
3130 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. In case the check is done through a Datacenter/vCenter host.
3131 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
3132 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
3133 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
3134 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
3135 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
3136 vmware_sessionfile | **Optional.** Session file name enhancement.
3137 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
3138 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
3139 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
3140 vmware_password | **Optional.** The username's password. No value defined as default.
3141 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
3142 vmware_warn | **Optional.** The warning threshold in percent. No value defined as default.
3143 vmware_crit | **Optional.** The critical threshold in percent. No value defined as default.
3144 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.
3147 ##### <a id="plugin-contrib-vmware-esx-soap-host-net"></a> vmware-esx-soap-host-net
3149 Check command object for the `check_vmware_esx` plugin. Shows net info.
3151 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
3154 ------------------------|--------------
3155 vmware_host | **Required.** ESX or ESXi hostname.
3156 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. In case the check is done through a Datacenter/vCenter host.
3157 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
3158 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
3159 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
3160 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
3161 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
3162 vmware_sessionfile | **Optional.** Session file name enhancement.
3163 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
3164 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
3165 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
3166 vmware_password | **Optional.** The username's password. No value defined as default.
3167 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
3168 vmware_exclude | **Optional.** Blacklist NICs. No value defined as default.
3169 vmware_isregexp | **Optional.** Treat blacklist expression as regexp.
3172 ##### <a id="plugin-contrib-vmware-esx-soap-host-net-usage"></a> vmware-esx-soap-host-net-usage
3174 Check command object for the `check_vmware_esx` plugin. Overall network usage in KBps(Kilobytes per Second).
3176 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
3179 ------------------------|--------------
3180 vmware_host | **Required.** ESX or ESXi hostname.
3181 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. In case the check is done through a Datacenter/vCenter host.
3182 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
3183 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
3184 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
3185 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
3186 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
3187 vmware_sessionfile | **Optional.** Session file name enhancement.
3188 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
3189 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
3190 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
3191 vmware_password | **Optional.** The username's password. No value defined as default.
3192 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
3193 vmware_warn | **Optional.** The warning threshold in KBps(Kilobytes per Second). No value defined as default.
3194 vmware_crit | **Optional.** The critical threshold in KBps(Kilobytes per Second). No value defined as default.
3197 ##### <a id="plugin-contrib-vmware-esx-soap-host-net-receive"></a> vmware-esx-soap-host-net-receive
3199 Check command object for the `check_vmware_esx` plugin. Data receive in KBps(Kilobytes per Second).
3201 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
3204 ------------------------|--------------
3205 vmware_host | **Required.** ESX or ESXi hostname.
3206 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. In case the check is done through a Datacenter/vCenter host.
3207 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
3208 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
3209 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
3210 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
3211 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
3212 vmware_sessionfile | **Optional.** Session file name enhancement.
3213 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
3214 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
3215 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
3216 vmware_password | **Optional.** The username's password. No value defined as default.
3217 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
3218 vmware_warn | **Optional.** The warning threshold in KBps(Kilobytes per Second). No value defined as default.
3219 vmware_crit | **Optional.** The critical threshold in KBps(Kilobytes per Second). No value defined as default.
3222 ##### <a id="plugin-contrib-vmware-esx-soap-host-net-send"></a> vmware-esx-soap-host-net-send
3224 Check command object for the `check_vmware_esx` plugin. Data send in KBps(Kilobytes per Second).
3226 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
3229 ------------------------|--------------
3230 vmware_host | **Required.** ESX or ESXi hostname.
3231 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. In case the check is done through a Datacenter/vCenter host.
3232 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
3233 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
3234 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
3235 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
3236 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
3237 vmware_sessionfile | **Optional.** Session file name enhancement.
3238 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
3239 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
3240 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
3241 vmware_password | **Optional.** The username's password. No value defined as default.
3242 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
3243 vmware_warn | **Optional.** The warning threshold in KBps(Kilobytes per Second). No value defined as default.
3244 vmware_crit | **Optional.** The critical threshold in KBps(Kilobytes per Second). No value defined as default.
3247 ##### <a id="plugin-contrib-vmware-esx-soap-host-net-nic"></a> vmware-esx-soap-host-net-nic
3249 Check command object for the `check_vmware_esx` plugin. Check all active NICs.
3251 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
3254 ------------------------|--------------
3255 vmware_host | **Required.** ESX or ESXi hostname.
3256 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. In case the check is done through a Datacenter/vCenter host.
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_exclude | **Optional.** Blacklist NICs. No value defined as default.
3269 vmware_isregexp | **Optional.** Treat blacklist expression as regexp.
3272 ##### <a id="plugin-contrib-vmware-esx-soap-host-volumes"></a> vmware-esx-soap-host-volumes
3274 Check command object for the `check_vmware_esx` plugin. Shows all datastore volumes info.
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_datacenter | **Optional.** Datacenter/vCenter hostname. In case the check is done through a Datacenter/vCenter host.
3282 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
3283 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
3284 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
3285 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
3286 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
3287 vmware_sessionfile | **Optional.** Session file name enhancement.
3288 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
3289 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
3290 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
3291 vmware_password | **Optional.** The username's password. No value defined as default.
3292 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
3293 vmware_subselect | **Optional.** Volume name to be checked the free space.
3294 vmware_gigabyte | **Optional.** Output in GB instead of MB.
3295 vmware_usedspace | **Optional.** Output used space instead of free. Defaults to "false".
3296 vmware_alertonly | **Optional.** List only alerting volumes. Defaults to "false".
3297 vmware_exclude | **Optional.** Blacklist volumes name. No value defined as default.
3298 vmware_include | **Optional.** Whitelist volumes name. No value defined as default.
3299 vmware_isregexp | **Optional.** Treat blacklist and whitelist expressions as regexp.
3300 vmware_warn | **Optional.** The warning threshold for volumes. Defaults to "80%".
3301 vmware_crit | **Optional.** The critical threshold for volumes. Defaults to "90%".
3302 vmware_spaceleft | **Optional.** This has to be used in conjunction with thresholds as mentioned above.
3305 ##### <a id="plugin-contrib-vmware-esx-soap-host-io"></a> vmware-esx-soap-host-io
3307 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.
3309 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
3312 ------------------------|--------------
3313 vmware_host | **Required.** ESX or ESXi hostname.
3314 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. In case the check is done through a Datacenter/vCenter host.
3315 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
3316 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
3317 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
3318 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
3319 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
3320 vmware_sessionfile | **Optional.** Session file name enhancement.
3321 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
3322 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
3323 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
3324 vmware_password | **Optional.** The username's password. No value defined as default.
3325 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
3328 ##### <a id="plugin-contrib-vmware-esx-soap-host-io-aborted"></a> vmware-esx-soap-host-io-aborted
3330 Check command object for the `check_vmware_esx` plugin. Number of aborted SCSI commands.
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_datacenter | **Optional.** Datacenter/vCenter hostname. In case the check is done through a Datacenter/vCenter host.
3338 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
3339 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
3340 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
3341 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
3342 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
3343 vmware_sessionfile | **Optional.** Session file name enhancement.
3344 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
3345 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
3346 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
3347 vmware_password | **Optional.** The username's password. No value defined as default.
3348 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
3349 vmware_warn | **Optional.** The warning threshold. No value defined as default.
3350 vmware_crit | **Optional.** The critical threshold. No value defined as default.
3353 ##### <a id="plugin-contrib-vmware-esx-soap-host-io-resets"></a> vmware-esx-soap-host-io-resets
3355 Check command object for the `check_vmware_esx` plugin. Number of SCSI bus resets.
3357 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
3360 ------------------------|--------------
3361 vmware_host | **Required.** ESX or ESXi hostname.
3362 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. In case the check is done through a Datacenter/vCenter host.
3363 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
3364 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
3365 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
3366 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
3367 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
3368 vmware_sessionfile | **Optional.** Session file name enhancement.
3369 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
3370 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
3371 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
3372 vmware_password | **Optional.** The username's password. No value defined as default.
3373 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
3374 vmware_warn | **Optional.** The warning threshold. No value defined as default.
3375 vmware_crit | **Optional.** The critical threshold. No value defined as default.
3378 ##### <a id="plugin-contrib-vmware-esx-soap-host-io-read"></a> vmware-esx-soap-host-io-read
3380 Check command object for the `check_vmware_esx` plugin. Average number of kilobytes read from the disk each second.
3382 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
3385 ------------------------|--------------
3386 vmware_host | **Required.** ESX or ESXi hostname.
3387 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. In case the check is done through a Datacenter/vCenter host.
3388 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
3389 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
3390 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
3391 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
3392 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
3393 vmware_sessionfile | **Optional.** Session file name enhancement.
3394 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
3395 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
3396 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
3397 vmware_password | **Optional.** The username's password. No value defined as default.
3398 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
3399 vmware_warn | **Optional.** The warning threshold. No value defined as default.
3400 vmware_crit | **Optional.** The critical threshold. No value defined as default.
3403 ##### <a id="plugin-contrib-vmware-esx-soap-host-io-read-latency"></a> vmware-esx-soap-host-io-read-latency
3405 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.
3407 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
3410 ------------------------|--------------
3411 vmware_host | **Required.** ESX or ESXi hostname.
3412 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. In case the check is done through a Datacenter/vCenter host.
3413 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
3414 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
3415 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
3416 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
3417 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
3418 vmware_sessionfile | **Optional.** Session file name enhancement.
3419 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
3420 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
3421 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
3422 vmware_password | **Optional.** The username's password. No value defined as default.
3423 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
3424 vmware_warn | **Optional.** The warning threshold. No value defined as default.
3425 vmware_crit | **Optional.** The critical threshold. No value defined as default.
3428 ##### <a id="plugin-contrib-vmware-esx-soap-host-io-write"></a> vmware-esx-soap-host-io-write
3430 Check command object for the `check_vmware_esx` plugin. Average number of kilobytes written to disk each second.
3432 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
3435 ------------------------|--------------
3436 vmware_host | **Required.** ESX or ESXi hostname.
3437 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. In case the check is done through a Datacenter/vCenter host.
3438 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
3439 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
3440 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
3441 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
3442 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
3443 vmware_sessionfile | **Optional.** Session file name enhancement.
3444 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
3445 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
3446 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
3447 vmware_password | **Optional.** The username's password. No value defined as default.
3448 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
3449 vmware_warn | **Optional.** The warning threshold. No value defined as default.
3450 vmware_crit | **Optional.** The critical threshold. No value defined as default.
3453 ##### <a id="plugin-contrib-vmware-esx-soap-host-io-write-latency"></a> vmware-esx-soap-host-io-write-latency
3455 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.
3457 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
3460 ------------------------|--------------
3461 vmware_host | **Required.** ESX or ESXi hostname.
3462 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. In case the check is done through a Datacenter/vCenter host.
3463 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
3464 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
3465 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
3466 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
3467 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
3468 vmware_sessionfile | **Optional.** Session file name enhancement.
3469 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
3470 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
3471 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
3472 vmware_password | **Optional.** The username's password. No value defined as default.
3473 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
3474 vmware_warn | **Optional.** The warning threshold. No value defined as default.
3475 vmware_crit | **Optional.** The critical threshold. No value defined as default.
3478 ##### <a id="plugin-contrib-vmware-esx-soap-host-io-usage"></a> vmware-esx-soap-host-io-usage
3480 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.
3482 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
3485 ------------------------|--------------
3486 vmware_host | **Required.** ESX or ESXi hostname.
3487 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. In case the check is done through a Datacenter/vCenter host.
3488 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
3489 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
3490 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
3491 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
3492 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
3493 vmware_sessionfile | **Optional.** Session file name enhancement.
3494 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
3495 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
3496 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
3497 vmware_password | **Optional.** The username's password. No value defined as default.
3498 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
3499 vmware_warn | **Optional.** The warning threshold. No value defined as default.
3500 vmware_crit | **Optional.** The critical threshold. No value defined as default.
3503 ##### <a id="plugin-contrib-vmware-esx-soap-host-io-kernel-latency"></a> vmware-esx-soap-host-io-kernel-latency
3505 Check command object for the `check_vmware_esx` plugin. Average amount of time (ms) spent by VMkernel processing each SCSI command.
3507 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
3510 ------------------------|--------------
3511 vmware_host | **Required.** ESX or ESXi hostname.
3512 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. In case the check is done through a Datacenter/vCenter host.
3513 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
3514 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
3515 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
3516 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
3517 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
3518 vmware_sessionfile | **Optional.** Session file name enhancement.
3519 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
3520 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
3521 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
3522 vmware_password | **Optional.** The username's password. No value defined as default.
3523 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
3524 vmware_warn | **Optional.** The warning threshold. No value defined as default.
3525 vmware_crit | **Optional.** The critical threshold. No value defined as default.
3528 ##### <a id="plugin-contrib-vmware-esx-soap-host-io-device-latency"></a> vmware-esx-soap-host-io-device-latency
3530 Check command object for the `check_vmware_esx` plugin. Average amount of time (ms) to complete a SCSI command from the physical device.
3532 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
3535 ------------------------|--------------
3536 vmware_host | **Required.** ESX or ESXi hostname.
3537 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. In case the check is done through a Datacenter/vCenter host.
3538 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
3539 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
3540 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
3541 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
3542 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
3543 vmware_sessionfile | **Optional.** Session file name enhancement.
3544 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
3545 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
3546 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
3547 vmware_password | **Optional.** The username's password. No value defined as default.
3548 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
3549 vmware_warn | **Optional.** The warning threshold. No value defined as default.
3550 vmware_crit | **Optional.** The critical threshold. No value defined as default.
3553 ##### <a id="plugin-contrib-vmware-esx-soap-host-io-queue-latency"></a> vmware-esx-soap-host-io-queue-latency
3555 Check command object for the `check_vmware_esx` plugin. Average amount of time (ms) spent in the VMkernel queue.
3557 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
3560 ------------------------|--------------
3561 vmware_host | **Required.** ESX or ESXi hostname.
3562 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. In case the check is done through a Datacenter/vCenter host.
3563 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
3564 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
3565 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
3566 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
3567 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
3568 vmware_sessionfile | **Optional.** Session file name enhancement.
3569 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
3570 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
3571 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
3572 vmware_password | **Optional.** The username's password. No value defined as default.
3573 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
3574 vmware_warn | **Optional.** The warning threshold. No value defined as default.
3575 vmware_crit | **Optional.** The critical threshold. No value defined as default.
3578 ##### <a id="plugin-contrib-vmware-esx-soap-host-io-total-latency"></a> vmware-esx-soap-host-io-total-latency
3580 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.
3582 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
3585 ------------------------|--------------
3586 vmware_host | **Required.** ESX or ESXi hostname.
3587 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. In case the check is done through a Datacenter/vCenter host.
3588 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
3589 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
3590 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
3591 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
3592 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
3593 vmware_sessionfile | **Optional.** Session file name enhancement.
3594 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
3595 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
3596 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
3597 vmware_password | **Optional.** The username's password. No value defined as default.
3598 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
3599 vmware_warn | **Optional.** The warning threshold. No value defined as default.
3600 vmware_crit | **Optional.** The critical threshold. No value defined as default.
3603 ##### <a id="plugin-contrib-vmware-esx-soap-host-media"></a> vmware-esx-soap-host-media
3605 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.
3607 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
3610 ------------------------|--------------
3611 vmware_host | **Required.** ESX or ESXi hostname.
3612 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. In case the check is done through a Datacenter/vCenter host.
3613 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
3614 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
3615 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
3616 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
3617 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
3618 vmware_sessionfile | **Optional.** Session file name enhancement.
3619 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
3620 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
3621 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
3622 vmware_password | **Optional.** The username's password. No value defined as default.
3623 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
3624 vmware_exclude | **Optional.** Blacklist VMs name. No value defined as default.
3625 vmware_include | **Optional.** Whitelist VMs name. No value defined as default.
3626 vmware_isregexp | **Optional.** Treat blacklist and whitelist expressions as regexp.
3627 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.
3630 ##### <a id="plugin-contrib-vmware-esx-soap-host-service"></a> vmware-esx-soap-host-service
3632 Check command object for the `check_vmware_esx` plugin. Shows host service info.
3634 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
3637 ------------------------|--------------
3638 vmware_host | **Required.** ESX or ESXi hostname.
3639 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. In case the check is done through a Datacenter/vCenter host.
3640 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
3641 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
3642 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
3643 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
3644 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
3645 vmware_sessionfile | **Optional.** Session file name enhancement.
3646 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
3647 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
3648 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
3649 vmware_password | **Optional.** The username's password. No value defined as default.
3650 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
3651 vmware_exclude | **Optional.** Blacklist services name. No value defined as default.
3652 vmware_include | **Optional.** Whitelist services name. No value defined as default.
3653 vmware_isregexp | **Optional.** Treat blacklist and whitelist expressions as regexp.
3654 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.
3657 ##### <a id="plugin-contrib-vmware-esx-soap-host-runtime"></a> vmware-esx-soap-host-runtime
3659 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.
3661 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
3664 ------------------------|--------------
3665 vmware_host | **Required.** ESX or ESXi hostname.
3666 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. In case the check is done through a Datacenter/vCenter host.
3667 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
3668 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
3669 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
3670 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
3671 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
3672 vmware_sessionfile | **Optional.** Session file name enhancement.
3673 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
3674 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
3675 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
3676 vmware_password | **Optional.** The username's password. No value defined as default.
3677 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
3680 ##### <a id="plugin-contrib-vmware-esx-soap-host-runtime-con"></a> vmware-esx-soap-host-runtime-con
3682 Check command object for the `check_vmware_esx` plugin. Shows connection state.
3684 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
3687 ------------------------|--------------
3688 vmware_host | **Required.** ESX or ESXi hostname.
3689 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. In case the check is done through a Datacenter/vCenter host.
3690 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
3691 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
3692 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
3693 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
3694 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
3695 vmware_sessionfile | **Optional.** Session file name enhancement.
3696 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
3697 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
3698 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
3699 vmware_password | **Optional.** The username's password. No value defined as default.
3700 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
3703 ##### <a id="plugin-contrib-vmware-esx-soap-host-runtime-listvms"></a> vmware-esx-soap-host-runtime-listvms
3705 Check command object for the `check_vmware_esx` plugin. List of VMware machines and their status.
3707 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
3710 ------------------------|--------------
3711 vmware_host | **Required.** ESX or ESXi hostname.
3712 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. In case the check is done through a Datacenter/vCenter host.
3713 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
3714 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
3715 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
3716 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
3717 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
3718 vmware_sessionfile | **Optional.** Session file name enhancement.
3719 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
3720 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
3721 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
3722 vmware_password | **Optional.** The username's password. No value defined as default.
3723 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
3724 vmware_exclude | **Optional.** Blacklist VMs name. No value defined as default.
3725 vmware_include | **Optional.** Whitelist VMs name. No value defined as default.
3726 vmware_isregexp | **Optional.** Treat blacklist and whitelist expressions as regexp.
3727 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.
3730 ##### <a id="plugin-contrib-vmware-esx-soap-host-runtime-status"></a> vmware-esx-soap-host-runtime-status
3732 Check command object for the `check_vmware_esx` plugin. Overall object status (gray/green/red/yellow).
3734 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
3737 ------------------------|--------------
3738 vmware_host | **Required.** ESX or ESXi hostname.
3739 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. In case the check is done through a Datacenter/vCenter host.
3740 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
3741 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
3742 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
3743 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
3744 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
3745 vmware_sessionfile | **Optional.** Session file name enhancement.
3746 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
3747 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
3748 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
3749 vmware_password | **Optional.** The username's password. No value defined as default.
3750 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
3753 ##### <a id="plugin-contrib-vmware-esx-soap-host-runtime-health"></a> vmware-esx-soap-host-runtime-health
3755 Check command object for the `check_vmware_esx` plugin. Checks cpu/storage/memory/sensor status.
3757 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
3760 ------------------------|--------------
3761 vmware_host | **Required.** ESX or ESXi hostname.
3762 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. In case the check is done through a Datacenter/vCenter host.
3763 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
3764 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
3765 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
3766 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
3767 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
3768 vmware_sessionfile | **Optional.** Session file name enhancement.
3769 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
3770 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
3771 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
3772 vmware_password | **Optional.** The username's password. No value defined as default.
3773 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
3774 vmware_exclude | **Optional.** Blacklist status name. No value defined as default.
3775 vmware_include | **Optional.** Whitelist status name. No value defined as default.
3776 vmware_isregexp | **Optional.** Treat blacklist and whitelist expressions as regexp.
3779 ##### <a id="plugin-contrib-vmware-esx-soap-host-runtime-health-listsensors"></a> vmware-esx-soap-host-runtime-health-listsensors
3781 Check command object for the `check_vmware_esx` plugin. List all available sensors(use for listing purpose only).
3783 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
3786 ------------------------|--------------
3787 vmware_host | **Required.** ESX or ESXi hostname.
3788 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. In case the check is done through a Datacenter/vCenter host.
3789 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
3790 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
3791 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
3792 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
3793 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
3794 vmware_sessionfile | **Optional.** Session file name enhancement.
3795 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
3796 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
3797 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
3798 vmware_password | **Optional.** The username's password. No value defined as default.
3799 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
3800 vmware_exclude | **Optional.** Blacklist status name. No value defined as default.
3801 vmware_include | **Optional.** Whitelist status name. No value defined as default.
3802 vmware_isregexp | **Optional.** Treat blacklist and whitelist expressions as regexp.
3805 ##### <a id="plugin-contrib-vmware-esx-soap-host-runtime-health-nostoragestatus"></a> vmware-esx-soap-host-runtime-health-nostoragestatus
3807 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**.
3809 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
3812 ------------------------|--------------
3813 vmware_host | **Required.** ESX or ESXi hostname.
3814 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. In case the check is done through a Datacenter/vCenter host.
3815 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
3816 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
3817 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
3818 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
3819 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
3820 vmware_sessionfile | **Optional.** Session file name enhancement.
3821 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
3822 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
3823 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
3824 vmware_password | **Optional.** The username's password. No value defined as default.
3825 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
3826 vmware_exclude | **Optional.** Blacklist status name. No value defined as default.
3827 vmware_include | **Optional.** Whitelist status name. No value defined as default.
3828 vmware_isregexp | **Optional.** Treat blacklist and whitelist expressions as regexp.
3831 ##### <a id="plugin-contrib-vmware-esx-soap-host-runtime-storagehealth"></a> vmware-esx-soap-host-runtime-storagehealth
3833 Check command object for the `check_vmware_esx` plugin. Local storage status check.
3835 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
3838 ------------------------|--------------
3839 vmware_host | **Required.** ESX or ESXi hostname.
3840 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. In case the check is done through a Datacenter/vCenter host.
3841 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
3842 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
3843 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
3844 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
3845 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
3846 vmware_sessionfile | **Optional.** Session file name enhancement.
3847 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
3848 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
3849 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
3850 vmware_password | **Optional.** The username's password. No value defined as default.
3851 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
3852 vmware_exclude | **Optional.** Blacklist storage name. No value defined as default.
3853 vmware_include | **Optional.** Whitelist storage name. No value defined as default.
3854 vmware_isregexp | **Optional.** Treat blacklist and whitelist expressions as regexp.
3855 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.
3858 ##### <a id="plugin-contrib-vmware-esx-soap-host-runtime-temp"></a> vmware-esx-soap-host-runtime-temp
3860 Check command object for the `check_vmware_esx` plugin. Lists all temperature sensors.
3862 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
3865 ------------------------|--------------
3866 vmware_host | **Required.** ESX or ESXi hostname.
3867 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. In case the check is done through a Datacenter/vCenter host.
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_datacenter | **Optional.** Datacenter/vCenter hostname. In case the check is done through a Datacenter/vCenter host.
3895 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
3896 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
3897 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
3898 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
3899 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
3900 vmware_sessionfile | **Optional.** Session file name enhancement.
3901 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
3902 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
3903 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
3904 vmware_password | **Optional.** The username's password. No value defined as default.
3905 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
3906 vmware_exclude | **Optional.** Blacklist configuration issues. No value defined as default.
3907 vmware_include | **Optional.** Whitelist configuration issues. No value defined as default.
3908 vmware_isregexp | **Optional.** Treat blacklist and whitelist expressions as regexp.
3909 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.
3912 ##### <a id="plugin-contrib-vmware-esx-soap-host-storage"></a> vmware-esx-soap-host-storage
3914 Check command object for the `check_vmware_esx` plugin. Shows Host storage info.
3916 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
3919 ------------------------|--------------
3920 vmware_host | **Required.** ESX or ESXi hostname.
3921 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. In case the check is done through a Datacenter/vCenter host.
3922 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
3923 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
3924 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
3925 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
3926 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
3927 vmware_sessionfile | **Optional.** Session file name enhancement.
3928 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
3929 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
3930 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
3931 vmware_password | **Optional.** The username's password. No value defined as default.
3932 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
3933 vmware_exclude | **Optional.** Blacklist adapters, luns and paths. No value defined as default.
3934 vmware_include | **Optional.** Whitelist adapters, luns and paths. No value defined as default.
3935 vmware_isregexp | **Optional.** Treat blacklist and whitelist expressions as regexp.
3938 ##### <a id="plugin-contrib-vmware-esx-soap-host-storage-adapter"></a> vmware-esx-soap-host-storage-adapter
3940 Check command object for the `check_vmware_esx` plugin. List host bus adapters.
3942 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
3945 ------------------------|--------------
3946 vmware_host | **Required.** ESX or ESXi hostname.
3947 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. In case the check is done through a Datacenter/vCenter host.
3948 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
3949 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
3950 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
3951 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
3952 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
3953 vmware_sessionfile | **Optional.** Session file name enhancement.
3954 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
3955 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
3956 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
3957 vmware_password | **Optional.** The username's password. No value defined as default.
3958 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
3959 vmware_exclude | **Optional.** Blacklist adapters. No value defined as default.
3960 vmware_include | **Optional.** Whitelist adapters. No value defined as default.
3961 vmware_isregexp | **Optional.** Treat blacklist and whitelist expressions as regexp.
3962 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.
3965 ##### <a id="plugin-contrib-vmware-esx-soap-host-storage-lun"></a> vmware-esx-soap-host-storage-lun
3967 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.
3969 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
3972 ------------------------|--------------
3973 vmware_host | **Required.** ESX or ESXi hostname.
3974 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. In case the check is done through a Datacenter/vCenter host.
3975 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
3976 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
3977 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
3978 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
3979 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
3980 vmware_sessionfile | **Optional.** Session file name enhancement.
3981 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
3982 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
3983 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
3984 vmware_password | **Optional.** The username's password. No value defined as default.
3985 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
3986 vmware_exclude | **Optional.** Blacklist luns. No value defined as default.
3987 vmware_include | **Optional.** Whitelist luns. No value defined as default.
3988 vmware_isregexp | **Optional.** Treat blacklist and whitelist expressions as regexp.
3989 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.
3992 ##### <a id="plugin-contrib-vmware-esx-soap-host-storage-path"></a> vmware-esx-soap-host-storage-path
3994 Check command object for the `check_vmware_esx` plugin. List multipaths and the associated paths.
3996 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
3999 ------------------------|--------------
4000 vmware_host | **Required.** ESX or ESXi hostname.
4001 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. In case the check is done through a Datacenter/vCenter host.
4002 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
4003 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
4004 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
4005 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
4006 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
4007 vmware_sessionfile | **Optional.** Session file name enhancement.
4008 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
4009 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
4010 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
4011 vmware_password | **Optional.** The username's password. No value defined as default.
4012 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
4013 vmware_alertonly | **Optional.** List only alerting units. Important here to avoid masses of data. Defaults to "false".
4014 vmware_exclude | **Optional.** Blacklist paths. No value defined as default.
4015 vmware_include | **Optional.** Whitelist paths. No value defined as default.
4016 vmware_isregexp | **Optional.** Treat blacklist and whitelist expressions as regexp.
4017 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.
4020 ##### <a id="plugin-contrib-vmware-esx-soap-vm-cpu"></a> vmware-esx-soap-vm-cpu
4022 Check command object for the `check_vmware_esx` plugin. Shows all CPU usage info.
4024 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
4027 ------------------------|--------------
4028 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. Conflicts with **vmware_host**.
4029 vmware_host | **Optional.** ESX or ESXi hostname. Conflicts with **vmware_datacenter**.
4030 vmware_vmname | **Required.** Virtual machine name.
4031 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
4032 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
4033 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
4034 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
4035 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
4036 vmware_sessionfile | **Optional.** Session file name enhancement.
4037 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
4038 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
4039 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
4040 vmware_password | **Optional.** The username's password. No value defined as default.
4041 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
4045 ##### <a id="plugin-contrib-vmware-esx-soap-vm-cpu-ready"></a> vmware-esx-soap-vm-cpu-ready
4047 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.
4049 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
4052 ------------------------|--------------
4053 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. Conflicts with **vmware_host**.
4054 vmware_host | **Optional.** ESX or ESXi hostname. Conflicts with **vmware_datacenter**.
4055 vmware_vmname | **Required.** Virtual machine name.
4056 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
4057 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
4058 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
4059 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
4060 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
4061 vmware_sessionfile | **Optional.** Session file name enhancement.
4062 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
4063 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
4064 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
4065 vmware_password | **Optional.** The username's password. No value defined as default.
4066 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
4067 vmware_warn | **Optional.** The warning threshold. No value defined as default.
4068 vmware_crit | **Optional.** The critical threshold. No value defined as default.
4071 ##### <a id="plugin-contrib-vmware-esx-soap-vm-cpu-wait"></a> vmware-esx-soap-vm-cpu-wait
4073 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.
4075 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
4078 ------------------------|--------------
4079 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. Conflicts with **vmware_host**.
4080 vmware_host | **Optional.** ESX or ESXi hostname. Conflicts with **vmware_datacenter**.
4081 vmware_vmname | **Required.** Virtual machine name.
4082 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
4083 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
4084 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
4085 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
4086 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
4087 vmware_sessionfile | **Optional.** Session file name enhancement.
4088 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
4089 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
4090 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
4091 vmware_password | **Optional.** The username's password. No value defined as default.
4092 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
4093 vmware_warn | **Optional.** The warning threshold. No value defined as default.
4094 vmware_crit | **Optional.** The critical threshold. No value defined as default.
4097 ##### <a id="plugin-contrib-vmware-esx-soap-vm-cpu-usage"></a> vmware-esx-soap-vm-cpu-usage
4099 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.
4101 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
4104 ------------------------|--------------
4105 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. Conflicts with **vmware_host**.
4106 vmware_host | **Optional.** ESX or ESXi hostname. Conflicts with **vmware_datacenter**.
4107 vmware_vmname | **Required.** Virtual machine name.
4108 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
4109 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
4110 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
4111 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
4112 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
4113 vmware_sessionfile | **Optional.** Session file name enhancement.
4114 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
4115 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
4116 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
4117 vmware_password | **Optional.** The username's password. No value defined as default.
4118 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
4119 vmware_warn | **Optional.** Warning threshold in percent. Defaults to "80%".
4120 vmware_crit | **Optional.** Critical threshold in percent. Defaults to "90%".
4123 ##### <a id="plugin-contrib-vmware-esx-soap-vm-mem"></a> vmware-esx-soap-vm-mem
4125 Check command object for the `check_vmware_esx` plugin. Shows all memory info, except overall.
4127 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
4130 ------------------------|--------------
4131 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. Conflicts with **vmware_host**.
4132 vmware_host | **Optional.** ESX or ESXi hostname. Conflicts with **vmware_datacenter**.
4133 vmware_vmname | **Required.** Virtual machine name.
4134 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
4135 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
4136 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
4137 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
4138 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
4139 vmware_sessionfile | **Optional.** Session file name enhancement.
4140 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
4141 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
4142 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
4143 vmware_password | **Optional.** The username's password. No value defined as default.
4144 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
4147 ##### <a id="plugin-contrib-vmware-esx-soap-vm-mem-usage"></a> vmware-esx-soap-vm-mem-usage
4149 Check command object for the `check_vmware_esx` plugin. Average mem usage in percentage of configured virtual machine "physical" memory.
4151 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
4154 ------------------------|--------------
4155 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. Conflicts with **vmware_host**.
4156 vmware_host | **Optional.** ESX or ESXi hostname. Conflicts with **vmware_datacenter**.
4157 vmware_vmname | **Required.** Virtual machine name.
4158 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
4159 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
4160 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
4161 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
4162 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
4163 vmware_sessionfile | **Optional.** Session file name enhancement.
4164 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
4165 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
4166 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
4167 vmware_password | **Optional.** The username's password. No value defined as default.
4168 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
4169 vmware_warn | **Optional.** Warning threshold in percent. Defaults to "80%".
4170 vmware_crit | **Optional.** Critical threshold in percent. Defaults to "90%".
4173 ##### <a id="plugin-contrib-vmware-esx-soap-vm-mem-consumed"></a> vmware-esx-soap-vm-mem-consumed
4175 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>
4176 **vm consumed memory = memory granted -- memory saved**
4178 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
4181 ------------------------|--------------
4182 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. Conflicts with **vmware_host**.
4183 vmware_host | **Optional.** ESX or ESXi hostname. Conflicts with **vmware_datacenter**.
4184 vmware_vmname | **Required.** Virtual machine name.
4185 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
4186 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
4187 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
4188 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
4189 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
4190 vmware_sessionfile | **Optional.** Session file name enhancement.
4191 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
4192 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
4193 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
4194 vmware_password | **Optional.** The username's password. No value defined as default.
4195 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
4196 vmware_warn | **Optional.** The warning threshold. No value defined as default.
4197 vmware_crit | **Optional.** The critical threshold. No value defined as default.
4200 ##### <a id="plugin-contrib-vmware-esx-soap-vm-mem-memctl"></a> vmware-esx-soap-vm-mem-memctl
4202 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.
4204 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
4207 ------------------------|--------------
4208 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. Conflicts with **vmware_host**.
4209 vmware_host | **Optional.** ESX or ESXi hostname. Conflicts with **vmware_datacenter**.
4210 vmware_vmname | **Required.** Virtual machine name.
4211 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
4212 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
4213 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
4214 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
4215 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
4216 vmware_sessionfile | **Optional.** Session file name enhancement.
4217 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
4218 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
4219 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
4220 vmware_password | **Optional.** The username's password. No value defined as default.
4221 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
4222 vmware_warn | **Optional.** The warning threshold. No value defined as default.
4223 vmware_crit | **Optional.** The critical threshold. No value defined as default.
4227 ##### <a id="plugin-contrib-vmware-esx-soap-vm-net"></a> vmware-esx-soap-vm-net
4229 Check command object for the `check_vmware_esx` plugin. Shows net info.
4231 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
4234 ------------------------|--------------
4235 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. Conflicts with **vmware_host**.
4236 vmware_host | **Optional.** ESX or ESXi hostname. Conflicts with **vmware_datacenter**.
4237 vmware_vmname | **Required.** Virtual machine name.
4238 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
4239 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
4240 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
4241 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
4242 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
4243 vmware_sessionfile | **Optional.** Session file name enhancement.
4244 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
4245 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
4246 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
4247 vmware_password | **Optional.** The username's password. No value defined as default.
4248 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
4251 ##### <a id="plugin-contrib-vmware-esx-soap-vm-net-usage"></a> vmware-esx-soap-vm-net-usage
4253 Check command object for the `check_vmware_esx` plugin. Overall network usage in KBps(Kilobytes per Second).
4255 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
4258 ------------------------|--------------
4259 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. Conflicts with **vmware_host**.
4260 vmware_host | **Optional.** ESX or ESXi hostname. Conflicts with **vmware_datacenter**.
4261 vmware_vmname | **Required.** Virtual machine name.
4262 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
4263 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
4264 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
4265 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
4266 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
4267 vmware_sessionfile | **Optional.** Session file name enhancement.
4268 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
4269 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
4270 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
4271 vmware_password | **Optional.** The username's password. No value defined as default.
4272 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
4273 vmware_warn | **Optional.** The warning threshold. No value defined as default.
4274 vmware_crit | **Optional.** The critical threshold. No value defined as default.
4277 ##### <a id="plugin-contrib-vmware-esx-soap-vm-net-receive"></a> vmware-esx-soap-vm-net-receive
4279 Check command object for the `check_vmware_esx` plugin. Receive in KBps(Kilobytes per Second).
4281 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
4284 ------------------------|--------------
4285 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. Conflicts with **vmware_host**.
4286 vmware_host | **Optional.** ESX or ESXi hostname. Conflicts with **vmware_datacenter**.
4287 vmware_vmname | **Required.** Virtual machine name.
4288 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
4289 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
4290 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
4291 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
4292 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
4293 vmware_sessionfile | **Optional.** Session file name enhancement.
4294 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
4295 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
4296 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
4297 vmware_password | **Optional.** The username's password. No value defined as default.
4298 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
4299 vmware_warn | **Optional.** The warning threshold. No value defined as default.
4300 vmware_crit | **Optional.** The critical threshold. No value defined as default.
4303 ##### <a id="plugin-contrib-vmware-esx-soap-vm-net-send"></a> vmware-esx-soap-vm-net-send
4305 Check command object for the `check_vmware_esx` plugin. Send in KBps(Kilobytes per Second).
4307 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
4310 ------------------------|--------------
4311 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. Conflicts with **vmware_host**.
4312 vmware_host | **Optional.** ESX or ESXi hostname. Conflicts with **vmware_datacenter**.
4313 vmware_vmname | **Required.** Virtual machine name.
4314 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
4315 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
4316 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
4317 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
4318 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
4319 vmware_sessionfile | **Optional.** Session file name enhancement.
4320 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
4321 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
4322 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
4323 vmware_password | **Optional.** The username's password. No value defined as default.
4324 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
4325 vmware_warn | **Optional.** The warning threshold. No value defined as default.
4326 vmware_crit | **Optional.** The critical threshold. No value defined as default.
4329 ##### <a id="plugin-contrib-vmware-esx-soap-vm-io"></a> vmware-esx-soap-vm-io
4331 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.
4333 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
4336 ------------------------|--------------
4337 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. Conflicts with **vmware_host**.
4338 vmware_host | **Optional.** ESX or ESXi hostname. Conflicts with **vmware_datacenter**.
4339 vmware_vmname | **Required.** Virtual machine name.
4340 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
4341 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
4342 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
4343 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
4344 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
4345 vmware_sessionfile | **Optional.** Session file name enhancement.
4346 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
4347 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
4348 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
4349 vmware_password | **Optional.** The username's password. No value defined as default.
4350 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
4353 ##### <a id="plugin-contrib-vmware-esx-soap-vm-io-read"></a> vmware-esx-soap-vm-io-read
4355 Check command object for the `check_vmware_esx` plugin. Average number of kilobytes read from the disk each second.
4357 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
4360 ------------------------|--------------
4361 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. Conflicts with **vmware_host**.
4362 vmware_host | **Optional.** ESX or ESXi hostname. Conflicts with **vmware_datacenter**.
4363 vmware_vmname | **Required.** Virtual machine name.
4364 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
4365 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
4366 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
4367 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
4368 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
4369 vmware_sessionfile | **Optional.** Session file name enhancement.
4370 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
4371 vmware_nosession | **Optional.** No auth session - IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
4372 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
4373 vmware_password | **Optional.** The username's password. No value defined as default.
4374 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
4375 vmware_warn | **Optional.** The warning threshold. No value defined as default.
4376 vmware_crit | **Optional.** The critical threshold. No value defined as default.
4379 ##### <a id="plugin-contrib-vmware-esx-soap-vm-io-write"></a> vmware-esx-soap-vm-io-write
4381 Check command object for the `check_vmware_esx` plugin. Average number of kilobytes written to disk each second.
4383 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
4386 ------------------------|--------------
4387 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. Conflicts with **vmware_host**.
4388 vmware_host | **Optional.** ESX or ESXi hostname. Conflicts with **vmware_datacenter**.
4389 vmware_vmname | **Required.** Virtual machine name.
4390 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
4391 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
4392 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
4393 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
4394 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
4395 vmware_sessionfile | **Optional.** Session file name enhancement.
4396 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
4397 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
4398 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
4399 vmware_password | **Optional.** The username's password. No value defined as default.
4400 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
4401 vmware_warn | **Optional.** The warning threshold. No value defined as default.
4402 vmware_crit | **Optional.** The critical threshold. No value defined as default.
4405 ##### <a id="plugin-contrib-vmware-esx-soap-vm-io-usage"></a> vmware-esx-soap-vm-io-usage
4407 Check command object for the `check_vmware_esx` plugin. Aggregated disk I/O rate.
4409 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
4412 ------------------------|--------------
4413 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. Conflicts with **vmware_host**.
4414 vmware_host | **Optional.** ESX or ESXi hostname. Conflicts with **vmware_datacenter**.
4415 vmware_vmname | **Required.** Virtual machine name.
4416 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
4417 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
4418 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
4419 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
4420 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
4421 vmware_sessionfile | **Optional.** Session file name enhancement.
4422 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
4423 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
4424 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
4425 vmware_password | **Optional.** The username's password. No value defined as default.
4426 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
4427 vmware_warn | **Optional.** The warning threshold. No value defined as default.
4428 vmware_crit | **Optional.** The critical threshold. No value defined as default.
4431 ##### <a id="plugin-contrib-vmware-esx-soap-vm-runtime"></a> vmware-esx-soap-vm-runtime
4433 Check command object for the `check_vmware_esx` plugin. Shows virtual machine runtime info.
4435 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
4438 ------------------------|--------------
4439 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. Conflicts with **vmware_host**.
4440 vmware_host | **Optional.** ESX or ESXi hostname. Conflicts with **vmware_datacenter**.
4441 vmware_vmname | **Required.** Virtual machine name.
4442 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
4443 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
4444 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
4445 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
4446 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
4447 vmware_sessionfile | **Optional.** Session file name enhancement.
4448 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
4449 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
4450 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
4451 vmware_password | **Optional.** The username's password. No value defined as default.
4452 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
4455 ##### <a id="plugin-contrib-vmware-esx-soap-vm-runtime-con"></a> vmware-esx-soap-vm-runtime-con
4457 Check command object for the `check_vmware_esx` plugin. Shows the connection state.
4459 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
4462 ------------------------|--------------
4463 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. Conflicts with **vmware_host**.
4464 vmware_host | **Optional.** ESX or ESXi hostname. Conflicts with **vmware_datacenter**.
4465 vmware_vmname | **Required.** Virtual machine name.
4466 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
4467 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
4468 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
4469 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
4470 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
4471 vmware_sessionfile | **Optional.** Session file name enhancement.
4472 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
4473 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
4474 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
4475 vmware_password | **Optional.** The username's password. No value defined as default.
4476 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
4479 ##### <a id="plugin-contrib-vmware-esx-soap-vm-runtime-powerstate"></a> vmware-esx-soap-vm-runtime-powerstate
4481 Check command object for the `check_vmware_esx` plugin. Shows virtual machine power state: poweredOn, poweredOff or suspended.
4483 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
4486 ------------------------|--------------
4487 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. Conflicts with **vmware_host**.
4488 vmware_host | **Optional.** ESX or ESXi hostname. Conflicts with **vmware_datacenter**.
4489 vmware_vmname | **Required.** Virtual machine name.
4490 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
4491 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
4492 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
4493 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
4494 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
4495 vmware_sessionfile | **Optional.** Session file name enhancement.
4496 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
4497 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
4498 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
4499 vmware_password | **Optional.** The username's password. No value defined as default.
4500 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
4503 ##### <a id="plugin-contrib-vmware-esx-soap-vm-runtime-status"></a> vmware-esx-soap-vm-runtime-status
4505 Check command object for the `check_vmware_esx` plugin. Overall object status (gray/green/red/yellow).
4507 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
4510 ------------------------|--------------
4511 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. Conflicts with **vmware_host**.
4512 vmware_host | **Optional.** ESX or ESXi hostname. Conflicts with **vmware_datacenter**.
4513 vmware_vmname | **Required.** Virtual machine name.
4514 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
4515 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
4516 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
4517 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
4518 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
4519 vmware_sessionfile | **Optional.** Session file name enhancement.
4520 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
4521 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
4522 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
4523 vmware_password | **Optional.** The username's password. No value defined as default.
4524 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
4527 ##### <a id="plugin-contrib-vmware-esx-soap-vm-runtime-consoleconnections"></a> vmware-esx-soap-vm-runtime-consoleconnections
4529 Check command object for the `check_vmware_esx` plugin. Console connections to virtual machine.
4531 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
4534 ------------------------|--------------
4535 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. Conflicts with **vmware_host**.
4536 vmware_host | **Optional.** ESX or ESXi hostname. Conflicts with **vmware_datacenter**.
4537 vmware_vmname | **Required.** Virtual machine name.
4538 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
4539 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
4540 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
4541 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
4542 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
4543 vmware_sessionfile | **Optional.** Session file name enhancement.
4544 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
4545 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
4546 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
4547 vmware_password | **Optional.** The username's password. No value defined as default.
4548 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
4549 vmware_warn | **Optional.** The warning threshold. No value defined as default.
4550 vmware_crit | **Optional.** The critical threshold. No value defined as default.
4553 ##### <a id="plugin-contrib-vmware-esx-soap-vm-runtime-gueststate"></a> vmware-esx-soap-vm-runtime-gueststate
4555 Check command object for the `check_vmware_esx` plugin. Guest OS status. Needs VMware Tools installed and running.
4557 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
4560 ------------------------|--------------
4561 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. Conflicts with **vmware_host**.
4562 vmware_host | **Optional.** ESX or ESXi hostname. Conflicts with **vmware_datacenter**.
4563 vmware_vmname | **Required.** Virtual machine name.
4564 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
4565 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
4566 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
4567 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
4568 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
4569 vmware_sessionfile | **Optional.** Session file name enhancement.
4570 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
4571 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
4572 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
4573 vmware_password | **Optional.** The username's password. No value defined as default.
4574 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
4576 ##### <a id="plugin-contrib-vmware-esx-soap-vm-runtime-tools"></a> vmware-esx-soap-vm-runtime-tools
4578 Check command object for the `check_vmware_esx` plugin. Guest OS status. VMware tools status.
4580 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
4583 ------------------------|--------------
4584 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. Conflicts with **vmware_host**.
4585 vmware_host | **Optional.** ESX or ESXi hostname. Conflicts with **vmware_datacenter**.
4586 vmware_vmname | **Required.** Virtual machine name.
4587 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
4588 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
4589 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
4590 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
4591 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
4592 vmware_sessionfile | **Optional.** Session file name enhancement.
4593 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
4594 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
4595 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
4596 vmware_password | **Optional.** The username's password. No value defined as default.
4597 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
4598 vmware_openvmtools | **Optional** Prevent CRITICAL state for installed and running Open VM Tools.
4601 ##### <a id="plugin-contrib-vmware-esx-soap-vm-runtime-issues"></a> vmware-esx-soap-vm-runtime-issues
4603 Check command object for the `check_vmware_esx` plugin. All issues for the virtual machine.
4605 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
4608 ------------------------|--------------
4609 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. Conflicts with **vmware_host**.
4610 vmware_host | **Optional.** ESX or ESXi hostname. Conflicts with **vmware_datacenter**.
4611 vmware_vmname | **Required.** Virtual machine name.
4612 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
4613 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
4614 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
4615 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
4616 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
4617 vmware_sessionfile | **Optional.** Session file name enhancement.
4618 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
4619 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
4620 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
4621 vmware_password | **Optional.** The username's password. No value defined as default.
4622 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
4623 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.
4626 ### <a id="plugin-contrib-web"></a> Web
4628 This category includes all plugins for web-based checks.
4630 #### <a id="plugin-contrib-command-webinject"></a> webinject
4632 Check command object for the [check_webinject](http://www.webinject.org/manual.html) plugin.
4634 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
4637 ------------------------|--------------
4638 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.
4639 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.
4640 webinject_no_output | **Optional.** Suppresses all output to STDOUT except the results summary.
4641 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.
4642 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.
4643 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.
4645 #### <a id="plugin-contrib-command-jmx4perl"></a> jmx4perl
4647 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.
4649 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
4652 -----------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------
4653 jmx4perl_url | **Required.** URL to agent web application. Defaults to "http://$address$:8080/jolokia".
4654 jmx4perl_product | **Optional.** Name of app server product (e.g. jboss), by default is uses an autodetection facility.
4655 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.
4656 jmx4perl_mbean | **Optional.** MBean name (e.g. java.lang:type=Memory).
4657 jmx4perl_attribute | **Optional.** Attribute name (e.g. HeapMemoryUsage).
4658 jmx4perl_operation | **Optional.** Operation to execute.
4659 jmx4perl_value | **Optional.** Shortcut for specifying mbean/attribute/path. Slashes within names must be escaped with backslash.
4660 jmx4perl_delta | **Optional.** Switches on incremental mode. Optional argument are seconds used for normalizing.
4661 jmx4perl_path | **Optional.** Inner path for extracting a single value from a complex attribute or return value (e.g. used).
4662 jmx4perl_target | **Optional.** JSR-160 Service URL specifing the target server.
4663 jmx4perl_target_user | **Optional.** Username to use for JSR-160 connection.
4664 jmx4perl_target_password | **Optional.** Password to use for JSR-160 connection.
4665 jmx4perl_proxy | **Optional.** Proxy to use.
4666 jmx4perl_user | **Optional.** User for HTTP authentication.
4667 jmx4perl_password | **Optional.** Password for HTTP authentication.
4668 jmx4perl_name | **Optional.** Name to use for output, by default a standard value based on the MBean and attribute will be used.
4669 jmx4perl_method | **Optional.** HTTP method to use, either get or post. By default a method is determined automatically based on the request type.
4670 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.
4671 jmx4perl_base_mbean | **Optional.** Base MBean name, interprets critical and warning values as relative in the range 0 .. 100%. Requires "jmx4perl_base_attribute".
4672 jmx4perl_base_attribute | **Optional.** Base attribute for a relative check. Requires "jmx4perl_base_mbean".
4673 jmx4perl_base_path | **Optional.** Base path for relative checks, where this path is used on the base attribute's value.
4674 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.
4675 jmx4perl_null | **Optional.** Value which should be used in case of a null return value of an operation or attribute. Defaults to null.
4676 jmx4perl_string | **Optional.** Force string comparison for critical and warning checks. Defaults to false.
4677 jmx4perl_numeric | **Optional.** Force numeric comparison for critical and warning checks. Defaults to false.
4678 jmx4perl_critical | **Optional.** Critical threshold for value.
4679 jmx4perl_warning | **Optional.** Warning threshold for value.
4680 jmx4perl_label | **Optional.** Label to be used for printing out the result of the check. For placeholders which can be used see the documentation.
4681 jmx4perl_perfdata | **Optional.** Whether performance data should be omitted, which are included by default. Defaults to "on" for numeric values, to "off" for strings.
4682 jmx4perl_unknown_is_critical | **Optional.** Map UNKNOWN errors to errors with a CRITICAL status. Defaults to false.
4683 jmx4perl_timeout | **Optional.** Seconds before plugin times out. Defaults to "15".
4684 jmx4perl_config | **Optional.** Path to configuration file.
4685 jmx4perl_server | **Optional.** Symbolic name of server url to use, which needs to be configured in the configuration file.
4686 jmx4perl_check | **Optional.** Name of a check configuration as defined in the configuration file, use array if you need arguments.
4688 #### <a id="plugin-contrib-command-squid"></a> squid
4690 Plugin for monitoring [Squid](https://exchange.icinga.org/exchange/check_squid).
4692 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
4695 ------------------------|----------------------------------------------------------------------------------
4696 squid_hostname | **Optional.** The host's address. Defaults to "$address$" if the host's `address` attribute is set, "$address6$" otherwise.
4697 squid_data | **Optional.** Data to fetch (default: Connections) available data: Connections Cache Resources Memory FileDescriptors.
4698 squid_port | **Optional.** Port number (default: 3128).
4699 squid_user | **Optional.** WWW user
4700 squid_password | **Optional.** WWW password
4701 squid_warning | **Optional.** Warning threshold. See http://nagiosplug.sourceforge.net/developer-guidelines.html#THRESHOLDFORMAT for the threshold format.
4702 squid_critical | **Optional.** Critical threshold. See http://nagiosplug.sourceforge.net/developer-guidelines.html#THRESHOLDFORMAT for the threshold format.
4703 squid_client | **Optional.** Path of squidclient (default: /usr/bin/squidclient).
4704 squid_timeout | **Optional.** Seconds before plugin times out (default: 15).
4707 #### <a id="plugin-contrib-command-nginx_status"></a> nginx_status
4709 Plugin for monitoring [nginx_status](https://github.com/regilero/check_nginx_status).
4711 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
4714 ------------------------|----------------------------------------------------------------------------------
4715 nginx_status_host_address | **Optional.** The host's address. Defaults to "$address$" if the host's `address` attribute is set, `address6` otherwise.
4716 nginx_status_port | **Optional.** the http port.
4717 nginx_status_url | **Optional.** URL to use, instead of the default (http://`nginx_status_hostname`/nginx_status).
4718 nginx_status_servername | **Optional.** ServerName to use if you specified an IP to match the good Virtualhost in your target
4719 nginx_status_ssl | **Optional.** set to use ssl connection
4720 nginx_status_disable_sslverify | **Optional.** set to disable SSL hostname verification
4721 nginx_status_user | **Optional.** Username for basic auth
4722 nginx_status_pass | **Optional.** Password for basic auth
4723 nginx_status_realm | **Optional.** Realm for basic auth
4724 nginx_status_maxreach | **Optional.** Number of max processes reached (since last check) that should trigger an alert
4725 nginx_status_timeout | **Optional.** timeout in seconds
4726 nginx_status_warn | **Optional.** Warning threshold (number of active connections, ReqPerSec or ConnPerSec that will cause a WARNING) like '10000,100,200'.
4727 nginx_status_critical | **Optional.** Critical threshold (number of active connections, ReqPerSec or ConnPerSec that will cause a CRITICAL) like '20000,200,300'.
4730 #### <a id="plugin-contrib-command-apache_status"></a> apache_status
4732 Plugin for monitoring [apache_status](https://github.com/lbetz/check_apache_status).
4734 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
4737 ------------------------|----------------------------------------------------------------------------------
4738 apache_status_address | **Optional.** The host's address. Defaults to "$address$" if the host's `address` attribute is set, `address6` otherwise.
4739 apache_status_port | **Optional.** the http port.
4740 apache_status_url | **Optional.** URL to use, instead of the default (http://`apache_status_address`/server-status).
4741 apache_status_ssl | **Optional.** set to use ssl connection
4742 apache_status_timeout | **Optional.** timeout in seconds
4743 apache_status_warning | **Optional.** Warning threshold (number of open slots, busy workers and idle workers that will cause a WARNING) like ':20,50,:50'.
4744 apache_status_critical | **Optional.** Critical threshold (number of open slots, busy workers and idle workers that will cause a CRITICAL) like ':10,25,:20'.
4747 #### <a id="plugin-contrib-command-kdc"></a> kdc
4749 Plugin for monitoring [kdc](https://exchange.nagios.org/directory/Plugins/Security/check_kdc/details).
4751 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
4754 ----------------|--------------------------------------------------------------------------
4755 kdc_address | **Optional.** The host's address. Defaults to "$address$" if the host's `address` attribute is set, `address6` otherwise.
4756 kdc_port | **Optional** Port on which KDC runs (default 88).
4757 kdc_principal | **Required** Principal name to authenticate as (including realm).
4758 kdc_keytab | **Required** Keytab file containing principal's key.
4761 #### <a id="plugin-contrib-command-rbl"></a> rbl
4763 Plugin for monitoring [rbl](https://github.com/matteocorti/check_rbl)
4765 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
4768 ----------------|--------------------------------------------------------------------------
4769 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.
4770 rbl_server | **Required** List of RBL servers as an array.
4771 rbl_warning | **Optional** Number of blacklisting servers for a warning.
4772 rbl_critical | **Optional** Number of blacklisting servers for a critical.
4773 tbl_timeout | **Optional** Seconds before plugin times out (default: 15).