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).
143 apt_only_critical | **Optional.** Only warn about critical upgrades.
146 ### <a id="plugin-check-command-breeze"></a> breeze
148 The [check_breeze](https://www.monitoring-plugins.org/doc/man/check_breeze.html) plugin reports the signal
149 strength of a Breezecom wireless equipment.
151 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
154 -----------------|---------------------------------
155 breeze_hostname | **Required.** Name or IP address of host to check. Defaults to "$address$" if the host's `address` attribute is set, "$address6$" otherwise.
156 breeze_community | **Optional.** SNMPv1 community. Defaults to "public".
157 breeze_warning | **Required.** Percentage strength below which a WARNING status will result. Defaults to 50.
158 breeze_critical | **Required.** Percentage strength below which a WARNING status will result. Defaults to 20.
161 ### <a id="plugin-check-command-by-ssh"></a> by_ssh
163 The [check_by_ssh](https://www.monitoring-plugins.org/doc/man/check_by_ssh.html) plugin uses SSH to execute
164 commands on a remote host.
166 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
169 ----------------|--------------
170 by_ssh_address | **Optional.** The host's address. Defaults to "$address$" if the host's `address` attribute is set, "$address6$" otherwise.
171 by_ssh_port | **Optional.** The SSH port. Defaults to 22.
172 by_ssh_command | **Required.** The command that should be executed. Can be an array if multiple arguments should be passed to `check_by_ssh`.
173 by_ssh_arguments| **Optional.** A dictionary with arguments for the command. This works exactly like the 'arguments' dictionary for ordinary CheckCommands.
174 by_ssh_logname | **Optional.** The SSH username.
175 by_ssh_identity | **Optional.** The SSH identity.
176 by_ssh_quiet | **Optional.** Whether to suppress SSH warnings. Defaults to false.
177 by_ssh_warn | **Optional.** The warning threshold.
178 by_ssh_crit | **Optional.** The critical threshold.
179 by_ssh_timeout | **Optional.** The timeout in seconds.
180 by_ssh_options | **Optional.** Call ssh with '-o OPTION' (multiple options may be specified as an array).
181 by_ssh_ipv4 | **Optional.** Use IPv4 connection. Defaults to false.
182 by_ssh_ipv6 | **Optional.** Use IPv6 connection. Defaults to false.
185 ### <a id="plugin-check-command-clamd"></a> clamd
187 The [check_clamd](https://www.monitoring-plugins.org/doc/man/check_clamd.html) plugin tests CLAMD
188 connections with the specified host (or unix socket).
190 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
193 -------------------|--------------
194 clamd_address | **Required.** The host's address or unix socket (must be an absolute path).
195 clamd_port | **Optional.** Port number (default: none).
196 clamd_expect | **Optional.** String to expect in server response. Multiple strings must be defined as array.
197 clamd_all | **Optional.** All expect strings need to occur in server response. Defaults to false.
198 clamd_escape_send | **Optional.** Enable usage of \\n, \\r, \\t or \\\\ in send string.
199 clamd_send | **Optional.** String to send to the server.
200 clamd_escape_quit | **Optional.** Enable usage of \\n, \\r, \\t or \\\\ in quit string.
201 clamd_quit | **Optional.** String to send server to initiate a clean close of the connection.
202 clamd_refuse | **Optional.** Accept TCP refusals with states ok, warn, crit. Defaults to crit.
203 clamd_mismatch | **Optional.** Accept expected string mismatches with states ok, warn, crit. Defaults to warn.
204 clamd_jail | **Optional.** Hide output from TCP socket.
205 clamd_maxbytes | **Optional.** Close connection once more than this number of bytes are received.
206 clamd_delay | **Optional.** Seconds to wait between sending string and polling for response.
207 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.
208 clamd_ssl | **Optional.** Use SSL for the connection. Defaults to false.
209 clamd_wtime | **Optional.** Response time to result in warning status (seconds).
210 clamd_ctime | **Optional.** Response time to result in critical status (seconds).
211 clamd_timeout | **Optional.** Seconds before connection times out. Defaults to 10.
212 clamd_ipv4 | **Optional.** Use IPv4 connection. Defaults to false.
213 clamd_ipv6 | **Optional.** Use IPv6 connection. Defaults to false.
216 ### <a id="plugin-check-command-dhcp"></a> dhcp
218 The [check_dhcp](https://www.monitoring-plugins.org/doc/man/check_dhcp.html) plugin
219 tests the availability of DHCP servers on a network.
221 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
224 ----------------|--------------
225 dhcp_serverip | **Optional.** The IP address of the DHCP server which we should get a response from.
226 dhcp_requestedip| **Optional.** The IP address which we should be offered by a DHCP server.
227 dhcp_timeout | **Optional.** The timeout in seconds.
228 dhcp_interface | **Optional.** The interface to use.
229 dhcp_mac | **Optional.** The MAC address to use in the DHCP request.
230 dhcp_unicast | **Optional.** Whether to use unicast requests. Defaults to false.
233 ### <a id="plugin-check-command-dig"></a> dig
235 The [check_dig](https://www.monitoring-plugins.org/doc/man/check_dig.html) plugin
236 test the DNS service on the specified host using dig.
238 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
241 ---------------------|--------------
242 dig_server | **Optional.** The DNS server to query. Defaults to "127.0.0.1".
243 dig_port | **Optional.** Port number (default: 53).
244 dig_lookup | **Required.** The address that should be looked up.
245 dig_record_type | **Optional.** Record type to lookup (default: A).
246 dig_expected_address | **Optional.** An address expected to be in the answer section. If not set, uses whatever was in -l.
247 dig_arguments | **Optional.** Pass STRING as argument(s) to dig.
248 dig_retries | **Optional.** Number of retries passed to dig, timeout is divided by this value (Default: 3).
249 dig_warning | **Optional.** Response time to result in warning status (seconds).
250 dig_critical | **Optional.** Response time to result in critical status (seconds).
251 dig_timeout | **Optional.** Seconds before connection times out (default: 10).
252 dig_ipv4 | **Optional.** Force dig to only use IPv4 query transport. Defaults to false.
253 dig_ipv6 | **Optional.** Force dig to only use IPv6 query transport. Defaults to false.
256 ### <a id="plugin-check-command-disk"></a> disk
258 The [check_disk](https://www.monitoring-plugins.org/doc/man/check_disk.html) plugin
259 checks the amount of used disk space on a mounted file system and generates an alert
260 if free space is less than one of the threshold values.
262 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
265 --------------------|------------------------
266 disk\_wfree | **Optional.** The free space warning threshold. Defaults to "20%". If the percent sign is omitted, units from `disk_units` are used.
267 disk\_cfree | **Optional.** The free space critical threshold. Defaults to "10%". If the percent sign is omitted, units from `disk_units` are used.
268 disk\_inode\_wfree | **Optional.** The free inode warning threshold.
269 disk\_inode\_cfree | **Optional.** The free inode critical threshold.
270 disk\_partition | **Optional.** The partition. **Deprecated in 2.3.**
271 disk\_partition\_excluded | **Optional.** The excluded partition. **Deprecated in 2.3.**
272 disk\_partitions | **Optional.** The partition(s). Multiple partitions must be defined as array.
273 disk\_partitions\_excluded | **Optional.** The excluded partition(s). Multiple partitions must be defined as array.
274 disk\_clear | **Optional.** Clear thresholds. May be true or false.
275 disk\_exact\_match | **Optional.** For paths or partitions specified with -p, only check for exact paths. May be true or false.
276 disk\_errors\_only | **Optional.** Display only devices/mountpoints with errors. May be true or false.
277 disk\_ignore\_reserved | **Optional.** If set, account root-reserved blocks are not accounted for freespace in perfdata. May be true or false.
278 disk\_group | **Optional.** Group paths. Thresholds apply to (free-)space of all partitions together.
279 disk\_kilobytes | **Optional.** Same as --units kB. May be true or false.
280 disk\_local | **Optional.** Only check local filesystems. May be true or false.
281 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.
282 disk\_mountpoint | **Optional.** Display the mountpoint instead of the partition. May be true or false.
283 disk\_megabytes | **Optional.** Same as --units MB. May be true or false.
284 disk\_all | **Optional.** Explicitly select all paths. This is equivalent to -R '.\*'. May be true or false.
285 disk\_eregi\_path | **Optional.** Case insensitive regular expression for path/partition. Multiple regular expression strings must be defined as array.
286 disk\_ereg\_path | **Optional.** Regular expression for path or partition. Multiple regular expression strings must be defined as array.
287 disk\_ignore\_eregi\_path | **Optional.** Regular expression to ignore selected path/partition (case insensitive). Multiple regular expression strings must be defined as array.
288 disk\_ignore\_ereg\_path | **Optional.** Regular expression to ignore selected path or partition. Multiple regular expression strings must be defined as array.
289 disk\_timeout | **Optional.** Seconds before connection times out (default: 10).
290 disk\_units | **Optional.** Choose bytes, kB, MB, GB, TB (default: MB).
291 disk\_exclude\_type | **Optional.** Ignore all filesystems of indicated type. Multiple regular expression strings must be defined as array.
293 ### <a id="plugin-check-command-disk-smb"></a> disk_smb
295 The [check_disk_smb](https://www.monitoring-plugins.org/doc/man/check_disk_smb.html) plugin
296 uses the `smbclient` binary to check SMB shares.
298 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
301 ------------------------|------------------------
302 disk_smb_hostname | **Required.** NetBIOS name of the server.
303 disk_smb_share | **Required.** Share name being queried.
304 disk_smb_workgroup | **Optional.** Workgroup or Domain used (defaults to 'WORKGROUP' if omitted).
305 disk_smb_address | **Optional.** IP address of the host (only necessary if host belongs to another network).
306 disk_smb_username | **Optional.** Username for server log-in (defaults to 'guest' if omitted).
307 disk_smb_password | **Optional.** Password for server log-in (defaults to an empty password if omitted).
308 disk_smb_wused | **Optional.** The used space warning threshold. Defaults to "85%". If the percent sign is omitted, use optional disk units.
309 disk_smb_cused | **Optional.** The used space critical threshold. Defaults to "95%". If the percent sign is omitted, use optional disk units.
310 disk_smb_port | **Optional.** Connection port, e.g. `139` or `445`. Defaults to `smbclient` default if omitted.
312 ### <a id="plugin-check-command-dns"></a> dns
314 The [check_dns](https://www.monitoring-plugins.org/doc/man/check_dns.html) plugin
315 uses the nslookup program to obtain the IP address for the given host/domain query.
316 An optional DNS server to use may be specified. If no DNS server is specified, the
317 default server(s) specified in `/etc/resolv.conf` will be used.
319 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
322 ---------------------|--------------
323 dns_lookup | **Optional.** The hostname or IP to query the DNS for. Defaults to "$host_name$".
324 dns_server | **Optional.** The DNS server to query. Defaults to the server configured in the OS.
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.
604 http_link | **Optional.** Wrap output in HTML link. Defaults to false.
605 http_verbose | **Optional.** Show details for command-line debugging. Defaults to false.
608 ### <a id="plugin-check-command-icmp"></a> icmp
610 The [check_icmp](https://www.monitoring-plugins.org/doc/man/check_icmp.html) plugin
611 check_icmp allows for checking multiple hosts at once compared to `check_ping`.
612 The main difference is that check_ping executes the system's ping(1) command and
613 parses its output while check_icmp talks ICMP itself. check_icmp must be installed
616 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
619 ----------------|--------------
620 icmp_address | **Optional.** The host's address. This can either be a single address or an array of addresses. Defaults to "$address$".
621 icmp_wrta | **Optional.** The RTA warning threshold in milliseconds. Defaults to 100.
622 icmp_wpl | **Optional.** The packet loss warning threshold in %. Defaults to 5.
623 icmp_crta | **Optional.** The RTA critical threshold in milliseconds. Defaults to 200.
624 icmp_cpl | **Optional.** The packet loss critical threshold in %. Defaults to 15.
625 icmp_source | **Optional.** The source IP address to send packets from.
626 icmp_packets | **Optional.** The number of packets to send. Defaults to 5.
627 icmp_packet_interval | **Optional** The maximum packet interval. Defaults to 80 (milliseconds).
628 icmp_target_interval | **Optional.** The maximum target interval.
629 icmp_hosts_alive | **Optional.** The number of hosts which have to be alive for the check to succeed.
630 icmp_data_bytes | **Optional.** Payload size for each ICMP request. Defaults to 8.
631 icmp_timeout | **Optional.** The plugin timeout in seconds. Defaults to 10 (seconds).
632 icmp_ttl | **Optional.** The TTL on outgoing packets.
635 ### <a id="plugin-check-command-imap"></a> imap
637 The [check_imap](https://www.monitoring-plugins.org/doc/man/check_imap.html) plugin
638 tests IMAP connections with the specified host (or unix socket).
640 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
643 ----------------------|--------------
644 imap_address | **Optional.** The host's address. Defaults to "$address$" if the host's `address` attribute is set, "$address6$" otherwise.
645 imap_port | **Optional.** The port that should be checked. Defaults to 143.
646 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.
647 imap_send | **Optional.** String to send to the server.
648 imap_expect | **Optional.** String to expect in server response. Multiple strings must be defined as array.
649 imap_all | **Optional.** All expect strings need to occur in server response. Default is any.
650 imap_quit | **Optional.** String to send server to initiate a clean close of the connection.
651 imap_refuse | **Optional.** Accept TCP refusals with states ok, warn, crit (default: crit).
652 imap_mismatch | **Optional.** Accept expected string mismatches with states ok, warn, crit (default: warn).
653 imap_jail | **Optional.** Hide output from TCP socket.
654 imap_maxbytes | **Optional.** Close connection once more than this number of bytes are received.
655 imap_delay | **Optional.** Seconds to wait between sending string and polling for response.
656 imap_certificate_age | **Optional.** Minimum number of days a certificate has to be valid.
657 imap_ssl | **Optional.** Use SSL for the connection.
658 imap_warning | **Optional.** Response time to result in warning status (seconds).
659 imap_critical | **Optional.** Response time to result in critical status (seconds).
660 imap_timeout | **Optional.** Seconds before connection times out (default: 10).
661 imap_ipv4 | **Optional.** Use IPv4 connection. Defaults to false.
662 imap_ipv6 | **Optional.** Use IPv6 connection. Defaults to false.
665 ### <a id="plugin-check-command-ldap"></a> ldap
667 The [check_ldap](https://www.monitoring-plugins.org/doc/man/check_ldap.html) plugin
668 can be used to check LDAP servers.
670 The plugin can also be used for monitoring ldaps connections instead of the deprecated `check_ldaps`.
671 This can be ensured by enabling `ldap_starttls` or `ldap_ssl`.
673 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
676 ----------------|--------------
677 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.
678 ldap_port | **Optional.** Port number. Defaults to 389.
679 ldap_attr | **Optional.** LDAP attribute to search for (default: "(objectclass=*)"
680 ldap_base | **Required.** LDAP base (eg. ou=myunit,o=myorg,c=at).
681 ldap_bind | **Optional.** LDAP bind DN (if required).
682 ldap_pass | **Optional.** LDAP password (if required).
683 ldap_starttls | **Optional.** Use STARTSSL mechanism introduced in protocol version 3.
684 ldap_ssl | **Optional.** Use LDAPS (LDAP v2 SSL method). This also sets the default port to 636.
685 ldap_v2 | **Optional.** Use LDAP protocol version 2 (enabled by default).
686 ldap_v3 | **Optional.** Use LDAP protocol version 3 (disabled by default)
687 ldap_warning | **Optional.** Response time to result in warning status (seconds).
688 ldap_critical | **Optional.** Response time to result in critical status (seconds).
689 ldap_timeout | **Optional.** Seconds before connection times out (default: 10).
690 ldap_verbose | **Optional.** Show details for command-line debugging (disabled by default)
692 ### <a id="plugin-check-command-load"></a> load
694 The [check_load](https://www.monitoring-plugins.org/doc/man/check_load.html) plugin
695 tests the current system load average.
697 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
700 ----------------|--------------
701 load_wload1 | **Optional.** The 1-minute warning threshold. Defaults to 5.
702 load_wload5 | **Optional.** The 5-minute warning threshold. Defaults to 4.
703 load_wload15 | **Optional.** The 15-minute warning threshold. Defaults to 3.
704 load_cload1 | **Optional.** The 1-minute critical threshold. Defaults to 10.
705 load_cload5 | **Optional.** The 5-minute critical threshold. Defaults to 6.
706 load_cload15 | **Optional.** The 15-minute critical threshold. Defaults to 4.
707 load_percpu | **Optional.** Divide the load averages by the number of CPUs (when possible). Defaults to false.
709 ### <a id="plugin-check-command-mailq"></a> mailq
711 The [check_mailq](https://www.monitoring-plugins.org/doc/man/check_mailq.html) plugin
712 checks the number of messages in the mail queue (supports multiple sendmail queues, qmail).
714 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
717 ------------------------|--------------
718 mailq_warning | **Required.** Min. number of messages in queue to generate warning.
719 mailq_critical | **Required.** Min. number of messages in queue to generate critical alert ( w < c ).
720 mailq_domain_warning | **Optional.** Min. number of messages for same domain in queue to generate warning
721 mailq_domain_critical | **Optional.** Min. number of messages for same domain in queue to generate critical alert ( W < C ).
722 mailq_timeout | **Optional.** Plugin timeout in seconds (default = 15).
723 mailq_servertype | **Optional.** [ sendmail \| qmail \| postfix \| exim \| nullmailer ] (default = autodetect).
724 mailq_sudo | **Optional.** Use sudo to execute the mailq command.
726 ### <a id="plugin-check-command-mysql"></a> mysql
728 The [check_mysql](https://www.monitoring-plugins.org/doc/man/check_mysql.html) plugin
729 tests connections to a MySQL server.
731 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
734 ------------------------|---------------------------------------------------------------
735 mysql_hostname | **Optional.** Host name, IP Address, or unix socket (must be an absolute path).
736 mysql_port | **Optional.** Port number (default: 3306).
737 mysql_ignore_auth | **Optional.** Ignore authentication failure and check for mysql connectivity only.
738 mysql_database | **Optional.** Check database with indicated name.
739 mysql_file | **Optional.** Read from the specified client options file.
740 mysql_group | **Optional.** Use a client options group.
741 mysql_username | **Optional.** Connect using the indicated username.
742 mysql_password | **Optional.** Use the indicated password to authenticate the connection.
743 mysql_check_slave | **Optional.** Check if the slave thread is running properly.
744 mysql_warning | **Optional.** Exit with WARNING status if slave server is more than INTEGER seconds behind master.
745 mysql_critical | **Optional.** Exit with CRITICAL status if slave server is more then INTEGER seconds behind master.
746 mysql_ssl | **Optional.** Use ssl encryptation.
747 mysql_cacert | **Optional.** Path to CA signing the cert.
748 mysql_cert | **Optional.** Path to SSL certificate.
749 mysql_key | **Optional.** Path to private SSL key.
750 mysql_cadir | **Optional.** Path to CA directory.
751 mysql_ciphers | **Optional.** List of valid SSL ciphers.
754 ### <a id="plugin-check-command-mysql-query"></a> mysql_query
756 The [check_mysql_query](https://www.monitoring-plugins.org/doc/man/check_mysql_query.html) plugin
757 checks a query result against threshold levels.
758 The result from the query should be numeric. For extra security, create a user with minimal access.
760 **Note**: You must specify `mysql_query_password` with an empty string to force an empty password,
761 overriding any my.cnf settings.
763 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
766 ------------------------|---------------------------------------------------------------
767 mysql_query_hostname | **Optional.** Host name, IP Address, or unix socket (must be an absolute path).
768 mysql_query_port | **Optional.** Port number (default: 3306).
769 mysql_query_database | **Optional.** Check database with indicated name.
770 mysql_query_file | **Optional.** Read from the specified client options file.
771 mysql_query_group | **Optional.** Use a client options group.
772 mysql_query_username | **Optional.** Connect using the indicated username.
773 mysql_query_password | **Optional.** Use the indicated password to authenticate the connection.
774 mysql_query_execute | **Required.** SQL Query to run on the MySQL Server.
775 mysql_query_warning | **Optional.** Exit with WARNING status if query is outside of the range (format: start:end).
776 mysql_query_critical | **Optional.** Exit with CRITICAL status if query is outside of the range.
779 ### <a id="plugin-check-command-negate"></a> negate
781 The [negate](https://www.monitoring-plugins.org/doc/man/negate.html) plugin
782 negates the status of a plugin (returns OK for CRITICAL and vice-versa).
783 Additional switches can be used to control which state becomes what.
785 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
788 ------------------------|---------------------------------------------------------------
789 negate_timeout | **Optional.** Seconds before plugin times out (default: 11).
790 negate_timeout_result | **Optional.** Custom result on Negate timeouts, default to UNKNOWN.
791 negate_ok | **Optional.** OK, WARNING, CRITICAL or UNKNOWN.
792 negate_warning | Numeric values are accepted.
793 negate_critical | If nothing is specified, permutes OK and CRITICAL.
794 negate_substitute | **Optional.** Substitute output text as well. Will only substitute text in CAPITALS.
795 negate_command | **Required.** Command to be negated.
796 negate_arguments | **Optional.** Arguments for the negated command.
798 ### <a id="plugin-check-command-nrpe"></a> nrpe
800 The `check_nrpe` plugin can be used to query an [NRPE](http://docs.icinga.com/latest/en/nrpe.html)
801 server or [NSClient++](https://www.nsclient.org). **Note**: This plugin
802 is considered insecure/deprecated.
804 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
807 ----------------|--------------
808 nrpe_address | **Optional.** The host's address. Defaults to "$address$" if the host's `address` attribute is set, "$address6$" otherwise.
809 nrpe_port | **Optional.** The NRPE port. Defaults to 5666.
810 nrpe_command | **Optional.** The command that should be executed.
811 nrpe_no_ssl | **Optional.** Whether to disable SSL or not. Defaults to `false`.
812 nrpe_timeout_unknown | **Optional.** Whether to set timeouts to unknown instead of critical state. Defaults to `false`.
813 nrpe_timeout | **Optional.** The timeout in seconds.
814 nrpe_arguments | **Optional.** Arguments that should be passed to the command. Multiple arguments must be defined as array.
815 nrpe_ipv4 | **Optional.** Use IPv4 connection. Defaults to false.
816 nrpe_ipv6 | **Optional.** Use IPv6 connection. Defaults to false.
819 ### <a id="plugin-check-command-nscp"></a> nscp
821 The [check_nt](https://www.monitoring-plugins.org/doc/man/check_nt.html) plugin
822 collects data from the [NSClient++](https://www.nsclient.org) service.
824 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
827 ----------------|--------------
828 nscp_address | **Optional.** The host's address. Defaults to "$address$" if the host's `address` attribute is set, "$address6$" otherwise.
829 nscp_port | **Optional.** The NSClient++ port. Defaults to 12489.
830 nscp_password | **Optional.** The NSClient++ password.
831 nscp_variable | **Required.** The variable that should be checked.
832 nscp_params | **Optional.** Parameters for the query. Multiple parameters must be defined as array.
833 nscp_warn | **Optional.** The warning threshold.
834 nscp_crit | **Optional.** The critical threshold.
835 nscp_timeout | **Optional.** The query timeout in seconds.
836 nscp_showall | **Optional.** Use with SERVICESTATE to see working services or PROCSTATE for running processes. Defaults to false.
839 ### <a id="plugin-check-command-ntp-time"></a> ntp_time
841 The [check_ntp_time](https://www.monitoring-plugins.org/doc/man/check_ntp_time.html) plugin
842 checks the clock offset between the local host and a remote NTP server.
844 **Note**: If you want to monitor an NTP server, please use `ntp_peer`.
846 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
849 ----------------|--------------
850 ntp_address | **Optional.** The host's address. Defaults to "$address$" if the host's `address` attribute is set, "$address6$" otherwise.
851 ntp_port | **Optional.** Port number (default: 123).
852 ntp_quiet | **Optional.** Returns UNKNOWN instead of CRITICAL if offset cannot be found.
853 ntp_warning | **Optional.** Offset to result in warning status (seconds).
854 ntp_critical | **Optional.** Offset to result in critical status (seconds).
855 ntp_timeoffset | **Optional.** Expected offset of the ntp server relative to local server (seconds).
856 ntp_timeout | **Optional.** Seconds before connection times out (default: 10).
857 ntp_ipv4 | **Optional.** Use IPv4 connection. Defaults to false.
858 ntp_ipv6 | **Optional.** Use IPv6 connection. Defaults to false.
861 ### <a id="plugin-check-command-ntp-peer"></a> ntp_peer
863 The [check_ntp_peer](https://www.monitoring-plugins.org/doc/man/check_ntp_peer.html) plugin
864 checks the health of an NTP server. It supports checking the offset with the sync peer, the
865 jitter and stratum. This plugin will not check the clock offset between the local host and NTP
866 server; please use `ntp_time` for that purpose.
868 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
871 ----------------|--------------
872 ntp_address | **Optional.** The host's address. Defaults to "$address$" if the host's `address` attribute is set, "$address6$" otherwise.
873 ntp_port | **Optional.** The port to use. Default to 123.
874 ntp_warning | **Optional.** Offset to result in warning status (seconds).
875 ntp_critical | **Optional.** Offset to result in critical status (seconds).
876 ntp_wstratum | **Optional.** Warning threshold for stratum of server's synchronization peer.
877 ntp_cstratum | **Optional.** Critical threshold for stratum of server's synchronization peer.
878 ntp_wjitter | **Optional.** Warning threshold for jitter.
879 ntp_cjitter | **Optional.** Critical threshold for jitter.
880 ntp_wsource | **Optional.** Warning threshold for number of usable time sources.
881 ntp_csource | **Optional.** Critical threshold for number of usable time sources.
882 ntp_timeout | **Optional.** Seconds before connection times out (default: 10).
883 ntp_ipv4 | **Optional.** Use IPv4 connection. Defaults to false.
884 ntp_ipv6 | **Optional.** Use IPv6 connection. Defaults to false.
887 ### <a id="plugin-check-command-passive"></a> passive
889 Specialised check command object for passive checks executing the `check_dummy` plugin with appropriate default values.
891 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
894 ----------------|--------------
895 dummy_state | **Optional.** The state. Can be one of 0 (ok), 1 (warning), 2 (critical) and 3 (unknown). Defaults to 3.
896 dummy_text | **Optional.** Plugin output. Defaults to "No Passive Check Result Received.".
898 ### <a id="plugin-check-command-pgsql"></a> pgsql
900 The [check_pgsql](https://www.monitoring-plugins.org/doc/man/check_pgsql.html) plugin
901 tests a PostgreSQL DBMS to determine whether it is active and accepting queries.
902 If a query is specified using the `pgsql_query` attribute, it will be executed after
903 connecting to the server. The result from the query has to be numeric in order
904 to compare it against the query thresholds if set.
906 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
909 ------------------------|---------------------------------------------------------------
910 pgsql_hostname | **Optional.** Host name, IP Address, or unix socket (must be an absolute path).
911 pgsql_port | **Optional.** Port number (default: 5432).
912 pgsql_database | **Optional.** Database to check (default: template1).
913 pgsql_username | **Optional.** Login name of user.
914 pgsql_password | **Optional.** Password (BIG SECURITY ISSUE).
915 pgsql_options | **Optional.** Connection parameters (keyword = value), see below.
916 pgsql_warning | **Optional.** Response time to result in warning status (seconds).
917 pgsql_critical | **Optional.** Response time to result in critical status (seconds).
918 pgsql_timeout | **Optional.** Seconds before connection times out (default: 10).
919 pgsql_query | **Optional.** SQL query to run. Only first column in first row will be read.
920 pgsql_query_warning | **Optional.** SQL query value to result in warning status (double).
921 pgsql_query_critical | **Optional.** SQL query value to result in critical status (double).
923 ### <a id="plugin-check-command-ping"></a> ping
925 The [check_ping](https://www.monitoring-plugins.org/doc/man/check_ping.html) plugin
926 uses the ping command to probe the specified host for packet loss (percentage) and
927 round trip average (milliseconds).
929 This command uses the host's `address` attribute if available and falls back to using
930 the `address6` attribute if the `address` attribute is not set.
932 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
935 ----------------|--------------
936 ping_address | **Optional.** The host's address. Defaults to "$address$" if the host's `address` attribute is set, "$address6$" otherwise.
937 ping_wrta | **Optional.** The RTA warning threshold in milliseconds. Defaults to 100.
938 ping_wpl | **Optional.** The packet loss warning threshold in %. Defaults to 5.
939 ping_crta | **Optional.** The RTA critical threshold in milliseconds. Defaults to 200.
940 ping_cpl | **Optional.** The packet loss critical threshold in %. Defaults to 15.
941 ping_packets | **Optional.** The number of packets to send. Defaults to 5.
942 ping_timeout | **Optional.** The plugin timeout in seconds. Defaults to 0 (no timeout).
945 ### <a id="plugin-check-command-ping4"></a> ping4
947 The [check_ping](https://www.monitoring-plugins.org/doc/man/check_ping.html) plugin
948 uses the ping command to probe the specified host for packet loss (percentage) and
949 round trip average (milliseconds).
951 This command uses the host's `address` attribute if not explicitely specified using
952 the `ping_address` attribute.
954 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
957 ----------------|--------------
958 ping_address | **Optional.** The host's IPv4 address. Defaults to "$address$".
959 ping_wrta | **Optional.** The RTA warning threshold in milliseconds. Defaults to 100.
960 ping_wpl | **Optional.** The packet loss warning threshold in %. Defaults to 5.
961 ping_crta | **Optional.** The RTA critical threshold in milliseconds. Defaults to 200.
962 ping_cpl | **Optional.** The packet loss critical threshold in %. Defaults to 15.
963 ping_packets | **Optional.** The number of packets to send. Defaults to 5.
964 ping_timeout | **Optional.** The plugin timeout in seconds. Defaults to 0 (no timeout).
966 ### <a id="plugin-check-command-ping6"></a> ping6
968 The [check_ping](https://www.monitoring-plugins.org/doc/man/check_ping.html) plugin
969 uses the ping command to probe the specified host for packet loss (percentage) and
970 round trip average (milliseconds).
972 This command uses the host's `address6` attribute if not explicitely specified using
973 the `ping_address` attribute.
975 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
978 ----------------|--------------
979 ping_address | **Optional.** The host's IPv6 address. Defaults to "$address6$".
980 ping_wrta | **Optional.** The RTA warning threshold in milliseconds. Defaults to 100.
981 ping_wpl | **Optional.** The packet loss warning threshold in %. Defaults to 5.
982 ping_crta | **Optional.** The RTA critical threshold in milliseconds. Defaults to 200.
983 ping_cpl | **Optional.** The packet loss critical threshold in %. Defaults to 15.
984 ping_packets | **Optional.** The number of packets to send. Defaults to 5.
985 ping_timeout | **Optional.** The plugin timeout in seconds. Defaults to 0 (no timeout).
988 ### <a id="plugin-check-command-pop"></a> pop
990 The [check_pop](https://www.monitoring-plugins.org/doc/man/check_pop.html) plugin
991 tests POP connections with the specified host (or unix socket).
993 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
996 ---------------------|--------------
997 pop_address | **Optional.** The host's address. Defaults to "$address$" if the host's `address` attribute is set, "$address6$" otherwise.
998 pop_port | **Optional.** The port that should be checked. Defaults to 110.
999 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.
1000 pop_send | **Optional.** String to send to the server.
1001 pop_expect | **Optional.** String to expect in server response. Multiple strings must be defined as array.
1002 pop_all | **Optional.** All expect strings need to occur in server response. Default is any.
1003 pop_quit | **Optional.** String to send server to initiate a clean close of the connection.
1004 pop_refuse | **Optional.** Accept TCP refusals with states ok, warn, crit (default: crit).
1005 pop_mismatch | **Optional.** Accept expected string mismatches with states ok, warn, crit (default: warn).
1006 pop_jail | **Optional.** Hide output from TCP socket.
1007 pop_maxbytes | **Optional.** Close connection once more than this number of bytes are received.
1008 pop_delay | **Optional.** Seconds to wait between sending string and polling for response.
1009 pop_certificate_age | **Optional.** Minimum number of days a certificate has to be valid.
1010 pop_ssl | **Optional.** Use SSL for the connection.
1011 pop_warning | **Optional.** Response time to result in warning status (seconds).
1012 pop_critical | **Optional.** Response time to result in critical status (seconds).
1013 pop_timeout | **Optional.** Seconds before connection times out (default: 10).
1014 pop_ipv4 | **Optional.** Use IPv4 connection. Defaults to false.
1015 pop_ipv6 | **Optional.** Use IPv6 connection. Defaults to false.
1018 ### <a id="plugin-check-command-processes"></a> procs
1020 The [check_procs](https://www.monitoring-plugins.org/doc/man/check_procs.html) plugin
1021 checks all processes and generates WARNING or CRITICAL states if the specified
1022 metric is outside the required threshold ranges. The metric defaults to number
1023 of processes. Search filters can be applied to limit the processes to check.
1025 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
1028 ---------------------|--------------
1029 procs_warning | **Optional.** The process count warning threshold. Defaults to 250.
1030 procs_critical | **Optional.** The process count critical threshold. Defaults to 400.
1031 procs_metric | **Optional.** Check thresholds against metric.
1032 procs_timeout | **Optional.** Seconds before plugin times out.
1033 procs_traditional | **Optional.** Filter own process the traditional way by PID instead of /proc/pid/exe. Defaults to false.
1034 procs_state | **Optional.** Only scan for processes that have one or more of the status flags you specify.
1035 procs_ppid | **Optional.** Only scan for children of the parent process ID indicated.
1036 procs_vsz | **Optional.** Only scan for processes with VSZ higher than indicated.
1037 procs_rss | **Optional.** Only scan for processes with RSS higher than indicated.
1038 procs_pcpu | **Optional.** Only scan for processes with PCPU higher than indicated.
1039 procs_user | **Optional.** Only scan for processes with user name or ID indicated.
1040 procs_argument | **Optional.** Only scan for processes with args that contain STRING.
1041 procs_argument_regex | **Optional.** Only scan for processes with args that contain the regex STRING.
1042 procs_command | **Optional.** Only scan for exact matches of COMMAND (without path).
1043 procs_nokthreads | **Optional.** Only scan for non kernel threads. Defaults to false.
1046 ### <a id="plugin-check-command-radius"></a> radius
1048 The [check_radius](https://www.monitoring-plugins.org/doc/man/check_radius.html) plugin
1049 checks a RADIUS server to see if it is accepting connections. The server to test
1050 must be specified in the invocation, as well as a user name and password. A configuration
1051 file may also be present. The format of the configuration file is described in the
1052 radiusclient library sources. The password option presents a substantial security
1053 issue because the password can possibly be determined by careful watching of the
1054 command line in a process listing. This risk is exacerbated because the plugin will
1055 typically be executed at regular predictable intervals. Please be sure that the
1056 password used does not allow access to sensitive system resources.
1059 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
1062 -------------------|--------------
1063 radius_address | **Optional.** The radius server's address. Defaults to "$address$" if the host's `address` attribute is set, "$address6$" otherwise.
1064 radius_config_file | **Required.** The radius configuration file.
1065 radius_username | **Required.** The radius username to test.
1066 radius_password | **Required.** The radius password to test.
1067 radius_port | **Optional.** The radius port number (default 1645).
1068 radius_nas_id | **Optional.** The NAS identifier.
1069 radius_nas_address | **Optional.** The NAS IP address.
1070 radius_expect | **Optional.** The response string to expect from the server.
1071 radius_retries | **Optional.** The number of times to retry a failed connection.
1072 radius_timeout | **Optional.** The number of seconds before connection times out (default: 10).
1075 ### <a id="plugin-check-command-simap"></a> simap
1077 The [check_simap](https://www.monitoring-plugins.org/doc/man/check_simap.html) plugin
1078 tests SIMAP connections with the specified host (or unix socket).
1080 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
1083 -----------------------|--------------
1084 simap_address | **Optional.** The host's address. Defaults to "$address$" if the host's `address` attribute is set, "$address6$" otherwise.
1085 simap_port | **Optional.** The port that should be checked. Defaults to 993.
1086 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.
1087 simap_send | **Optional.** String to send to the server.
1088 simap_expect | **Optional.** String to expect in server response. Multiple strings must be defined as array.
1089 simap_all | **Optional.** All expect strings need to occur in server response. Default is any.
1090 simap_quit | **Optional.** String to send server to initiate a clean close of the connection.
1091 simap_refuse | **Optional.** Accept TCP refusals with states ok, warn, crit (default: crit).
1092 simap_mismatch | **Optional.** Accept expected string mismatches with states ok, warn, crit (default: warn).
1093 simap_jail | **Optional.** Hide output from TCP socket.
1094 simap_maxbytes | **Optional.** Close connection once more than this number of bytes are received.
1095 simap_delay | **Optional.** Seconds to wait between sending string and polling for response.
1096 simap_certificate_age | **Optional.** Minimum number of days a certificate has to be valid.
1097 simap_ssl | **Optional.** Use SSL for the connection.
1098 simap_warning | **Optional.** Response time to result in warning status (seconds).
1099 simap_critical | **Optional.** Response time to result in critical status (seconds).
1100 simap_timeout | **Optional.** Seconds before connection times out (default: 10).
1101 simap_ipv4 | **Optional.** Use IPv4 connection. Defaults to false.
1102 simap_ipv6 | **Optional.** Use IPv6 connection. Defaults to false.
1104 ### <a id="plugin-check-command-smart"></a> smart
1106 The [check_ide_smart](https://www.monitoring-plugins.org/doc/man/check_ide_smart.html) plugin
1107 checks a local hard drive with the (Linux specific) SMART interface. Requires installation of `smartctl`.
1109 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
1112 ----------------|--------------
1113 smart_device | **Required.** The name of a local hard drive to monitor.
1116 ### <a id="plugin-check-command-smtp"></a> smtp
1118 The [check_smtp](https://www.monitoring-plugins.org/doc/man/check_smtp.html) plugin
1119 will attempt to open an SMTP connection with the host.
1121 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
1124 ----------------------|--------------
1125 smtp_address | **Optional.** The host's address. Defaults to "$address$" if the host's `address` attribute is set, "$address6$" otherwise.
1126 smtp_port | **Optional.** The port that should be checked. Defaults to 25.
1127 smtp_mail_from | **Optional.** Test a MAIL FROM command with the given email address.
1128 smtp_expect | **Optional.** String to expect in first line of server response (default: '220').
1129 smtp_command | **Optional.** SMTP command (may be used repeatedly).
1130 smtp_response | **Optional.** Expected response to command (may be used repeatedly).
1131 smtp_helo_fqdn | **Optional.** FQDN used for HELO
1132 smtp_certificate_age | **Optional.** Minimum number of days a certificate has to be valid.
1133 smtp_starttls | **Optional.** Use STARTTLS for the connection.
1134 smtp_authtype | **Optional.** SMTP AUTH type to check (default none, only LOGIN supported).
1135 smtp_authuser | **Optional.** SMTP AUTH username.
1136 smtp_authpass | **Optional.** SMTP AUTH password.
1137 smtp_ignore_quit | **Optional.** Ignore failure when sending QUIT command to server.
1138 smtp_warning | **Optional.** Response time to result in warning status (seconds).
1139 smtp_critical | **Optional.** Response time to result in critical status (seconds).
1140 smtp_timeout | **Optional.** Seconds before connection times out (default: 10).
1141 smtp_ipv4 | **Optional.** Use IPv4 connection. Defaults to false.
1142 smtp_ipv6 | **Optional.** Use IPv6 connection. Defaults to false.
1145 ### <a id="plugin-check-command-snmp"></a> snmp
1147 The [check_snmp](https://www.monitoring-plugins.org/doc/man/check_snmp.html) plugin
1148 checks the status of remote machines and obtains system information via SNMP.
1150 **Note**: This plugin uses the `snmpget` command included with the NET-SNMP package.
1152 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
1155 --------------------|--------------
1156 snmp_address | **Optional.** The host's address. Defaults to "$address$" if the host's `address` attribute is set, "$address6$" otherwise.
1157 snmp_oid | **Required.** The SNMP OID.
1158 snmp_community | **Optional.** The SNMP community. Defaults to "public".
1159 snmp_port | **Optional.** The SNMP port. Defaults to "161".
1160 snmp_retries | **Optional.** Number of retries to be used in the SNMP requests.
1161 snmp_warn | **Optional.** The warning threshold.
1162 snmp_crit | **Optional.** The critical threshold.
1163 snmp_string | **Optional.** Return OK state if the string matches exactly with the output value
1164 snmp_ereg | **Optional.** Return OK state if extended regular expression REGEX matches with the output value
1165 snmp_eregi | **Optional.** Return OK state if case-insensitive extended REGEX matches with the output value
1166 snmp_label | **Optional.** Prefix label for output value
1167 snmp_invert_search | **Optional.** Invert search result and return CRITICAL state if found
1168 snmp_units | **Optional.** Units label(s) for output value (e.g., 'sec.').
1169 snmp_version | **Optional.** Version to use. E.g. 1, 2, 2c or 3.
1170 snmp_miblist | **Optional.** MIB's to use, comma separated. Defaults to "ALL".
1171 snmp_rate_multiplier | **Optional.** Converts rate per second. For example, set to 60 to convert to per minute.
1172 snmp_rate | **Optional.** Boolean. Enable rate calculation.
1173 snmp_getnext | **Optional.** Boolean. Use SNMP GETNEXT. Defaults to false.
1174 snmp_timeout | **Optional.** The command timeout in seconds. Defaults to 10 seconds.
1176 ### <a id="plugin-check-command-snmpv3"></a> snmpv3
1178 Check command object for the [check_snmp](https://www.monitoring-plugins.org/doc/man/check_snmp.html)
1179 plugin, using SNMPv3 authentication and encryption options.
1181 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
1184 ---------------------|--------------
1185 snmpv3_address | **Optional.** The host's address. Defaults to "$address$" if the host's `address` attribute is set, "$address6$" otherwise.
1186 snmpv3_getnext | **Optional.** Use SNMP GETNEXT instead of SNMP GET.
1187 snmpv3_seclevel | **Optional.** The security level. Defaults to authPriv.
1188 snmpv3_auth_alg | **Optional.** The authentication algorithm. Defaults to SHA.
1189 snmpv3_user | **Required.** The username to log in with.
1190 snmpv3_auth_key | **Required,** The authentication key. Required if `snmpv3_seclevel` is set to `authPriv` otherwise optional.
1191 snmpv3_priv_key | **Required.** The encryption key.
1192 snmpv3_oid | **Required.** The SNMP OID.
1193 snmpv3_priv_alg | **Optional.** The encryption algorithm. Defaults to AES.
1194 snmpv3_warn | **Optional.** The warning threshold.
1195 snmpv3_crit | **Optional.** The critical threshold.
1196 snmpv3_string | **Optional.** Return OK state (for that OID) if STRING is an exact match.
1197 snmpv3_ereg | **Optional.** Return OK state (for that OID) if extended regular expression REGEX matches.
1198 snmpv3_eregi | **Optional.** Return OK state (for that OID) if case-insensitive extended REGEX matches.
1199 snmpv3_invert_search | **Optional.** Invert search result and return CRITICAL if found
1200 snmpv3_label | **Optional.** Prefix label for output value.
1201 snmpv3_units | **Optional.** Units label(s) for output value (e.g., 'sec.').
1202 snmpv3_rate_multiplier | **Optional.** Converts rate per second. For example, set to 60 to convert to per minute.
1203 snmpv3_rate | **Optional.** Boolean. Enable rate calculation.
1204 snmpv3_timeout | **Optional.** The command timeout in seconds. Defaults to 10 seconds.
1206 ### <a id="plugin-check-command-snmp-uptime"></a> snmp-uptime
1208 Check command object for the [check_snmp](https://www.monitoring-plugins.org/doc/man/check_snmp.html)
1209 plugin, using the uptime OID by default.
1211 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
1214 ----------------|--------------
1215 snmp_address | **Optional.** The host's address. Defaults to "$address$" if the host's `address` attribute is set, "$address6$" otherwise.
1216 snmp_oid | **Optional.** The SNMP OID. Defaults to "1.3.6.1.2.1.1.3.0".
1217 snmp_community | **Optional.** The SNMP community. Defaults to "public".
1220 ### <a id="plugin-check-command-spop"></a> spop
1222 The [check_spop](https://www.monitoring-plugins.org/doc/man/check_spop.html) plugin
1223 tests SPOP connections with the specified host (or unix socket).
1225 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
1228 ----------------------|--------------
1229 spop_address | **Optional.** The host's address. Defaults to "$address$" if the host's `address` attribute is set, "$address6$" otherwise.
1230 spop_port | **Optional.** The port that should be checked. Defaults to 995.
1231 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.
1232 spop_send | **Optional.** String to send to the server.
1233 spop_expect | **Optional.** String to expect in server response. Multiple strings must be defined as array.
1234 spop_all | **Optional.** All expect strings need to occur in server response. Default is any.
1235 spop_quit | **Optional.** String to send server to initiate a clean close of the connection.
1236 spop_refuse | **Optional.** Accept TCP refusals with states ok, warn, crit (default: crit).
1237 spop_mismatch | **Optional.** Accept expected string mismatches with states ok, warn, crit (default: warn).
1238 spop_jail | **Optional.** Hide output from TCP socket.
1239 spop_maxbytes | **Optional.** Close connection once more than this number of bytes are received.
1240 spop_delay | **Optional.** Seconds to wait between sending string and polling for response.
1241 spop_certificate_age | **Optional.** Minimum number of days a certificate has to be valid.
1242 spop_ssl | **Optional.** Use SSL for the connection.
1243 spop_warning | **Optional.** Response time to result in warning status (seconds).
1244 spop_critical | **Optional.** Response time to result in critical status (seconds).
1245 spop_timeout | **Optional.** Seconds before connection times out (default: 10).
1246 spop_ipv4 | **Optional.** Use IPv4 connection. Defaults to false.
1247 spop_ipv6 | **Optional.** Use IPv6 connection. Defaults to false.
1250 ### <a id="plugin-check-command-ssh"></a> ssh
1252 The [check_ssh](https://www.monitoring-plugins.org/doc/man/check_ssh.html) plugin
1253 connects to an SSH server at a specified host and port.
1255 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
1258 ----------------|--------------
1259 ssh_address | **Optional.** The host's address. Defaults to "$address$" if the host's `address` attribute is set, "$address6$" otherwise.
1260 ssh_port | **Optional.** The port that should be checked. Defaults to 22.
1261 ssh_timeout | **Optional.** Seconds before connection times out. Defaults to 10.
1262 ssh_ipv4 | **Optional.** Use IPv4 connection. Defaults to false.
1263 ssh_ipv6 | **Optional.** Use IPv6 connection. Defaults to false.
1266 ### <a id="plugin-check-command-ssl"></a> ssl
1268 Check command object for the [check_tcp](https://www.monitoring-plugins.org/doc/man/check_tcp.html) plugin,
1269 using ssl-related options.
1271 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
1274 ------------------------------|--------------
1275 ssl_address | **Optional.** The host's address. Defaults to "$address$" if the host's `address` attribute is set, "$address6$" otherwise.
1276 ssl_port | **Required.** The port that should be checked.
1277 ssl_timeout | **Optional.** Timeout in seconds for the connect and handshake. The plugin default is 10 seconds.
1278 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.
1279 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.
1280 ssl_sni | **Optional.** The `server_name` that is send to select the SSL certificate to check. Important if SNI is used. Defaults to "$ssl_address$".
1283 ### <a id="plugin-check-command-ssmtp"></a> ssmtp
1285 The [check_ssmtp](https://www.monitoring-plugins.org/doc/man/check_ssmtp.html) plugin
1286 tests SSMTP connections with the specified host (or unix socket).
1288 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
1291 -----------------------|--------------
1292 ssmtp_address | **Optional.** The host's address. Defaults to "$address$" if the host's `address` attribute is set, "$address6$" otherwise.
1293 ssmtp_port | **Optional.** The port that should be checked. Defaults to 465.
1294 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.
1295 ssmtp_send | **Optional.** String to send to the server.
1296 ssmtp_expect | **Optional.** String to expect in server response. Multiple strings must be defined as array.
1297 ssmtp_all | **Optional.** All expect strings need to occur in server response. Default is any.
1298 ssmtp_quit | **Optional.** String to send server to initiate a clean close of the connection.
1299 ssmtp_refuse | **Optional.** Accept TCP refusals with states ok, warn, crit (default: crit).
1300 ssmtp_mismatch | **Optional.** Accept expected string mismatches with states ok, warn, crit (default: warn).
1301 ssmtp_jail | **Optional.** Hide output from TCP socket.
1302 ssmtp_maxbytes | **Optional.** Close connection once more than this number of bytes are received.
1303 ssmtp_delay | **Optional.** Seconds to wait between sending string and polling for response.
1304 ssmtp_certificate_age | **Optional.** Minimum number of days a certificate has to be valid.
1305 ssmtp_ssl | **Optional.** Use SSL for the connection.
1306 ssmtp_warning | **Optional.** Response time to result in warning status (seconds).
1307 ssmtp_critical | **Optional.** Response time to result in critical status (seconds).
1308 ssmtp_timeout | **Optional.** Seconds before connection times out (default: 10).
1309 ssmtp_ipv4 | **Optional.** Use IPv4 connection. Defaults to false.
1310 ssmtp_ipv6 | **Optional.** Use IPv6 connection. Defaults to false.
1313 ### <a id="plugin-check-command-swap"></a> swap
1315 The [check_swap](https://www.monitoring-plugins.org/doc/man/check_swap.html) plugin
1316 checks the swap space on a local machine.
1318 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
1321 ----------------|--------------
1322 swap_wfree | **Optional.** The free swap space warning threshold in % (enable `swap_integer` for number values). Defaults to `50%`.
1323 swap_cfree | **Optional.** The free swap space critical threshold in % (enable `swap_integer` for number values). Defaults to `25%`.
1324 swap_integer | **Optional.** Specifies whether the thresholds are passed as number or percent value. Defaults to false (percent values).
1325 swap_allswaps | **Optional.** Conduct comparisons for all swap partitions, one by one. Defaults to false.
1326 swap_noswap | **Optional.** Resulting state when there is no swap regardless of thresholds. Possible values are "ok", "warning", "critical", "unknown". Defaults to "critical".
1329 ### <a id="plugin-check-command-tcp"></a> tcp
1331 The [check_tcp](https://www.monitoring-plugins.org/doc/man/check_tcp.html) plugin
1332 tests TCP connections with the specified host (or unix socket).
1334 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
1337 ----------------|--------------
1338 tcp_address | **Optional.** The host's address. Defaults to "$address$" if the host's `address` attribute is set, "$address6$" otherwise.
1339 tcp_port | **Required.** The port that should be checked.
1340 tcp_expect | **Optional.** String to expect in server response. Multiple strings must be defined as array.
1341 tcp_all | **Optional.** All expect strings need to occur in server response. Defaults to false.
1342 tcp_escape_send | **Optional.** Enable usage of \\n, \\r, \\t or \\\\ in send string.
1343 tcp_send | **Optional.** String to send to the server.
1344 tcp_escape_quit | **Optional.** Enable usage of \\n, \\r, \\t or \\\\ in quit string.
1345 tcp_quit | **Optional.** String to send server to initiate a clean close of the connection.
1346 tcp_refuse | **Optional.** Accept TCP refusals with states ok, warn, crit. Defaults to crit.
1347 tcp_mismatch | **Optional.** Accept expected string mismatches with states ok, warn, crit. Defaults to warn.
1348 tcp_jail | **Optional.** Hide output from TCP socket.
1349 tcp_maxbytes | **Optional.** Close connection once more than this number of bytes are received.
1350 tcp_delay | **Optional.** Seconds to wait between sending string and polling for response.
1351 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.
1352 tcp_ssl | **Optional.** Use SSL for the connection. Defaults to false.
1353 tcp_wtime | **Optional.** Response time to result in warning status (seconds).
1354 tcp_ctime | **Optional.** Response time to result in critical status (seconds).
1355 tcp_timeout | **Optional.** Seconds before connection times out. Defaults to 10.
1356 tcp_ipv4 | **Optional.** Use IPv4 connection. Defaults to false.
1357 tcp_ipv6 | **Optional.** Use IPv6 connection. Defaults to false.
1360 ### <a id="plugin-check-command-udp"></a> udp
1362 The [check_udp](https://www.monitoring-plugins.org/doc/man/check_udp.html) plugin
1363 tests UDP connections with the specified host (or unix socket).
1365 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
1368 ----------------|--------------
1369 udp_address | **Optional.** The host's address. Defaults to "$address$" if the host's `address` attribute is set, "$address6$" otherwise.
1370 udp_port | **Required.** The port that should be checked.
1371 udp_send | **Required.** The payload to send in the UDP datagram.
1372 udp_expect | **Required.** The payload to expect in the response datagram.
1373 udp_quit | **Optional.** The payload to send to 'close' the session.
1374 udp_ipv4 | **Optional.** Use IPv4 connection. Defaults to false.
1375 udp_ipv6 | **Optional.** Use IPv6 connection. Defaults to false.
1378 ### <a id="plugin-check-command-ups"></a> ups
1380 The [check_ups](https://www.monitoring-plugins.org/doc/man/check_ups.html) plugin
1381 tests the UPS service on the specified host. [Network UPS Tools](http://www.networkupstools.org)
1382 must be running for this plugin to work.
1384 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
1387 ----------------|--------------
1388 ups_address | **Required.** The address of the host running upsd. Defaults to "$address$" if the host's `address` attribute is set, "$address6$" otherwise.
1389 ups_name | **Required.** The UPS name. Defaults to `ups`.
1390 ups_port | **Optional.** The port to which to connect. Defaults to 3493.
1391 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`.
1392 ups_warning | **Optional.** The warning threshold for the selected variable.
1393 ups_critical | **Optional.** The critical threshold for the selected variable.
1394 ups_celsius | **Optional.** Display the temperature in degrees Celsius instead of Fahrenheit. Defaults to `false`.
1395 ups_timeout | **Optional.** The number of seconds before the connection times out. Defaults to 10.
1398 ### <a id="plugin-check-command-users"></a> users
1400 The [check_users](https://www.monitoring-plugins.org/doc/man/check_users.html) plugin
1401 checks the number of users currently logged in on the local system and generates an
1402 error if the number exceeds the thresholds specified.
1404 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
1407 ----------------|--------------
1408 users_wgreater | **Optional.** The user count warning threshold. Defaults to 20.
1409 users_cgreater | **Optional.** The user count critical threshold. Defaults to 50.
1411 ## <a id="windows-plugins"></a> Windows Plugins for Icinga 2
1413 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.
1415 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:
1417 include <windows-plugins>
1419 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.
1422 ### <a id="windows-plugins-thresholds"></a> Threshold syntax
1424 So not specified differently the thresholds for the plugins all follow the same pattern
1427 :------------|:----------
1428 "29" | The threshold is 29.
1429 "!29" | The threshold is 29, but the negative of the result is returned.
1430 "[10-40]" | The threshold is a range from (including) 20 to 40, a value inside means the threshold has been exceeded.
1431 "![10-40]" | Same as above, but the result is inverted.
1434 ### <a id="windows-plugins-disk-windows"></a> disk-windows
1436 Check command object for the `check_disk.exe` plugin.
1437 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.).
1442 :-------------------|:------------
1443 disk\_win\_warn | **Optional**. The warning threshold.
1444 disk\_win\_crit | **Optional**. The critical threshold.
1445 disk\_win\_path | **Optional**. Check only these paths, default checks all.
1446 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.
1447 disk\_win\_exclude | **Optional**. Exclude these drives from check.
1449 ### <a id="windows-plugins-load-windows"></a> load-windows
1451 Check command object for the `check_load.exe` plugin.
1452 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).
1457 :---------------|:------------
1458 load\_win\_warn | **Optional**. The warning threshold.
1459 load\_win\_crit | **Optional**. The critical threshold.
1462 ### <a id="windows-plugins-memory-windows"></a> memory-windows
1464 Check command object for the `check_memory.exe` plugin.
1465 The memory collection is instant.
1469 > Percentage based thresholds can be used by adding a '%' to the threshold
1470 > value. Keep in mind that memory\_win\_unit is applied before the
1471 > value is calculated.
1476 :-----------------|:------------
1477 memory\_win\_warn | **Optional**. The warning threshold.
1478 memory\_win\_crit | **Optional**. The critical threshold.
1479 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.
1482 ### <a id="windows-plugins-network-windows"></a> network-windows
1484 Check command object for the `check_network.exe` plugin.
1485 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).
1490 :-------------------|:------------
1491 network\_win\_warn | **Optional**. The warning threshold.
1492 network\_win\_crit | **Optional**. The critical threshold.
1493 network\_no\_isatap | **Optional**. Do not print ISATAP interfaces.
1496 ### <a id="windows-plugins-perfmon-windows"></a> perfmon-windows
1498 Check command object for the `check_perfmon.exe` plugin.
1499 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`.
1501 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"`
1506 :---------------------|:------------
1507 perfmon\_win\_warn | **Optional**. The warning threshold.
1508 perfmon\_win\_crit | **Optional**. The critical threshold.
1509 perfmon\_win\_counter | **Required**. The Performance Counter to use. Ex. `\Processor(_Total)\% Idle Time`.
1510 perfmon\_win\_wait | **Optional**. Time in milliseconds to wait between data collection (default: 1000).
1511 perfmon\_win\_type | **Optional**. Format in which to expect perfomance values. Possible are: long, int64 and double (default).
1514 ### <a id="windows-plugins-ping-windows"></a> ping-windows
1516 Check command object for the `check_ping.exe` plugin.
1517 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.
1522 :------------------|:------------
1523 ping\_win\_warn | **Optional**. The warning threshold. RTA and package loss separated by comma.
1524 ping\_win\_crit | **Optional**. The critical threshold. RTA and package loss separated by comma.
1525 ping\_win\_address | **Required**. An IPv4 or IPv6 address
1526 ping\_win\_packets | **Optional**. Number of packages to send. Default: 5.
1527 ping\_win\_timeout | **Optional**. The timeout in milliseconds. Default: 1000
1530 ### <a id="windows-plugins-procs-windows"></a> procs-windows
1532 Check command object for `check_procs.exe` plugin.
1533 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.
1538 :----------------|:------------
1539 procs\_win\_warn | **Optional**. The warning threshold.
1540 procs\_win\_crit | **Optional**. The critical threshold.
1541 procs\_win\_user | **Optional**. Count this useres processes.
1544 ### <a id="windows-plugins-service-windows"></a> service-windows
1546 Check command object for `check_service.exe` plugin.
1547 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.
1552 :---------------------|:------------
1553 service\_win\_warn | **Optional**. Warn when service is not running.
1554 service\_win\_service | **Required**. The critical threshold.
1557 ### <a id="windows-plugins-swap-windows"></a> swap-windows
1559 Check command object for `check_swap.exe` plugin.
1560 The data collection is instant.
1565 :---------------|:------------
1566 swap\_win\_warn | **Optional**. The warning threshold.
1567 swap\_win\_crit | **Optional**. The critical threshold.
1568 swap\_win\_unit | **Optional**. The unit to display the received value in, thresholds are interpreted in this unit. Defaults to "mb" (megabyte).
1571 ### <a id="windows-plugins-update-windows"></a> update-windows
1573 Check command object for `check_update.exe` plugin.
1574 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.
1578 > The Network Services Account which runs Icinga 2 by default does not have the required
1579 > permissions to run this check.
1584 :-------------------|:------------
1585 update\_win\_warn | If set, returns warning when important updates are available
1586 update\_win\_crit | If set, return critical when important updates that require a reboot are available.
1587 update\_win\_reboot | Set to treat 'may need update' as 'definitely needs update'
1590 ### <a id="windows-plugins-uptime-windows"></a> uptime-windows
1592 Check command opject for `check_uptime.exe` plugin.
1593 Uses GetTickCount64 to get the uptime, so boot time is not included.
1598 :-----------------|:------------
1599 uptime\_win\_warn | **Optional**. The warning threshold.
1600 uptime\_win\_crit | **Optional**. The critical threshold.
1601 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).
1604 ### <a id="windows-plugins-users-windows"></a> users-windows
1606 Check command object for `check_users.exe` plugin.
1611 :----------------|:------------
1612 users\_win\_warn | **Optional**. The warning threshold.
1613 users\_win\_crit | **Optional**. The critical threshold.
1616 ## <a id="nscp-plugin-check-commands"></a> Plugin Check Commands for NSClient++
1618 Icinga 2 can use the `nscp client` command to run arbitrary NSClient++ checks.
1620 You can enable these check commands by adding the following the include directive in your
1621 [icinga2.conf](4-configuring-icinga-2.md#icinga2-conf) configuration file:
1625 You can also optionally specify an alternative installation directory for NSClient++ by adding
1626 the NscpPath constant in your [constants.conf](4-configuring-icinga-2.md#constants-conf) configuration
1629 const NscpPath = "C:\\Program Files (x86)\\NSClient++"
1631 By default Icinga 2 uses the Microsoft Installer API to determine where NSClient++ is installed. It should
1632 not be necessary to manually set this constant.
1634 Note that it is not necessary to run NSClient++ as a Windows service for these commands to work.
1636 ### <a id="nscp-check-local"></a> nscp-local
1638 Check command object for NSClient++
1640 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
1643 ----------------|--------------
1644 nscp_log_level | **Optional.** The log level. Defaults to "critical".
1645 nscp_load_all | **Optional.** Whether to load all modules. Defaults to false.
1646 nscp_modules | **Optional.** An array of NSClient++ modules to load. Defaults to `[ "CheckSystem" ]`.
1647 nscp_boot | **Optional.** Whether to use the --boot option. Defaults to true.
1648 nscp_query | **Required.** The NSClient++ query. Try `nscp client -q x` for a list.
1649 nscp_arguments | **Optional.** An array of query arguments.
1650 nscp_showall | **Optional.** Shows more details in plugin output, default to false.
1652 ### <a id="nscp-check-local-cpu"></a> nscp-local-cpu
1654 Check command object for the `check_cpu` NSClient++ plugin.
1657 --------------------|------------------
1658 nscp_cpu_time | **Optional.** Calculate avarage usage for the given time intervals. Value has to be an array, default to [ "1m", "5m", "15m" ].
1659 nscp_cpu_warning | **Optional.** Threshold for WARNING state in percent, default to 80.
1660 nscp_cpu_critical | **Optional.** Threshold for CRITICAL state in percent, default to 90.
1661 nscp_cpu_arguments | **Optional.** Additional arguments.
1662 nscp_cpu_showall | **Optional.** Shows more details in plugin output, default to false.
1664 ### <a id="nscp-check-local-memory"></a> nscp-local-memory
1666 Check command object for the `check_memory` NSClient++ plugin.
1669 ----------------------|------------------
1670 nscp_memory_committed | **Optional.** Check for committed memory, default to false.
1671 nscp_memory_physical | **Optional.** Check for physical memory, default to true.
1672 nscp_memory_free | **Optional.** Switch between checking free (true) or used memory (false), default to false.
1673 nscp_memory_warning | **Optional.** Threshold for WARNING state in percent or absolut (use MB, GB, ...), default to 80 (free=false) or 20 (free=true).
1674 nscp_memory_critical | **Optional.** Threshold for CRITICAL state in percent or absolut (use MB, GB, ...), default to 90 (free=false) or 10 (free=true).
1675 nscp_memory_arguments | **Optional.** Additional arguments.
1676 nscp_memory_showall | **Optional.** Shows more details in plugin output, default to false.
1678 ### <a id="nscp-check-local-os-version"></a> nscp-local-os-version
1680 Check command object for the `check_os_version` NSClient++ plugin.
1682 This command has the same custom attributes like the `nscp-local` check command.
1684 ### <a id="nscp-check-local-pagefile"></a> nscp-local-pagefile
1686 Check command object for the `check_pagefile` NSClient++ plugin.
1688 This command has the same custom attributes like the `nscp-local` check command.
1690 ### <a id="nscp-check-local-process"></a> nscp-local-process
1692 Check command object for the `check_process` NSClient++ plugin.
1694 This command has the same custom attributes like the `nscp-local` check command.
1696 ### <a id="nscp-check-local-service"></a> nscp-local-service
1698 Check command object for the `check_service` NSClient++ plugin.
1701 -----------------------|------------------
1702 nscp_service_name | **Required.** Name of service to check.
1703 nscp_service_type | **Optional.** Type to check, default to state.
1704 nscp_service_ok | **Optional.** State for return an OK, i.e. for type=state running, stopped, ...
1705 nscp_service_otype | **Optional.** Dedicate type for nscp_service_ok, default to nscp_service_state.
1706 nscp_service_warning | **Optional.** State for return an WARNING.
1707 nscp_service_wtype | **Optional.** Dedicate type for nscp_service_warning, default to nscp_service_state.
1708 nscp_service_critical | **Optional.** State for return an CRITICAL.
1709 nscp_service_ctype | **Optional.** Dedicate type for nscp_service_critical, default to nscp_service_state.
1710 nscp_service_arguments | **Optional.** Additional arguments.
1711 nscp_service_showall | **Optional.** Shows more details in plugin output, default to true.
1713 ### <a id="nscp-check-local-uptime"></a> nscp-local-uptime
1715 Check command object for the `check_uptime` NSClient++ plugin.
1717 This command has the same custom attributes like the `nscp-local` check command.
1719 ### <a id="nscp-check-local-version"></a> nscp-local-version
1721 Check command object for the `check_version` NSClient++ plugin.
1723 This command has the same custom attributes like the `nscp-local` check command.
1724 In addition to that the default value for `nscp_modules` is set to `[ "CheckHelpers" ]`.
1726 ### <a id="nscp-check-local-disk"></a> nscp-local-disk
1728 Check command object for the `check_drivesize` NSClient++ plugin.
1731 -----------------------|------------------
1732 nscp_disk_drive | **Optional.** Drive character, default to all drives.
1733 nscp_disk_free | **Optional.** Switch between checking free space (free=true) or used space (free=false), default to false.
1734 nscp_disk_warning | **Optional.** Threshold for WARNING in percent or absolut (use MB, GB, ...), default to 80 (used) or 20 percent (free).
1735 nscp_disk_critical | **Optional.** Threshold for CRITICAL in percent or absolut (use MB, GB, ...), default to 90 (used) or 10 percent (free).
1736 nscp_disk_arguments | **Optional.** Additional arguments.
1737 nscp_disk_showall | **Optional.** Shows more details in plugin output, default to true.
1738 nscp_modules | **Optional.** An array of NSClient++ modules to load. Defaults to `[ "CheckDisk" ]`.
1740 ### <a id="nscp-check-local-counter"></a> nscp-local-counter
1742 Check command object for the `check_pdh` NSClient++ plugin.
1745 -----------------------|------------------
1746 nscp_counter_name | **Required.** Performance counter name.
1747 nscp_counter_warning | **Optional.** WARNING Threshold.
1748 nscp_counter_critical | **Optional.** CRITICAL Threshold.
1749 nscp_counter_arguments | **Optional.** Additional arguments.
1750 nscp_counter_showall | **Optional.** Shows more details in plugin output, default to false.
1751 nscp_counter_perfsyntax | **Optional.** Apply performance data label, e.g. `Total Processor Time` to avoid special character problems. Defaults to `nscp_counter_name`.
1755 ## <a id="snmp-manubulon-plugin-check-commands"></a> Plugin Check Commands for Manubulon SNMP
1757 The `SNMP Manubulon Plugin Check Commands` provide configuration for plugin check
1758 commands provided by the [SNMP Manubulon project](http://nagios.manubulon.com/index_snmp.html).
1760 **Note:** Some plugin parameters are only available in Debian packages or in a
1761 [forked repository](https://github.com/dnsmichi/manubulon-snmp) with patches applied.
1763 The SNMP manubulon plugin check commands assume that the global constant named `ManubulonPluginDir`
1764 is set to the path where the Manubublon SNMP plugins are installed.
1766 You can enable these plugin check commands by adding the following the include directive in your
1767 [icinga2.conf](4-configuring-icinga-2.md#icinga2-conf) configuration file:
1771 ### Checks by Host Type
1773 **N/A** : Not available for this type.
1775 **SNMP** : Available for simple SNMP query.
1779 **Specific** : Script name for platform specific checks.
1782 Host type | Interface | storage | load/cpu | mem | process | env | specific
1783 ------------------------|------------|----------|-----------|-----|----------|-----|-------------------------
1784 Linux | Yes | Yes | Yes | Yes | Yes | No |
1785 Windows | Yes | Yes | Yes | Yes | Yes | No | check_snmp_win.pl
1786 Cisco router/switch | Yes | N/A | Yes | Yes | N/A | Yes |
1787 HP router/switch | Yes | N/A | Yes | Yes | N/A | No |
1788 Bluecoat proxy | Yes | SNMP | Yes | SNMP| No | Yes |
1789 CheckPoint on SPLAT | Yes | Yes | Yes | Yes | Yes | No | check_snmp_cpfw.pl
1790 CheckPoint on Nokia IP | Yes | Yes | Yes | No | ?? | No | check_snmp_vrrp.pl
1791 Boostedge | Yes | Yes | Yes | Yes | ?? | No | check_snmp_boostedge.pl
1792 AS400 | Yes | Yes | Yes | Yes | No | No |
1793 NetsecureOne Netbox | Yes | Yes | Yes | ?? | Yes | No |
1794 Radware Linkproof | Yes | N/A | SNMP | SNMP| No | No | check_snmp_linkproof_nhr <br> check_snmp_vrrp.pl
1795 IronPort | Yes | SNMP | SNMP | SNMP| No | Yes |
1796 Cisco CSS | Yes | ?? | Yes | Yes | No | ?? | check_snmp_css.pl
1799 ### <a id="plugin-check-command-snmp-load"></a> snmp-load
1801 Check command object for the [check_snmp_load.pl](http://nagios.manubulon.com/snmp_load.html) plugin.
1803 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
1807 ------------------------|--------------
1808 snmp_address | **Optional.** The host's address. Defaults to "$address$" if the host's `address` attribute is set, "$address6$" otherwise.
1809 snmp_nocrypt | **Optional.** Define SNMP encryption. If set, **snmp_v3** needs to be set. Defaults to false.
1810 snmp_community | **Optional.** The SNMP community. Defaults to "public".
1811 snmp_port | **Optional.** The SNMP port connection.
1812 snmp_v2 | **Optional.** SNMP version to 2c. Defaults to false.
1813 snmp_v3 | **Optional.** SNMP version to 3. Defaults to false.
1814 snmp_login | **Optional.** SNMP version 3 username. Defaults to "snmpuser".
1815 snmp_password | **Required.** SNMP version 3 password. No value defined as default.
1816 snmp_v3_use_privpass | **Optional.** Define to use SNMP version 3 priv password. Defaults to false.
1817 snmp_authprotocol | **Optional.** SNMP version 3 authentication protocol. Defaults to "md5,des".
1818 snmp_privpass | **Required.** SNMP version 3 priv password. No value defined as default.
1819 snmp_warn | **Optional.** The warning threshold. Change the `snmp_load_type` var to "netsl" for using 3 values.
1820 snmp_crit | **Optional.** The critical threshold. Change the `snmp_load_type` var to "netsl" for using 3 values.
1821 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.
1822 snmp_perf | **Optional.** Enable perfdata values. Defaults to true.
1823 snmp_timeout | **Optional.** The command timeout in seconds. Defaults to 5 seconds.
1825 ### <a id="plugin-check-command-snmp-memory"></a> snmp-memory
1827 Check command object for the [check_snmp_mem.pl](http://nagios.manubulon.com/snmp_mem.html) plugin.
1829 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
1832 ------------------------|--------------
1833 snmp_address | **Optional.** The host's address. Defaults to "$address$" if the host's `address` attribute is set, "$address6$" otherwise.
1834 snmp_nocrypt | **Optional.** Define SNMP encryption. If set, **snmp_v3** needs to be set. Defaults to false.
1835 snmp_community | **Optional.** The SNMP community. Defaults to "public".
1836 snmp_port | **Optional.** The SNMP port connection.
1837 snmp_v2 | **Optional.** SNMP version to 2c. Defaults to false.
1838 snmp_v3 | **Optional.** SNMP version to 3. Defaults to false.
1839 snmp_login | **Optional.** SNMP version 3 username. Defaults to "snmpuser".
1840 snmp_password | **Required.** SNMP version 3 password. No value defined as default.
1841 snmp_v3_use_privpass | **Optional.** Define to use SNMP version 3 priv password. Defaults to false.
1842 snmp_authprotocol | **Optional.** SNMP version 3 authentication protocol. Defaults to "md5,des".
1843 snmp_privpass | **Required.** SNMP version 3 priv password. No value defined as default.
1844 snmp_warn | **Optional.** The warning threshold.
1845 snmp_crit | **Optional.** The critical threshold.
1846 snmp_is_cisco | **Optional.** Change OIDs for Cisco switches. Defaults to false.
1847 snmp_is_hp | **Optional.** Change OIDs for HP/Procurve switches. Defaults to false.
1848 snmp_perf | **Optional.** Enable perfdata values. Defaults to true.
1849 snmp_timeout | **Optional.** The command timeout in seconds. Defaults to 5 seconds.
1851 ### <a id="plugin-check-command-snmp-storage"></a> snmp-storage
1853 Check command object for the [check_snmp_storage.pl](http://nagios.manubulon.com/snmp_storage.html) plugin.
1855 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
1858 ------------------------|--------------
1859 snmp_address | **Optional.** The host's address. Defaults to "$address$" if the host's `address` attribute is set, "$address6$" otherwise.
1860 snmp_nocrypt | **Optional.** Define SNMP encryption. If set, **snmp_v3** needs to be set. Defaults to false.
1861 snmp_community | **Optional.** The SNMP community. Defaults to "public".
1862 snmp_port | **Optional.** The SNMP port connection.
1863 snmp_v2 | **Optional.** SNMP version to 2c. Defaults to false.
1864 snmp_v3 | **Optional.** SNMP version to 3. Defaults to false.
1865 snmp_login | **Optional.** SNMP version 3 username. Defaults to "snmpuser".
1866 snmp_password | **Required.** SNMP version 3 password. No value defined as default.
1867 snmp_v3_use_privpass | **Optional.** Define to use SNMP version 3 priv password. Defaults to false.
1868 snmp_authprotocol | **Optional.** SNMP version 3 authentication protocol. Defaults to "md5,des".
1869 snmp_privpass | **Required.** SNMP version 3 priv password. No value defined as default.
1870 snmp_warn | **Optional.** The warning threshold.
1871 snmp_crit | **Optional.** The critical threshold.
1872 snmp_storage_name | **Optional.** Storage name. Default to regex "^/$$". More options available in the [snmp storage](http://nagios.manubulon.com/snmp_storage.html) documentation.
1873 snmp_perf | **Optional.** Enable perfdata values. Defaults to true.
1874 snmp_timeout | **Optional.** The command timeout in seconds. Defaults to 5 seconds.
1876 ### <a id="plugin-check-command-snmp-interface"></a> snmp-interface
1878 Check command object for the [check_snmp_int.pl](http://nagios.manubulon.com/snmp_int.html) plugin.
1880 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
1883 ----------------------------|--------------
1884 snmp_address | **Optional.** The host's address. Defaults to "$address$" if the host's `address` attribute is set, "$address6$" otherwise.
1885 snmp_nocrypt | **Optional.** Define SNMP encryption. If set, **snmp_v3** needs to be set. Defaults to false.
1886 snmp_community | **Optional.** The SNMP community. Defaults to "public".
1887 snmp_port | **Optional.** The SNMP port connection.
1888 snmp_v2 | **Optional.** SNMP version to 2c. Defaults to false.
1889 snmp_v3 | **Optional.** SNMP version to 3. Defaults to false.
1890 snmp_login | **Optional.** SNMP version 3 username. Defaults to "snmpuser".
1891 snmp_password | **Required.** SNMP version 3 password. No value defined as default.
1892 snmp_v3_use_privpass | **Optional.** Define to use SNMP version 3 priv password. Defaults to false.
1893 snmp_authprotocol | **Optional.** SNMP version 3 authentication protocol. Defaults to "md5,des".
1894 snmp_privpass | **Required.** SNMP version 3 priv password. No value defined as default.
1895 snmp_warn | **Optional.** The warning threshold.
1896 snmp_crit | **Optional.** The critical threshold.
1897 snmp_interface | **Optional.** Network interface name. Default to regex "eth0".
1898 snmp_interface_inverse | **Optional.** Inverse Interface check, down is ok. Defaults to false as it is missing.
1899 snmp_interface_perf | **Optional.** Check the input/ouput bandwidth of the interface. Defaults to true.
1900 snmp_interface_label | **Optional.** Add label before speed in output: in=, out=, errors-out=, etc.
1901 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.
1902 snmp_interface_percent | **Optional.** Output performance data in % of max speed. Defaults to false.
1903 snmp_interface_kbits | **Optional.** Make the warning and critical levels in KBits/s. Defaults to true.
1904 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.
1905 snmp_interface_64bit | **Optional.** Use 64 bits counters instead of the standard counters when checking bandwidth & performance data for interface >= 1Gbps. Defaults to false.
1906 snmp_interface_errors | **Optional.** Add error & discard to Perfparse output. Defaults to true.
1907 snmp_interface_noregexp | **Optional.** Do not use regexp to match interface name in description OID. Defaults to false.
1908 snmp_interface_delta | **Optional.** Delta time of perfcheck. Defaults to "300" (5 min).
1909 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.
1910 snmp_interface_ifname | **Optional.** Switch from IF-MIB::ifDescr to IF-MIB::ifName when looking up the interface's name.
1911 snmp_interface_ifalias | **Optional.** Switch from IF-MIB::ifDescr to IF-MIB::ifAlias when looking up the interface's name.
1912 snmp_perf | **Optional.** Enable perfdata values. Defaults to true.
1913 snmp_timeout | **Optional.** The command timeout in seconds. Defaults to 5 seconds.
1915 ### <a id="plugin-check-command-snmp-process"></a> snmp-process
1917 Check command object for the [check_snmp_process.pl](http://nagios.manubulon.com/snmp_process.html) plugin.
1919 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
1922 ------------------------|--------------
1923 snmp_address | **Optional.** The host's address. Defaults to "$address$" if the host's `address` attribute is set, "$address6$" otherwise.
1924 snmp_nocrypt | **Optional.** Define SNMP encryption. If set, **snmp_v3** needs to be set. Defaults to false.
1925 snmp_community | **Optional.** The SNMP community. Defaults to "public".
1926 snmp_port | **Optional.** The SNMP port connection.
1927 snmp_v2 | **Optional.** SNMP version to 2c. Defaults to false.
1928 snmp_v3 | **Optional.** SNMP version to 3. Defaults to false.
1929 snmp_login | **Optional.** SNMP version 3 username. Defaults to "snmpuser".
1930 snmp_password | **Required.** SNMP version 3 password. No value defined as default.
1931 snmp_v3_use_privpass | **Optional.** Define to use SNMP version 3 priv password. Defaults to false.
1932 snmp_authprotocol | **Optional.** SNMP version 3 authentication protocol. Defaults to "md5,des".
1933 snmp_privpass | **Required.** SNMP version 3 priv password. No value defined as default..
1934 snmp_warn | **Optional.** The warning threshold.
1935 snmp_crit | **Optional.** The critical threshold.
1936 snmp_process_name | **Optional.** Name of the process (regexp). No trailing slash!. Defaults to ".*".
1937 snmp_perf | **Optional.** Enable perfdata values. Defaults to true.
1938 snmp_timeout | **Optional.** The command timeout in seconds. Defaults to 5 seconds.
1939 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.
1943 ## <a id="plugin-contrib"></a> Contributed Plugin Check Commands
1945 The contributed Plugin Check Commands provides various additional command definitions
1946 contributed by community members.
1948 These check commands assume that the global constant named `PluginContribDir`
1949 is set to the path where the user installs custom plugins and can be enabled by
1950 uncommenting the corresponding line in [icinga2.conf](4-configuring-icinga-2.md#icinga2-conf):
1952 include <plugin-contrib>
1954 ### <a id="plugin-contrib-databases"></a> Databases
1956 All database plugins go in this category.
1958 #### <a id="plugin-contrib-command-db2_health"></a> db2_health
1960 The plugin `db2_health` utilises Perl DBD::DB2.
1961 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).
1963 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
1966 ---------------------------------|------------------------------------------------------------------------------------------------------------------------------
1967 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)
1968 db2_health_username | **Optional.** The username for the database connection.
1969 db2_health_password | **Optional.** The password for the database connection.
1970 db2_health_port | **Optional.** The port where DB2 is listening.
1971 db2_health_warning | **Optional.** The warning threshold depending on the mode.
1972 db2_health_critical | **Optional.** The critical threshold depending on the mode.
1973 db2_health_mode | **Required.** The mode uses predefined keywords for the different checks. For example "connection-time", "database-usage" or "sql".
1974 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).
1975 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.
1976 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.
1977 db2_health_regexp | **Optional.** If set to true, "db2_health_name" will be interpreted as a regular expression. Defaults to false.
1978 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".
1979 db2_health_maxinactivity | **Optional.** Used for the maximum amount of time a certain event has not happened.
1980 db2_health_mitigation | **Optional.** Classifies the severity of an offline tablespace.
1981 db2_health_lookback | **Optional.** How many days in the past db2_health check should look back to calculate exitcode.
1982 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".
1983 db2_health_env_db2_version | **Optional.** Specifies the DB2 version as environment variable `DB2_VERSION`.
1985 #### <a id="plugin-contrib-command-mssql_health"></a> mssql_health
1987 The plugin `mssql_health` utilises Perl DBD::Sybase based on FreeTDS to connect to MSSQL databases for monitoring.
1988 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).
1990 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
1993 ---------------------------------|------------------------------------------------------------------------------------------------------------------------------
1994 mssql_health_hostname | **Optional.** Specifies the database hostname or address. No default because you typically use "mssql_health_server".
1995 mssql_health_port | **Optional.** Specifies the database port. No default because you typically use "mssql_health_server".
1996 mssql_health_server | **Optional.** The name of a predefined connection (in freetds.conf).
1997 mssql_health_currentdb | **Optional.** The name of a database which is used as the current database for the connection.
1998 mssql_health_username | **Optional.** The username for the database connection.
1999 mssql_health_password | **Optional.** The password for the database connection.
2000 mssql_health_warning | **Optional.** The warning threshold depending on the mode.
2001 mssql_health_critical | **Optional.** The critical threshold depending on the mode.
2002 mssql_health_mode | **Required.** The mode uses predefined keywords for the different checks. For example "connection-time", "database-free" or "sql".
2003 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).
2004 mssql_health_name | **Optional.** Depending on the mode this could be the database name or a SQL statement.
2005 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.
2006 mssql_health_regexp | **Optional.** If set to true, "mssql_health_name" will be interpreted as a regular expression. Defaults to false.
2007 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".
2008 mssql_health_offlineok | **Optional.** Set this to true if offline databases are perfectly ok for you. Defaults to false.
2009 mssql_health_commit | **Optional.** Set this to true to turn on autocommit for the dbd::sybase module. Defaults to false.
2011 #### <a id="plugin-contrib-command-mysql_health"></a> mysql_health
2013 The plugin `mysql_health` utilises Perl DBD::MySQL to connect to MySQL databases for monitoring.
2014 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).
2016 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
2019 ---------------------------------|------------------------------------------------------------------------------------------------------------------------------
2020 mysql_health_hostname | **Required.** Specifies the database hostname or address. Defaults to "$address$" or "$address6$" if the `address` attribute is not set.
2021 mysql_health_port | **Optional.** Specifies the database port. Defaults to 3306 (or 1186 for "mysql_health_mode" cluster).
2022 mysql_health_socket | **Optional.** Specifies the database unix socket. No default.
2023 mysql_health_username | **Optional.** The username for the database connection.
2024 mysql_health_password | **Optional.** The password for the database connection.
2025 mysql_health_database | **Optional.** The database to connect to. Defaults to information_schema.
2026 mysql_health_warning | **Optional.** The warning threshold depending on the mode.
2027 mysql_health_critical | **Optional.** The critical threshold depending on the mode.
2028 mysql_health_warningx | **Optional.** The extended warning thresholds depending on the mode.
2029 mysql_health_criticalx | **Optional.** The extended critical thresholds depending on the mode.
2030 mysql_health_mode | **Required.** The mode uses predefined keywords for the different checks. For example "connection-time", "slave-lag" or "sql".
2031 mysql_health_method | **Optional.** How the plugin should connect to the database (`dbi` for using DBD::Mysql (default), `mysql` for using the mysql-Tool).
2032 mysql_health_commit | **Optional.** Turns on autocommit for the dbd::* module.
2033 mysql_health_notemp | **Optional.** Ignore temporary databases/tablespaces.
2034 mysql_health_nooffline | **Optional.** Skip the offline databases.
2035 mysql_health_regexp | **Optional.** Parameter name/name2/name3 will be interpreted as (perl) regular expression.
2036 mysql_health_name | **Optional.** The name of a specific component to check.
2037 mysql_health_name2 | **Optional.** The secondary name of a component.
2038 mysql_health_name3 | **Optional.** The tertiary name of a component.
2039 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".
2040 mysql_health_labelformat | **Optional.** One of those formats pnp4nagios or groundwork. Defaults to pnp4nagios.
2041 mysql_health_extraopts | **Optional.** Read command line arguments from an external file.
2042 mysql_health_blacklist | **Optional.** Blacklist some (missing/failed) components"
2043 mysql_health_mitigation | **Optional.** "The parameter allows you to change a critical error to a warning."
2044 mysql_health_lookback | **Optional.** The amount of time you want to look back when calculating average rates."
2045 mysql_health_environment | **Optional.** Add a variable to the plugin's environment."
2046 mysql_health_morphmessage | **Optional.** Modify the final output message."
2047 mysql_health_morphperfdata | **Optional.** The parameter allows you to change performance data labels."
2048 mysql_health_selectedperfdata | **Optional.** The parameter allows you to limit the list of performance data."
2049 mysql_health_report | **Optional.** Can be used to shorten the output."
2050 mysql_health_multiline | **Optional.** Multiline output."
2051 mysql_health_negate | **Optional.** Emulate the negate plugin. --negate warning=critical --negate unknown=critical."
2052 mysql_health_withmymodulesdyndir | **Optional.** Add-on modules for the my-modes will be searched in this directory."
2053 mysql_health_statefilesdir | **Optional.** An alternate directory where the plugin can save files."
2054 mysql_health_isvalidtime | **Optional.** Signals the plugin to return OK if now is not a valid check time."
2055 mysql_health_timeout | **Optional.** Plugin timeout. Defaults to 60s.
2057 #### <a id="plugin-contrib-command-oracle_health"></a> oracle_health
2059 The plugin `oracle_health` utilises Perl DBD::Oracle based on oracle-instantclient-sdk or sqlplus to connect to Oracle databases for monitoring.
2060 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).
2062 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
2065 ---------------------------------|------------------------------------------------------------------------------------------------------------------------------
2066 oracle_health_connect | **Required.** Specifies the database connection string (from tnsnames.ora).
2067 oracle_health_username | **Optional.** The username for the database connection.
2068 oracle_health_password | **Optional.** The password for the database connection.
2069 oracle_health_warning | **Optional.** The warning threshold depending on the mode.
2070 oracle_health_critical | **Optional.** The critical threshold depending on the mode.
2071 oracle_health_mode | **Required.** The mode uses predefined keywords for the different checks. For example "connection-time", "flash-recovery-area-usage" or "sql".
2072 oracle_health_method | **Optional.** How the plugin should connect to the database (`dbi` for using DBD::Oracle (default), `sqlplus` for using the sqlplus-Tool).
2073 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.
2074 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.
2075 oracle_health_regexp | **Optional.** If set to true, "oracle_health_name" will be interpreted as a regular expression. Defaults to false.
2076 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".
2077 oracle_health_ident | **Optional.** If set to true, outputs instance and database names. Defaults to false.
2078 oracle_health_commit | **Optional.** Set this to true to turn on autocommit for the dbd::oracle module. Defaults to false.
2079 oracle_health_noperfdata | **Optional.** Set this to true if you want to disable perfdata. Defaults to false.
2080 oracle_health_timeout | **Optional.** Plugin timeout. Defaults to 60s.
2081 oracle_health_report | **Optional.** Select the plugin output format. Can be short or long. Default to long.
2086 --------------------|------------------------------------------------------------------------------------------------------------------------------------------
2087 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".
2088 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".
2090 #### <a id="plugin-contrib-command-postgres"></a> postgres
2092 The plugin `postgres` utilises the psql binary to connect to PostgreSQL databases for monitoring.
2093 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).
2095 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
2098 ---------------------------------|------------------------------------------------------------------------------------------------------------------------------
2099 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.
2100 postgres_port | **Optional.** Specifies the database port. Defaults to 5432.
2101 postgres_dbname | **Optional.** Specifies the database name to connect to. Defaults to "postgres" or "template1".
2102 postgres_dbuser | **Optional.** The username for the database connection. Defaults to "postgres".
2103 postgres_dbpass | **Optional.** The password for the database connection. You can use a .pgpass file instead.
2104 postgres_dbservice | **Optional.** Specifies the service name to use inside of pg_service.conf.
2105 postgres_warning | **Optional.** Specifies the warning threshold, range depends on the action.
2106 postgres_critical | **Optional.** Specifies the critical threshold, range depends on the action.
2107 postgres_include | **Optional.** Specifies name(s) items to specifically include (e.g. tables), depends on the action.
2108 postgres_exclude | **Optional.** Specifies name(s) items to specifically exclude (e.g. tables), depends on the action.
2109 postgres_includeuser | **Optional.** Include objects owned by certain users.
2110 postgres_excludeuser | **Optional.** Exclude objects owned by certain users.
2111 postgres_standby | **Optional.** Assume that the server is in continious WAL recovery mode if set to true. Defaults to false.
2112 postgres_production | **Optional.** Assume that the server is in production mode if set to true. Defaults to false.
2113 postgres_action | **Required.** Determines the test executed.
2114 postgres_unixsocket | **Optional.** If "postgres_unixsocket" is set to true, the unix socket is used instead of an address. Defaults to false.
2115 postgres_query | **Optional.** Query for "custom_query" action.
2116 postgres_valtype | **Optional.** Value type of query result for "custom_query".
2117 postgres_reverse | **Optional.** If "postgres_reverse" is set, warning and critical values are reversed for "custom_query" action.
2118 postgres_tempdir | **Optional.** Specify directory for temporary files. The default directory is dependent on the OS. More details [here](http://perldoc.perl.org/File/Spec.html).
2120 #### <a id="plugin-contrib-command-mongodb"></a> mongodb
2122 The plugin `mongodb` utilises Python PyMongo.
2123 For development check [https://github.com](https://github.com/mzupan/nagios-plugin-mongodb).
2125 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
2128 ---------------------------------|------------------------------------------------------------------------------------------------------------------------------
2129 mongodb_host | **Required.** Specifies the hostname or address.
2130 mongodb_port | **Required.** The port mongodb is runnung on.
2131 mongodb_user | **Optional.** The username you want to login as
2132 mongodb_passwd | **Optional.** The password you want to use for that user
2133 mongodb_warning | **Optional.** The warning threshold we want to set
2134 mongodb_critical | **Optional.** The critical threshold we want to set
2135 mongodb_action | **Required.** The action you want to take
2136 mongodb_maxlag | **Optional.** Get max replication lag (for replication_lag action only)
2137 mongodb_mappedmemory | **Optional.** Get mapped memory instead of resident (if resident memory can not be read)
2138 mongodb_perfdata | **Optional.** Enable output of Nagios performance data
2139 mongodb_database | **Optional.** Specify the database to check
2140 mongodb_alldatabases | **Optional.** Check all databases (action database_size)
2141 mongodb_ssl | **Optional.** Connect using SSL
2142 mongodb_replicaset | **Optional.** Connect to replicaset
2143 mongodb_replcheck | **Optional.** If set to true, will enable the mongodb_replicaset value needed for "replica_primary" check
2144 mongodb_querytype | **Optional.** The query type to check [query\|insert\|update\|delete\|getmore\|command] from queries_per_second
2145 mongodb_collection | **Optional.** Specify the collection to check
2146 mongodb_sampletime | **Optional.** Time used to sample number of pages faults
2148 #### <a id="plugin-contrib-command-elasticsearch"></a> elasticsearch
2150 An [ElasticSearch](https://www.elastic.co/products/elasticsearch) availability
2151 and performance monitoring plugin available for download at [GitHub](https://github.com/anchor/nagios-plugin-elasticsearch).
2152 The plugin requires the HTTP API enabled on your ElasticSearch node.
2155 -----------------------------|-------------------------------------------------------------------------------------------------------
2156 elasticsearch_failuredomain | **Optional.** A comma-separated list of ElasticSearch attributes that make up your cluster's failure domain.
2157 elasticsearch_host | **Optional.** Hostname or network address to probe. Defaults to 'localhost'.
2158 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.
2159 elasticsearch_port | **Optional.** TCP port to probe. The ElasticSearch API should be listening here. Defaults to 9200.
2160 elasticsearch_prefix | **Optional.** Optional prefix (e.g. 'es') for the ElasticSearch API. Defaults to ''.
2161 elasticsearch_yellowcritical | **Optional.** Instead of issuing a 'warning' for a yellow cluster state, issue a 'critical' alert. Defaults to false.
2163 #### <a id="plugin-contrib-command-redis"></a> redis
2165 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).
2166 It is provided by `William Leibzon` at [https://github.com](https://github.com/willixix/naglio-plugins/blob/master/check_redis.pl).
2169 -------------------------|--------------------------------------------------------------------------------------------------------------
2170 redis_hostname | **Required.** Hostname or IP Address to check. Defaults to "127.0.0.1".
2171 redis_port | **Optional.** Port number to query. Default to "6379".
2172 redis_database | **Optional.** Database name (usually a number) to query, needed for **redis_query**.
2173 redis_password | **Optional.** Password for Redis authentication. Safer alternative is to put them in a file and use **redis_credentials**.
2174 redis_credentials | **Optional.** Credentials file to read for Redis authentication.
2175 redis_timeout | **Optional.** Allows to set timeout for execution of this plugin.
2176 redis_variables | **Optional.** List of variables from info data to do threshold checks on.
2177 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.
2178 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.
2179 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.
2180 redis_perfvars | **Optional.** This allows to list variables which values will go only into perfparse output (and not for threshold checking).
2181 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.
2182 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".
2183 redis_query | **Optional.** Option specifies key to query and optional variable name to assign the results to after.
2184 redis_option | **Optional.** Specifiers are separated by "," and must include NAME or PATTERN.
2185 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.
2186 redis_hitrate | **Optional.** Calculates Hitrate and specify values are interpreted as WARNING and CRITICAL thresholds.
2187 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.
2188 redis_total_memory | **Optional.** Amount of memory on a system for memory utilization calculation. Use system memory or max_memory setting of redis.
2189 redis_replication_delay | **Optional.** Allows to set threshold on replication delay info.
2192 ### <a id="plugin-contrib-hardware"></a> Hardware
2194 This category includes all plugins for various hardware checks.
2196 #### <a id="plugin-contrib-command-hpasm"></a> hpasm
2198 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.
2200 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
2203 --------------------------------|-----------------------------------------------------------------------
2204 hpasm_hostname | **Optional.** The host's address. Defaults to "$address$" if the host's `address` attribute is set, "$address6$" otherwise.
2205 hpasm_community | **Optional.** SNMP community of the server (SNMP v1/2 only).
2206 hpasm_protocol | **Optional.** The SNMP protocol to use (default: 2c, other possibilities: 1,3).
2207 hpasm_port | **Optional.** The SNMP port to use (default: 161).
2208 hpasm_blacklist | **Optional.** Blacklist some (missing/failed) components.
2209 hpasm_ignore-dimms | **Optional.** Ignore "N/A"-DIMM status on misc. servers (e.g. older DL320).
2210 hpasm_ignore-fan-redundancy | **Optional.** Ignore missing redundancy partners.
2211 hpasm_customthresholds | **Optional.** Use custom thresholds for certain temperatures.
2212 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.
2213 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.
2214 hpasm_username | **Optional.** The securityName for the USM security model (SNMPv3 only).
2215 hpasm_authpassword | **Optional.** The authentication password for SNMPv3.
2216 hpasm_authprotocol | **Optional.** The authentication protocol for SNMPv3 (md5\|sha).
2217 hpasm_privpassword | **Optional.** The password for authPriv security level.
2218 hpasm_privprotocol | **Optional.** The private protocol for SNMPv3 (des\|aes\|aes128\|3des\|3desde).
2219 hpasm_servertype | **Optional.** The type of the server: proliant (default) or bladesystem.
2220 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.
2223 ### <a id="plugin-contrib-icingacli"></a> IcingaCLI
2225 This category includes all plugins using the icingacli provided by Icinga Web 2.
2227 #### <a id="plugin-contrib-icingacli-businessprocess"></a> Business Process
2229 This subcommand is provided by the [business process module](https://exchange.icinga.com/icinga/Business+Process) and executed as `icingacli-businessprocess`. The module is hosted by the Icinga project on its [project homepage](https://github.com/Icinga/icingaweb2-module-businessprocess).
2231 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
2234 ------------------------------------------|-----------------------------------------------------------------------------------------
2235 icingacli_businessprocess_process | **Required.** Business process to monitor.
2236 icingacli_businessprocess_config | **Optional.** Configuration file containing your business process without file extension.
2237 icingacli_businessprocess_details | **Optional.** Get details for root cause analyses. Defaults to false.
2240 ### <a id="plugin-contrib-ipmi"></a> IPMI Devices
2242 This category includes all plugins for IPMI devices.
2244 #### <a id="plugin-contrib-command-ipmi-sensor"></a> ipmi-sensor
2246 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.
2248 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
2251 ---------------------------------|-----------------------------------------------------------------------------------------------------
2252 ipmi_address | **Required.** Specifies the remote host (IPMI device) to check. Defaults to "$address$".
2253 ipmi_config_file | **Optional.** Path to the FreeIPMI configuration file. It should contain IPMI username, IPMI password, and IPMI privilege-level.
2254 ipmi_username | **Optional.** The IPMI username.
2255 ipmi_password | **Optional.** The IPMI password.
2256 ipmi_privilege_level | **Optional.** The IPMI privilege level of the IPMI user.
2257 ipmi_backward_compatibility_mode | **Optional.** Enable backward compatibility mode, useful for FreeIPMI 0.5.\* (this omits FreeIPMI options "--quiet-cache" and "--sdr-cache-recreate").
2258 ipmi_sensor_type | **Optional.** Limit sensors to query based on IPMI sensor type. Examples for IPMI sensor types are 'Fan', 'Temperature' and 'Voltage'.
2259 ipmi_sel_type | **Optional.** Limit SEL entries to specific types, run 'ipmi-sel -L' for a list of types. All sensors are populated to the SEL and per default all sensor types are monitored.
2260 ipmi_exclude_sensor_id | **Optional.** Exclude sensor matching ipmi_sensor_id.
2261 ipmi_exclude_sensor | **Optional.** Exclude sensor based on IPMI sensor type. (Comma-separated)
2262 ipmi_exclude_sel | **Optional.** Exclude SEL entries of specific sensor types. (comma-separated list).
2263 ipmi_sensor_id | **Optional.** Include sensor matching ipmi_sensor_id.
2264 ipmi_protocal_lan_version | **Optional.** Change the protocol LAN version. Defaults to "LAN_2_0".
2265 ipmi_number_of_active_fans | **Optional.** Number of fans that should be active. Otherwise a WARNING state is returned.
2266 ipmi_show_fru | **Optional.** Print the product serial number if it is available in the IPMI FRU data.
2267 ipmi_no_sel_checking | **Optional.** Turn off system event log checking via ipmi-sel.
2268 ipmi_verbose | **Optional.** Be Verbose multi line output, also with additional details for warnings.
2269 ipmi_debug | **Optional.** Be Verbose debugging output, followed by normal multi line output.
2274 ### <a id="plugins-contrib-log-management"></a> Log Management
2276 This category includes all plugins for log management, for example [Logstash](https://www.elastic.co/products/logstash).
2278 #### <a id="plugins-contrib-command-logstash"></a> logstash
2280 The [logstash](https://github.com/widhalmt/check_logstash) plugin connects to
2281 the Node API of Logstash. This plugin requires at least Logstash version 5.0.x.
2283 The Node API is not activated by default. You have to configure your Logstash
2284 installation in order to allow plugin connections.
2287 ---------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
2288 logstash_hostname | **Optional.** Hostname where Logstash is running. Defaults to `check_address`
2289 logstash_port | **Optional.** Port where Logstash is listening for API requests. Defaults to 9600
2290 logstash_filedesc_warn | **Optional.** Warning threshold of file descriptor usage in percent. Defaults to 85 (percent).
2291 logstash_filedesc_crit | **Optional.** Critical threshold of file descriptor usage in percent. Defaults to 95 (percent).
2292 logstash_heap_warn | **Optional.** Warning threshold of heap usage in percent. Defaults to 70 (percent).
2293 logstash_heap_crit | **Optional.** Critical threshold of heap usage in percent Defaults to 80 (percent).
2294 logstash_inflight_warn | **Optional.** Warning threshold of inflight events.
2295 logstash_inflight_crit | **Optional.** Critical threshold of inflight events.
2296 logstash_cpu_warn | **Optional.** Warning threshold for cpu usage in percent.
2297 logstash_cpu_crit | **Optional.** Critical threshold for cpu usage in percent.
2300 ### <a id="plugin-contrib-metrics"></a> Metrics
2302 This category includes all plugins for metric-based checks.
2304 #### <a id="plugin-contrib-command-graphite"></a> graphite
2306 Check command object for the [check_graphite](https://github.com/obfuscurity/nagios-scripts) plugin.
2308 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
2311 ------------------------------------|-----------------------------------------------------------------------------------------------------
2312 graphite_url | **Required.** Target url.
2313 graphite_metric | **Required.** Metric path string.
2314 graphite_shortname | **Optional.** Metric short name (used for performance data).
2315 graphite_duration | **Optional.** Length, in minute of data to parse (default: 5).
2316 graphite_function | **Optional.** Function applied to metrics for thresholds (default: average).
2317 graphite_warning | **Required.** Warning threshold.
2318 graphite_critical | **Required.** Critical threshold.
2319 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.
2320 graphite_message | **Optional.** Text message to output (default: "metric count:").
2321 graphite_zero_on_error | **Optional.** Return 0 on a graphite 500 error.
2322 graphite_link_graph | **Optional.** Add a link in the plugin output, showing a 24h graph for this metric in graphite.
2324 ### <a id="plugin-contrib-network-components"></a> Network Components
2326 This category includes all plugins for various network components like routers, switches and firewalls.
2328 #### <a id="plugin-contrib-command-interfacetable"></a> interfacetable
2330 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).
2332 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
2335 ------------------------------------|-----------------------------------------------------------------------------------------------------
2336 interfacetable_hostquery | **Required.** Specifies the remote host to poll. Defaults to "$address$".
2337 interfacetable_hostdisplay | **Optional.** Specifies the hostname to display in the HTML link. Defaults to "$host.display_name$".
2338 interfacetable_regex | **Optional.** Interface names and property names for some other options will be interpreted as regular expressions. Defaults to false.
2339 interfacetable_outputshort | **Optional.** Reduce the verbosity of the plugin output. Defaults to false.
2340 interfacetable_exclude | **Optional.** Comma separated list of interfaces globally excluded from the monitoring.
2341 interfacetable_include | **Optional.** Comma separated list of interfaces globally included in the monitoring.
2342 interfacetable_aliasmatching | **Optional.** Allow you to specify alias in addition to interface names. Defaults to false.
2343 interfacetable_excludetraffic | **Optional.** Comma separated list of interfaces excluded from traffic checks.
2344 interfacetable_includetraffic | **Optional.** Comma separated list of interfaces included for traffic checks.
2345 interfacetable_warningtraffic | **Optional.** Interface traffic load percentage leading to a warning alert.
2346 interfacetable_criticaltraffic | **Optional.** Interface traffic load percentage leading to a critical alert.
2347 interfacetable_pkt | **Optional.** Add unicast/non-unicast pkt stats for each interface.
2348 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.
2349 interfacetable_trackproperty | **Optional.** List of tracked properties.
2350 interfacetable_excludeproperty | **Optional.** Comma separated list of interfaces excluded from the property tracking.
2351 interfacetable_includeproperty | **Optional.** Comma separated list of interfaces included in the property tracking.
2352 interfacetable_community | **Optional.** Specifies the snmp v1/v2c community string. Defaults to "public" if using snmp v1/v2c, ignored using v3.
2353 interfacetable_snmpv2 | **Optional.** Use snmp v2c. Defaults to false.
2354 interfacetable_login | **Optional.** Login for snmpv3 authentication.
2355 interfacetable_passwd | **Optional.** Auth password for snmpv3 authentication.
2356 interfacetable_privpass | **Optional.** Priv password for snmpv3 authentication.
2357 interfacetable_protocols | **Optional.** Authentication protocol,Priv protocol for snmpv3 authentication.
2358 interfacetable_domain | **Optional.** SNMP transport domain.
2359 interfacetable_contextname | **Optional.** Context name for the snmp requests.
2360 interfacetable_port | **Optional.** SNMP port. Defaults to standard port.
2361 interfacetable_64bits | **Optional.** Use SNMP 64-bits counters. Defaults to false.
2362 interfacetable_maxrepetitions | **Optional.** Increasing this value may enhance snmp query performances by gathering more results at one time.
2363 interfacetable_snmptimeout | **Optional.** Define the Transport Layer timeout for the snmp queries.
2364 interfacetable_snmpretries | **Optional.** Define the number of times to retry sending a SNMP message.
2365 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.
2366 interfacetable_unixsnmp | **Optional.** Use unix snmp utilities for snmp requests. Defaults to false, which means use the perl bindings.
2367 interfacetable_enableperfdata | **Optional.** Enable port performance data. Defaults to false.
2368 interfacetable_perfdataformat | **Optional.** Define which performance data will be generated. Possible values are "full" (default), "loadonly", "globalonly".
2369 interfacetable_perfdatathreshold | **Optional.** Define which thresholds are printed in the generated performance data. Possible values are "full" (default), "loadonly", "globalonly".
2370 interfacetable_perfdatadir | **Optional.** When specified, the performance data are also written directly to a file, in the specified location.
2371 interfacetable_perfdataservicedesc | **Optional.** Specify additional parameters for output performance data to PNP. Defaults to "$service.name$", only affects **interfacetable_perfdatadir**.
2372 interfacetable_grapher | **Optional.** Specify the used graphing solution. Possible values are "pnp4nagios" (default), "nagiosgrapher", "netwaysgrapherv2" and "ingraph".
2373 interfacetable_grapherurl | **Optional.** Graphing system url. Default depends on **interfacetable_grapher**.
2374 interfacetable_portperfunit | **Optional.** Traffic could be reported in bits (counters) or in bps (calculated value).
2375 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".
2376 interfacetable_duplex | **Optional.** Add the duplex mode property for each interface in the interface table. Defaults to false.
2377 interfacetable_stp | **Optional.** Add the stp state property for each interface in the interface table. Defaults to false.
2378 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"
2379 interfacetable_noipinfo | **Optional.** Remove the ip information for each interface from the interface table. Defaults to false.
2380 interfacetable_alias | **Optional.** Add the alias information for each interface in the interface table. Defaults to false.
2381 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.
2382 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.
2383 interfacetable_delta | **Optional.** Set the delta used for interface throuput calculation in seconds.
2384 interfacetable_ifs | **Optional.** Input field separator. Defaults to ",".
2385 interfacetable_cache | **Optional.** Define the retention time of the cached data in seconds.
2386 interfacetable_noifloadgradient | **Optional.** Disable color gradient from green over yellow to red for the load percentage. Defaults to false.
2387 interfacetable_nohuman | **Optional.** Do not translate bandwidth usage in human readable format. Defaults to false.
2388 interfacetable_snapshot | **Optional.** Force the plugin to run like if it was the first launch. Defaults to false.
2389 interfacetable_timeout | **Optional.** Define the global timeout limit of the plugin in seconds. Defaults to "15s".
2390 interfacetable_css | **Optional.** Define the css stylesheet used by the generated html files. Possible values are "classic", "icinga", "icinga-alternate1" or "nagiosxi".
2391 interfacetable_config | **Optional.** Specify a config file to load.
2392 interfacetable_noconfigtable | **Optional.** Disable configuration table on the generated HTML page. Defaults to false.
2393 interfacetable_notips | **Optional.** Disable the tips in the generated html tables. Defaults to false.
2394 interfacetable_defaulttablesorting | **Optional.** Default table sorting can be "index" (default) or "name".
2395 interfacetable_tablesplit | **Optional.** Generate multiple interface tables, one per interface type. Defaults to false.
2396 interfacetable_notype | **Optional.** Remove the interface type for each interface. Defaults to false.
2398 #### <a id="plugin-contrib-command-iftraffic"></a> iftraffic
2400 The plugin [check_iftraffic](https://exchange.icinga.com/exchange/iftraffic)
2401 checks the utilization of a given interface name using the SNMP protocol.
2403 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
2406 ------------------------|---------------------------------------------------------
2407 iftraffic_address | **Required.** Specifies the remote host. Defaults to "$address$".
2408 iftraffic_community | **Optional.** SNMP community. Defaults to "public'" if omitted.
2409 iftraffic_interface | **Required.** Queried interface name.
2410 iftraffic_bandwidth | **Required.** Interface maximum speed in kilo/mega/giga/bits per second.
2411 iftraffic_units | **Optional.** Interface units can be one of these values: `g` (gigabits/s),`m` (megabits/s), `k` (kilobits/s),`b` (bits/s)
2412 iftraffic_warn | **Optional.** Percent of bandwidth usage necessary to result in warning status (defaults to `85`).
2413 iftraffic_crit | **Optional.** Percent of bandwidth usage necessary to result in critical status (defaults to `98`).
2414 iftraffic_max_counter | **Optional.** Maximum counter value of net devices in kilo/mega/giga/bytes.
2416 #### <a id="plugin-contrib-command-iftraffic64"></a> iftraffic64
2418 The plugin [check_iftraffic64](https://exchange.icinga.com/exchange/iftraffic64)
2419 checks the utilization of a given interface name using the SNMP protocol.
2421 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
2424 ------------------------|---------------------------------------------------------
2425 iftraffic64_address | **Required.** Specifies the remote host. Defaults to "$address$".
2426 iftraffic64_community | **Optional.** SNMP community. Defaults to "public'" if omitted.
2427 iftraffic64_interface | **Required.** Queried interface name.
2428 iftraffic64_bandwidth | **Required.** Interface maximum speed in kilo/mega/giga/bits per second.
2429 iftraffic64_units | **Optional.** Interface units can be one of these values: `g` (gigabits/s),`m` (megabits/s), `k` (kilobits/s),`b` (bits/s)
2430 iftraffic64_warn | **Optional.** Percent of bandwidth usage necessary to result in warning status (defaults to `85`).
2431 iftraffic64_crit | **Optional.** Percent of bandwidth usage necessary to result in critical status (defaults to `98`).
2432 iftraffic64_max_counter | **Optional.** Maximum counter value of net devices in kilo/mega/giga/bytes.
2434 #### <a id="plugin-contrib-command-interfaces"></a> interfaces
2436 The plugin [check_interfaces](https://www.netways.org/projects/check-interfaces)
2437 Check interfaces and utilization.
2439 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
2442 --------------------------|---------------------------------------------------------
2443 interfaces_address | **Optional.** The host's address. Defaults to "$address$" if the host's `address` attribute is set, "$address6$" otherwise.
2444 interfaces_regex | **Optional.** Interface list regexp.
2445 interfaces_exclude_regex | **Optional.** Interface list negative regexp.
2446 interfaces_errors | **Optional.** Number of in errors (CRC errors for cisco) to consider a warning (default 50).
2447 interface_out_errors | **Optional.** Number of out errors (collisions for cisco) to consider a warning (default same as in errors).
2448 interfaces_perfdata | **Optional.** perfdata from last check result.
2449 interfaces_prefix | **Optional.** Prefix interface names with this label.
2450 interfaces_lastcheck | **Optional.** Last checktime (unixtime).
2451 interfaces_bandwidth | **Optional.** Bandwidth warn level in percent.
2452 interfaces_speed | **Optional.** Override speed detection with this value (bits per sec).
2453 interfaces_trim | **Optional.** Cut this number of characters from the start of interface descriptions.
2454 interfaces_mode | **Optional.** Special operating mode (default,cisco,nonbulk,bintec).
2455 interfaces_auth_proto | **Optional.** SNMPv3 Auth Protocol (SHA\|MD5)
2456 interfaces_auth_phrase | **Optional.** SNMPv3 Auth Phrase
2457 interfaces_priv_proto | **Optional.** SNMPv3 Privacy Protocol (AES\|DES)
2458 interfaces_priv_phrase | **Optional.** SNMPv3 Privacy Phrase
2459 interfaces_user | **Optional.** SNMPv3 User
2460 interfaces_down_is_ok | **Optional.** Disables critical alerts for down interfaces.
2461 interfaces_aliases | **Optional.** Retrieves the interface description.
2462 interfaces_match_aliases | **Optional.** Also match against aliases (Option --aliases automatically enabled).
2463 interfaces_timeout | **Optional.** Sets the SNMP timeout (in ms).
2464 interfaces_sleep | **Optional.** Sleep between every SNMP query (in ms).
2466 #### <a id="plugin-contrib-command-nwc_health"></a> nwc_health
2468 The plugin [check_nwc_health](https://labs.consol.de/de/nagios/check_nwc_health/index.html)
2469 Check switches, router, there interfaces and utilization.
2471 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
2474 --------------------------------|---------------------------------------------------------
2475 nwc_health_hostname | **Optional.** The host's address. Defaults to "$address$" if the host's `address` attribute is set, "$address6$" otherwise.
2476 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).
2477 nwc_health_timeout | **Optional.** Seconds before plugin times out (default: 15)
2478 nwc_health_blacklist | **Optional.** Blacklist some (missing/failed) components.
2479 nwc_health_port | **Optional.** The SNMP port to use (default: 161).
2480 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).
2481 nwc_health_protocol | **Optional.** The SNMP protocol to use (default: 2c, other possibilities: 1,3).
2482 nwc_health_community | **Optional.** SNMP community of the server (SNMP v1/2 only).
2483 nwc_health_username | **Optional.** The securityName for the USM security model (SNMPv3 only).
2484 nwc_health_authpassword | **Optional.** The authentication password for SNMPv3.
2485 nwc_health_authprotocol | **Optional.** The authentication protocol for SNMPv3 (md5\|sha).
2486 nwc_health_privpassword | **Optional.** The password for authPriv security level.
2487 nwc_health_privprotocol | **Optional.** The private protocol for SNMPv3 (des\|aes\|aes128\|3des\|3desde).
2488 nwc_health_contextengineid | **Optional.** The context engine id for SNMPv3 (10 to 64 hex characters).
2489 nwc_health_contextname | **Optional.** The context name for SNMPv3 (empty represents the default context).
2490 nwc_health_name | **Optional.** The name of an interface (ifDescr).
2491 nwc_health_drecksptkdb | **Optional.** This parameter must be used instead of --name, because Devel::ptkdb is stealing the latter from the command line.
2492 nwc_health_alias | **Optional.** The alias name of a 64bit-interface (ifAlias)
2493 nwc_health_regexp | **Optional.** A flag indicating that --name is a regular expression
2494 nwc_health_ifspeedin | **Optional.** Override the ifspeed oid of an interface (only inbound)
2495 nwc_health_ifspeedout | **Optional.** Override the ifspeed oid of an interface (only outbound)
2496 nwc_health_ifspeed | **Optional.** Override the ifspeed oid of an interface
2497 nwc_health_units | **Optional.** One of %, B, KB, MB, GB, Bit, KBi, MBi, GBi. (used for e.g. mode interface-usage)
2498 nwc_health_name2 | **Optional.** The secondary name of a component.
2499 nwc_health_role | **Optional.** The role of this device in a hsrp group (active/standby/listen).
2500 nwc_health_report | **Optional.** Can be used to shorten the output.
2501 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.
2502 nwc_health_warning | **Optional.** The warning threshold
2503 nwc_health_critical | **Optional.** The critical threshold
2504 nwc_health_warningx | **Optional.** The extended warning thresholds
2505 nwc_health_criticalx | **Optional.** The extended critical thresholds
2506 nwc_health_mitigation | **Optional.** The parameter allows you to change a critical error to a warning.
2507 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.
2508 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'
2509 nwc_health_negate | **Optional.** The parameter allows you to map exit levels, such as warning=critical.
2510 nwc_health_mymodules-dyn-dir | **Optional.** A directory where own extensions can be found.
2511 nwc_health_servertype | **Optional.** The type of the network device: cisco (default). Use it if auto-detection is not possible.
2512 nwc_health_statefilesdir | **Optional.** An alternate directory where the plugin can save files.
2513 nwc_health_oids | **Optional.** A list of oids which are downloaded and written to a cache file. Use it together with --mode oidcache.
2514 nwc_health_offline | **Optional.** The maximum number of seconds since the last update of cache file before it is considered too old.
2515 nwc_health_multiline | **Optional.** Multiline output
2518 ### <a id="plugin-contrib-operating-system"></a> Operating System
2520 In this category you can find plugins for gathering information about your operating system or the system beneath like memory usage.
2522 #### <a id="plugin-contrib-command-mem"></a> mem
2524 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).
2526 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
2529 -------------|-----------------------------------------------------------------------------------------------------------------------
2530 mem_used | **Optional.** Tell the plugin to check for used memory in opposite of **mem_free**. Must specify one of these as true.
2531 mem_free | **Optional.** Tell the plugin to check for free memory in opposite of **mem_used**. Must specify one of these as true.
2532 mem_cache | **Optional.** If set to true, plugin will count cache as free memory. Defaults to false.
2533 mem_warning | **Required.** Specify the warning threshold as number interpreted as percent.
2534 mem_critical | **Required.** Specify the critical threshold as number interpreted as percent.
2536 #### <a id="plugin-contrib-command-running_kernel"></a> running_kernel
2538 Check command object for the `check_running_kernel` plugin
2539 provided by the `nagios-plugin-contrib` package on Debian.
2544 ---------------------------|-------------
2545 running\_kernel\_use\_sudo | Whether to run the plugin with `sudo`. Defaults to false except on Ubuntu where it defaults to true.
2547 #### <a id="plugin-contrib-command-iostats"></a> iostats
2549 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.
2551 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
2554 ---------------|-----------------------------------------------------------------------------------------------------------------------
2555 iostats\_disk | **Required.** The device to monitor without path. e.g. sda or vda. (default: sda)
2556 iostats\_warning\_tps | **Required.** Warning threshold for tps (default: 3000)
2557 iostats\_warning\_read | **Required.** Warning threshold for KB/s reads (default: 50000)
2558 iostats\_warning\_write | **Required.** Warning threshold for KB/s writes (default: 10000)
2559 iostats\_warning\_wait | **Required.** Warning threshold for % iowait (default: 50)
2560 iostats\_critical\_tps | **Required.** Critical threshold for tps (default: 5000)
2561 iostats\_critical\_read | **Required.** Critical threshold for KB/s reads (default: 80000)
2562 iostats\_critical\_write | **Required.** Critical threshold for KB/s writes (default: 25000)
2563 iostats\_critical\_wait | **Required.** Critical threshold for % iowait (default: 80)
2565 #### <a id="plugin-contrib-command-iostat"></a> iostat
2567 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.
2569 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
2572 ---------------|-----------------------------------------------------------------------------------------------------------------------
2573 iostat\_disk | **Required.** The device to monitor without path. e.g. sda or vda. (default: sda)
2574 iostat\_wtps | **Required.** Warning threshold for tps (default: 100)
2575 iostat\_wread | **Required.** Warning threshold for KB/s reads (default: 100)
2576 iostat\_wwrite | **Required.** Warning threshold for KB/s writes (default: 100)
2577 iostat\_ctps | **Required.** Critical threshold for tps (default: 200)
2578 iostat\_cread | **Required.** Critical threshold for KB/s reads (default: 200)
2579 iostat\_cwrite | **Required.** Critical threshold for KB/s writes (default: 200)
2581 #### <a id="plugin-contrib-command-yum"></a> yum
2583 The plugin [check_yum](https://github.com/calestyo/check_yum) is used to check the YUM package
2584 management system for package updates.
2585 The plugin requires the `yum-plugin-security` package to differentiate between security and normal updates.
2587 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
2590 ------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
2591 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.
2592 yum_warn_on_any_update | **Optional.** Set to true to warn if there are any (non-security) package updates available. Defaults to false.
2593 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.
2594 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.
2595 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.
2596 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.
2597 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.
2598 yum_installroot | **Optional.** Specifies another installation root directory (for example a chroot).
2599 yum_timeout | **Optional.** Set a timeout in seconds after which the plugin will exit (defaults to 55 seconds).
2601 ### <a id="plugins-contrib-storage"></a> Storage
2603 This category includes all plugins for various storage and object storage technologies.
2605 #### <a id="plugins-contrib-command-glusterfs"></a> glusterfs
2607 The plugin [glusterfs](https://www.unixadm.org/software/nagios-stuff/checks/check_glusterfs) is used to check the GlusterFS storage health on the server.
2608 The plugin requires `sudo` permissions.
2611 ---------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
2612 glusterfs_perfdata | **Optional.** Print perfdata of all or the specified volume.
2613 glusterfs_warnonfailedheal | **Optional.** Warn if the *heal-failed* log contains entries. The log can be cleared by restarting glusterd.
2614 glusterfs_volume | **Optional.** Only check the specified *VOLUME*. If --volume is not set, all volumes are checked.
2615 glusterfs_disk_warning | **Optional.** Warn if disk usage is above *DISKWARN*. Defaults to 90 (percent).
2616 glusterfs_disk_critical | **Optional.** Return a critical error if disk usage is above *DISKCRIT*. Defaults to 95 (percent).
2617 glusterfs_inode_warning | **Optional.** Warn if inode usage is above *DISKWARN*. Defaults to 90 (percent).
2618 glusterfs_inode_critical | **Optional.** Return a critical error if inode usage is above *DISKCRIT*. Defaults to 95 (percent).
2621 ### <a id="plugin-contrib-virtualization"></a> Virtualization
2623 This category includes all plugins for various virtualization technologies.
2625 #### <a id="plugin-contrib-command-esxi-hardware"></a> esxi_hardware
2627 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.
2629 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
2632 ------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
2633 esxi_hardware_host | **Required.** Specifies the host to monitor. Defaults to "$address$".
2634 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.
2635 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.
2636 esxi_hardware_port | **Optional.** Specifies the CIM port to connect to. Defaults to 5989.
2637 esxi_hardware_vendor | **Optional.** Defines the vendor of the server: "auto", "dell", "hp", "ibm", "intel", "unknown" (default).
2638 esxi_hardware_html | **Optional.** Add web-links to hardware manuals for Dell servers (use your country extension). Only useful with **esxi_hardware_vendor** = dell.
2639 esxi_hardware_ignore | **Optional.** Comma separated list of elements to ignore.
2640 esxi_hardware_perfdata | **Optional.** Add performcedata for graphers like PNP4Nagios to the output. Defaults to false.
2641 esxi_hardware_nopower | **Optional.** Do not collect power performance data, when **esxi_hardware_perfdata** is set to true. Defaults to false.
2642 esxi_hardware_novolts | **Optional.** Do not collect voltage performance data, when **esxi_hardware_perfdata** is set to true. Defaults to false.
2643 esxi_hardware_nocurrent | **Optional.** Do not collect current performance data, when **esxi_hardware_perfdata** is set to true. Defaults to false.
2644 esxi_hardware_notemp | **Optional.** Do not collect temperature performance data, when **esxi_hardware_perfdata** is set to true. Defaults to false.
2645 esxi_hardware_nofan | **Optional.** Do not collect fan performance data, when **esxi_hardware_perfdata** is set to true. Defaults to false.
2647 #### <a id="plugin-contrib-vmware"></a> VMware
2649 Check commands for the [check_vmware_esx](https://github.com/BaldMansMojo/check_vmware_esx) plugin.
2651 ##### <a id="plugin-contrib-vmware-esx-dc-volumes"></a> vmware-esx-dc-volumes
2653 Check command object for the `check_vmware_esx` plugin. Shows all datastore volumes info.
2655 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
2658 ------------------------|--------------
2659 vmware_datacenter | **Required.** Datacenter/vCenter hostname.
2660 vmware_cluster | **Optional.** ESX or ESXi clustername.
2661 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
2662 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
2663 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
2664 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
2665 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
2666 vmware_sessionfile | **Optional.** Session file name enhancement.
2667 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
2668 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
2669 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
2670 vmware_password | **Optional.** The username's password. No value defined as default.
2671 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
2672 vmware_subselect | **Optional.** Volume name to be checked the free space.
2673 vmware_gigabyte | **Optional.** Output in GB instead of MB.
2674 vmware_usedspace | **Optional.** Output used space instead of free. Defaults to "false".
2675 vmware_alertonly | **Optional.** List only alerting volumes. Defaults to "false".
2676 vmware_exclude | **Optional.** Blacklist volumes name. No value defined as default.
2677 vmware_include | **Optional.** Whitelist volumes name. No value defined as default.
2678 vmware_isregexp | **Optional.** Treat blacklist and whitelist expressions as regexp.
2679 vmware_dc_volume_used | **Optional.** Output used space instead of free. Defaults to "true".
2680 vmware_warn | **Optional.** The warning threshold for volumes. Defaults to "80%".
2681 vmware_crit | **Optional.** The critical threshold for volumes. Defaults to "90%".
2684 ##### <a id="plugin-contrib-vmware-esx-dc-runtime-info"></a> vmware-esx-dc-runtime-info
2686 Check command object for the `check_vmware_esx` plugin. Shows all runtime info for the datacenter/Vcenter.
2688 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
2691 ------------------------|--------------
2692 vmware_datacenter | **Required.** Datacenter/vCenter hostname.
2693 vmware_cluster | **Optional.** ESX or ESXi clustername.
2694 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
2695 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
2696 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
2697 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
2698 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
2699 vmware_sessionfile | **Optional.** Session file name enhancement.
2700 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
2701 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
2702 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
2703 vmware_password | **Optional.** The username's password. No value defined as default.
2704 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
2707 ##### <a id="plugin-contrib-vmware-esx-dc-runtime-listvms"></a> vmware-esx-dc-runtime-listvms
2709 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.
2711 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
2714 ------------------------|--------------
2715 vmware_datacenter | **Required.** Datacenter/vCenter hostname.
2716 vmware_cluster | **Optional.** ESX or ESXi clustername.
2717 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
2718 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
2719 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
2720 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
2721 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
2722 vmware_sessionfile | **Optional.** Session file name enhancement.
2723 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
2724 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
2725 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
2726 vmware_password | **Optional.** The username's password. No value defined as default.
2727 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
2728 vmware_alertonly | **Optional.** List only alerting VMs. Important here to avoid masses of data.
2729 vmware_exclude | **Optional.** Blacklist VMs name. No value defined as default.
2730 vmware_include | **Optional.** Whitelist VMs name. No value defined as default.
2731 vmware_isregexp | **Optional.** Treat blacklist and whitelist expressions as regexp.
2732 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.
2735 ##### <a id="plugin-contrib-vmware-esx-dc-runtime-listhost"></a> vmware-esx-dc-runtime-listhost
2737 Check command object for the `check_vmware_esx` plugin. List of VMware ESX hosts and their power state.
2739 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
2742 ------------------------|--------------
2743 vmware_datacenter | **Required.** Datacenter/vCenter hostname.
2744 vmware_cluster | **Optional.** ESX or ESXi clustername.
2745 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
2746 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
2747 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
2748 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
2749 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
2750 vmware_sessionfile | **Optional.** Session file name enhancement.
2751 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
2752 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
2753 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
2754 vmware_password | **Optional.** The username's password. No value defined as default.
2755 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
2756 vmware_alertonly | **Optional.** List only alerting hosts. Important here to avoid masses of data.
2757 vmware_exclude | **Optional.** Blacklist VMware ESX hosts. No value defined as default.
2758 vmware_include | **Optional.** Whitelist VMware ESX hosts. No value defined as default.
2759 vmware_isregexp | **Optional.** Treat blacklist and whitelist expressions as regexp.
2760 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.
2763 ##### <a id="plugin-contrib-vmware-esx-dc-runtime-listcluster"></a> vmware-esx-dc-runtime-listcluster
2765 Check command object for the `check_vmware_esx` plugin. List of VMware clusters and their states.
2767 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
2770 ------------------------|--------------
2771 vmware_datacenter | **Required.** Datacenter/vCenter hostname.
2772 vmware_cluster | **Optional.** ESX or ESXi clustername.
2773 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
2774 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
2775 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
2776 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
2777 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
2778 vmware_sessionfile | **Optional.** Session file name enhancement.
2779 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
2780 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
2781 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
2782 vmware_password | **Optional.** The username's password. No value defined as default.
2783 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
2784 vmware_alertonly | **Optional.** List only alerting hosts. Important here to avoid masses of data.
2785 vmware_exclude | **Optional.** Blacklist VMware cluster. No value defined as default.
2786 vmware_include | **Optional.** Whitelist VMware cluster. No value defined as default.
2787 vmware_isregexp | **Optional.** Treat blacklist and whitelist expressions as regexp.
2788 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.
2791 ##### <a id="plugin-contrib-vmware-esx-dc-runtime-issues"></a> vmware-esx-dc-runtime-issues
2793 Check command object for the `check_vmware_esx` plugin. All issues for the host.
2795 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
2798 ------------------------|--------------
2799 vmware_datacenter | **Required.** Datacenter/vCenter hostname.
2800 vmware_cluster | **Optional.** ESX or ESXi clustername.
2801 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
2802 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
2803 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
2804 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
2805 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
2806 vmware_sessionfile | **Optional.** Session file name enhancement.
2807 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
2808 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
2809 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
2810 vmware_password | **Optional.** The username's password. No value defined as default.
2811 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
2812 vmware_exclude | **Optional.** Blacklist issues. No value defined as default.
2813 vmware_include | **Optional.** Whitelist issues. No value defined as default.
2814 vmware_isregexp | **Optional.** Treat blacklist and whitelist expressions as regexp.
2815 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.
2818 ##### <a id="plugin-contrib-vmware-esx-dc-runtime-status"></a> vmware-esx-dc-runtime-status
2820 Check command object for the `check_vmware_esx` plugin. Overall object status (gray/green/red/yellow).
2822 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
2825 ------------------------|--------------
2826 vmware_datacenter | **Required.** Datacenter/vCenter hostname.
2827 vmware_cluster | **Optional.** ESX or ESXi clustername.
2828 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
2829 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
2830 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
2831 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
2832 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
2833 vmware_sessionfile | **Optional.** Session file name enhancement.
2834 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
2835 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
2836 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
2837 vmware_password | **Optional.** The username's password. No value defined as default.
2838 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
2841 ##### <a id="plugin-contrib-vmware-esx-dc-runtime-tools"></a> vmware-esx-dc-runtime-tools
2843 Check command object for the `check_vmware_esx` plugin. Vmware Tools status.
2845 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
2848 ------------------------|--------------
2849 vmware_datacenter | **Required.** Datacenter/vCenter hostname.
2850 vmware_cluster | **Optional.** ESX or ESXi clustername.
2851 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
2852 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
2853 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
2854 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
2855 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
2856 vmware_sessionfile | **Optional.** Session file name enhancement.
2857 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
2858 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
2859 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
2860 vmware_password | **Optional.** The username's password. No value defined as default.
2861 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
2862 vmware_poweredonly | **Optional.** List only VMs which are powered on. No value defined as default.
2863 vmware_alertonly | **Optional.** List only alerting VMs. Important here to avoid masses of data.
2864 vmware_exclude | **Optional.** Blacklist VMs. No value defined as default.
2865 vmware_include | **Optional.** Whitelist VMs. No value defined as default.
2866 vmware_isregexp | **Optional.** Treat blacklist and whitelist expressions as regexp.
2867 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.
2868 vmware_openvmtools | **Optional** Prevent CRITICAL state for installed and running Open VM Tools.
2871 ##### <a id="plugin-contrib-vmware-esx-soap-host-check"></a> vmware-esx-soap-host-check
2873 Check command object for the `check_vmware_esx` plugin. Simple check to verify a successfull connection to VMware SOAP API.
2875 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
2878 ------------------------|--------------
2879 vmware_host | **Required.** ESX or ESXi hostname.
2880 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. In case the check is done through a Datacenter/vCenter host.
2881 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
2882 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
2883 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
2884 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
2885 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
2886 vmware_sessionfile | **Optional.** Session file name enhancement.
2887 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
2888 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
2889 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
2890 vmware_password | **Optional.** The username's password. No value defined as default.
2891 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
2894 ##### <a id="plugin-contrib-vmware-esx-soap-host-uptime"></a> vmware-esx-soap-host-uptime
2896 Check command object for the `check_vmware_esx` plugin. Displays uptime of the VMware host.
2898 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
2901 ------------------------|--------------
2902 vmware_host | **Required.** ESX or ESXi hostname.
2903 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. In case the check is done through a Datacenter/vCenter host.
2904 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
2905 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
2906 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
2907 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
2908 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
2909 vmware_sessionfile | **Optional.** Session file name enhancement.
2910 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
2911 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
2912 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
2913 vmware_password | **Optional.** The username's password. No value defined as default.
2914 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
2917 ##### <a id="plugin-contrib-vmware-esx-soap-host-cpu"></a> vmware-esx-soap-host-cpu
2919 Check command object for the `check_vmware_esx` plugin. CPU usage in percentage.
2921 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
2924 ------------------------|--------------
2925 vmware_host | **Required.** ESX or ESXi hostname.
2926 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. In case the check is done through a Datacenter/vCenter host.
2927 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
2928 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
2929 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
2930 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
2931 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
2932 vmware_sessionfile | **Optional.** Session file name enhancement.
2933 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
2934 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
2935 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
2936 vmware_password | **Optional.** The username's password. No value defined as default.
2937 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
2938 vmware_warn | **Optional.** The warning threshold in percent. Defaults to "80%".
2939 vmware_crit | **Optional.** The critical threshold in percent. Defaults to "90%".
2942 ##### <a id="plugin-contrib-vmware-esx-soap-host-cpu-ready"></a> vmware-esx-soap-host-cpu-ready
2944 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.
2946 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
2949 ------------------------|--------------
2950 vmware_host | **Required.** ESX or ESXi hostname.
2951 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. In case the check is done through a Datacenter/vCenter host.
2952 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
2953 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
2954 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
2955 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
2956 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
2957 vmware_sessionfile | **Optional.** Session file name enhancement.
2958 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
2959 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
2960 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
2961 vmware_password | **Optional.** The username's password. No value defined as default.
2962 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
2965 ##### <a id="plugin-contrib-vmware-esx-soap-host-cpu-wait"></a> vmware-esx-soap-host-cpu-wait
2967 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.
2969 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
2972 ------------------------|--------------
2973 vmware_host | **Required.** ESX or ESXi hostname.
2974 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. In case the check is done through a Datacenter/vCenter host.
2975 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
2976 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
2977 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
2978 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
2979 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
2980 vmware_sessionfile | **Optional.** Session file name enhancement.
2981 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
2982 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
2983 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
2984 vmware_password | **Optional.** The username's password. No value defined as default.
2985 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
2988 ##### <a id="plugin-contrib-vmware-esx-soap-host-cpu-usage"></a> vmware-esx-soap-host-cpu-usage
2990 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.
2992 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
2995 ------------------------|--------------
2996 vmware_host | **Required.** ESX or ESXi hostname.
2997 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. In case the check is done through a Datacenter/vCenter host.
2998 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
2999 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
3000 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
3001 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
3002 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
3003 vmware_sessionfile | **Optional.** Session file name enhancement.
3004 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
3005 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
3006 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
3007 vmware_password | **Optional.** The username's password. No value defined as default.
3008 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
3009 vmware_warn | **Optional.** The warning threshold in percent. Defaults to "80%".
3010 vmware_crit | **Optional.** The critical threshold in percent. Defaults to "90%".
3013 ##### <a id="plugin-contrib-vmware-esx-soap-host-mem"></a> vmware-esx-soap-host-mem
3015 Check command object for the `check_vmware_esx` plugin. All mem info(except overall and no thresholds).
3017 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
3020 ------------------------|--------------
3021 vmware_host | **Required.** ESX or ESXi hostname.
3022 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. In case the check is done through a Datacenter/vCenter host.
3023 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
3024 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
3025 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
3026 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
3027 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
3028 vmware_sessionfile | **Optional.** Session file name enhancement.
3029 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
3030 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
3031 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
3032 vmware_password | **Optional.** The username's password. No value defined as default.
3033 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
3036 ##### <a id="plugin-contrib-vmware-esx-soap-host-mem-usage"></a> vmware-esx-soap-host-mem-usage
3038 Check command object for the `check_vmware_esx` plugin. Average mem usage in percentage.
3040 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
3043 ------------------------|--------------
3044 vmware_host | **Required.** ESX or ESXi hostname.
3045 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. In case the check is done through a Datacenter/vCenter host.
3046 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
3047 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
3048 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
3049 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
3050 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
3051 vmware_sessionfile | **Optional.** Session file name enhancement.
3052 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
3053 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
3054 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
3055 vmware_password | **Optional.** The username's password. No value defined as default.
3056 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
3057 vmware_warn | **Optional.** The warning threshold in percent. Defaults to "80%".
3058 vmware_crit | **Optional.** The critical threshold in percent. Defaults to "90%".
3061 ##### <a id="plugin-contrib-vmware-esx-soap-host-mem-consumed"></a> vmware-esx-soap-host-mem-consumed
3063 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.
3065 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
3068 ------------------------|--------------
3069 vmware_host | **Required.** ESX or ESXi hostname.
3070 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. In case the check is done through a Datacenter/vCenter host.
3071 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
3072 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
3073 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
3074 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
3075 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
3076 vmware_sessionfile | **Optional.** Session file name enhancement.
3077 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
3078 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
3079 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
3080 vmware_password | **Optional.** The username's password. No value defined as default.
3081 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
3082 vmware_warn | **Optional.** The warning threshold in percent. No value defined as default.
3083 vmware_crit | **Optional.** The critical threshold in percent. No value defined as default.
3086 ##### <a id="plugin-contrib-vmware-esx-soap-host-mem-swapused"></a> vmware-esx-soap-host-mem-swapused
3088 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.
3090 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
3093 ------------------------|--------------
3094 vmware_host | **Required.** ESX or ESXi hostname.
3095 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. In case the check is done through a Datacenter/vCenter host.
3096 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
3097 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
3098 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
3099 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
3100 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
3101 vmware_sessionfile | **Optional.** Session file name enhancement.
3102 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
3103 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
3104 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
3105 vmware_password | **Optional.** The username's password. No value defined as default.
3106 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
3107 vmware_warn | **Optional.** The warning threshold in percent. No value defined as default.
3108 vmware_crit | **Optional.** The critical threshold in percent. No value defined as default.
3109 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.
3112 ##### <a id="plugin-contrib-vmware-esx-soap-host-mem-overhead"></a> vmware-esx-soap-host-mem-overhead
3114 Check command object for the `check_vmware_esx` plugin. Additional mem used by VM Server in MB.
3116 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
3119 ------------------------|--------------
3120 vmware_host | **Required.** ESX or ESXi hostname.
3121 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. In case the check is done through a Datacenter/vCenter host.
3122 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
3123 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
3124 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
3125 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
3126 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
3127 vmware_sessionfile | **Optional.** Session file name enhancement.
3128 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
3129 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
3130 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
3131 vmware_password | **Optional.** The username's password. No value defined as default.
3132 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
3133 vmware_warn | **Optional.** The warning threshold in percent. No value defined as default.
3134 vmware_crit | **Optional.** The critical threshold in percent. No value defined as default.
3137 ##### <a id="plugin-contrib-vmware-esx-soap-host-mem-memctl"></a> vmware-esx-soap-host-mem-memctl
3139 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.
3141 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
3144 ------------------------|--------------
3145 vmware_host | **Required.** ESX or ESXi hostname.
3146 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. In case the check is done through a Datacenter/vCenter host.
3147 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
3148 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
3149 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
3150 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
3151 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
3152 vmware_sessionfile | **Optional.** Session file name enhancement.
3153 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
3154 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
3155 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
3156 vmware_password | **Optional.** The username's password. No value defined as default.
3157 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
3158 vmware_warn | **Optional.** The warning threshold in percent. No value defined as default.
3159 vmware_crit | **Optional.** The critical threshold in percent. No value defined as default.
3160 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.
3163 ##### <a id="plugin-contrib-vmware-esx-soap-host-net"></a> vmware-esx-soap-host-net
3165 Check command object for the `check_vmware_esx` plugin. Shows net info.
3167 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
3170 ------------------------|--------------
3171 vmware_host | **Required.** ESX or ESXi hostname.
3172 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. In case the check is done through a Datacenter/vCenter host.
3173 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
3174 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
3175 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
3176 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
3177 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
3178 vmware_sessionfile | **Optional.** Session file name enhancement.
3179 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
3180 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
3181 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
3182 vmware_password | **Optional.** The username's password. No value defined as default.
3183 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
3184 vmware_exclude | **Optional.** Blacklist NICs. No value defined as default.
3185 vmware_isregexp | **Optional.** Treat blacklist expression as regexp.
3188 ##### <a id="plugin-contrib-vmware-esx-soap-host-net-usage"></a> vmware-esx-soap-host-net-usage
3190 Check command object for the `check_vmware_esx` plugin. Overall network usage in KBps(Kilobytes per Second).
3192 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
3195 ------------------------|--------------
3196 vmware_host | **Required.** ESX or ESXi hostname.
3197 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. In case the check is done through a Datacenter/vCenter host.
3198 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
3199 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
3200 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
3201 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
3202 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
3203 vmware_sessionfile | **Optional.** Session file name enhancement.
3204 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
3205 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
3206 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
3207 vmware_password | **Optional.** The username's password. No value defined as default.
3208 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
3209 vmware_warn | **Optional.** The warning threshold in KBps(Kilobytes per Second). No value defined as default.
3210 vmware_crit | **Optional.** The critical threshold in KBps(Kilobytes per Second). No value defined as default.
3213 ##### <a id="plugin-contrib-vmware-esx-soap-host-net-receive"></a> vmware-esx-soap-host-net-receive
3215 Check command object for the `check_vmware_esx` plugin. Data receive in KBps(Kilobytes per Second).
3217 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
3220 ------------------------|--------------
3221 vmware_host | **Required.** ESX or ESXi hostname.
3222 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. In case the check is done through a Datacenter/vCenter host.
3223 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
3224 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
3225 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
3226 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
3227 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
3228 vmware_sessionfile | **Optional.** Session file name enhancement.
3229 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
3230 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
3231 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
3232 vmware_password | **Optional.** The username's password. No value defined as default.
3233 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
3234 vmware_warn | **Optional.** The warning threshold in KBps(Kilobytes per Second). No value defined as default.
3235 vmware_crit | **Optional.** The critical threshold in KBps(Kilobytes per Second). No value defined as default.
3238 ##### <a id="plugin-contrib-vmware-esx-soap-host-net-send"></a> vmware-esx-soap-host-net-send
3240 Check command object for the `check_vmware_esx` plugin. Data send in KBps(Kilobytes per Second).
3242 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
3245 ------------------------|--------------
3246 vmware_host | **Required.** ESX or ESXi hostname.
3247 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. In case the check is done through a Datacenter/vCenter host.
3248 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
3249 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
3250 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
3251 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
3252 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
3253 vmware_sessionfile | **Optional.** Session file name enhancement.
3254 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
3255 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
3256 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
3257 vmware_password | **Optional.** The username's password. No value defined as default.
3258 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
3259 vmware_warn | **Optional.** The warning threshold in KBps(Kilobytes per Second). No value defined as default.
3260 vmware_crit | **Optional.** The critical threshold in KBps(Kilobytes per Second). No value defined as default.
3263 ##### <a id="plugin-contrib-vmware-esx-soap-host-net-nic"></a> vmware-esx-soap-host-net-nic
3265 Check command object for the `check_vmware_esx` plugin. Check all active NICs.
3267 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
3270 ------------------------|--------------
3271 vmware_host | **Required.** ESX or ESXi hostname.
3272 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. In case the check is done through a Datacenter/vCenter host.
3273 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
3274 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
3275 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
3276 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
3277 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
3278 vmware_sessionfile | **Optional.** Session file name enhancement.
3279 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
3280 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
3281 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
3282 vmware_password | **Optional.** The username's password. No value defined as default.
3283 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
3284 vmware_exclude | **Optional.** Blacklist NICs. No value defined as default.
3285 vmware_isregexp | **Optional.** Treat blacklist expression as regexp.
3288 ##### <a id="plugin-contrib-vmware-esx-soap-host-volumes"></a> vmware-esx-soap-host-volumes
3290 Check command object for the `check_vmware_esx` plugin. Shows all datastore volumes info.
3292 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
3295 ------------------------|--------------
3296 vmware_host | **Required.** ESX or ESXi hostname.
3297 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. In case the check is done through a Datacenter/vCenter host.
3298 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
3299 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
3300 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
3301 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
3302 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
3303 vmware_sessionfile | **Optional.** Session file name enhancement.
3304 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
3305 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
3306 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
3307 vmware_password | **Optional.** The username's password. No value defined as default.
3308 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
3309 vmware_subselect | **Optional.** Volume name to be checked the free space.
3310 vmware_gigabyte | **Optional.** Output in GB instead of MB.
3311 vmware_usedspace | **Optional.** Output used space instead of free. Defaults to "false".
3312 vmware_alertonly | **Optional.** List only alerting volumes. Defaults to "false".
3313 vmware_exclude | **Optional.** Blacklist volumes name. No value defined as default.
3314 vmware_include | **Optional.** Whitelist volumes name. No value defined as default.
3315 vmware_isregexp | **Optional.** Treat blacklist and whitelist expressions as regexp.
3316 vmware_warn | **Optional.** The warning threshold for volumes. Defaults to "80%".
3317 vmware_crit | **Optional.** The critical threshold for volumes. Defaults to "90%".
3318 vmware_spaceleft | **Optional.** This has to be used in conjunction with thresholds as mentioned above.
3321 ##### <a id="plugin-contrib-vmware-esx-soap-host-io"></a> vmware-esx-soap-host-io
3323 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.
3325 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
3328 ------------------------|--------------
3329 vmware_host | **Required.** ESX or ESXi hostname.
3330 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. In case the check is done through a Datacenter/vCenter host.
3331 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
3332 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
3333 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
3334 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
3335 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
3336 vmware_sessionfile | **Optional.** Session file name enhancement.
3337 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
3338 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
3339 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
3340 vmware_password | **Optional.** The username's password. No value defined as default.
3341 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
3344 ##### <a id="plugin-contrib-vmware-esx-soap-host-io-aborted"></a> vmware-esx-soap-host-io-aborted
3346 Check command object for the `check_vmware_esx` plugin. Number of aborted SCSI commands.
3348 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
3351 ------------------------|--------------
3352 vmware_host | **Required.** ESX or ESXi hostname.
3353 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. In case the check is done through a Datacenter/vCenter host.
3354 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
3355 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
3356 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
3357 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
3358 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
3359 vmware_sessionfile | **Optional.** Session file name enhancement.
3360 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
3361 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
3362 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
3363 vmware_password | **Optional.** The username's password. No value defined as default.
3364 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
3365 vmware_warn | **Optional.** The warning threshold. No value defined as default.
3366 vmware_crit | **Optional.** The critical threshold. No value defined as default.
3369 ##### <a id="plugin-contrib-vmware-esx-soap-host-io-resets"></a> vmware-esx-soap-host-io-resets
3371 Check command object for the `check_vmware_esx` plugin. Number of SCSI bus resets.
3373 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
3376 ------------------------|--------------
3377 vmware_host | **Required.** ESX or ESXi hostname.
3378 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. In case the check is done through a Datacenter/vCenter host.
3379 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
3380 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
3381 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
3382 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
3383 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
3384 vmware_sessionfile | **Optional.** Session file name enhancement.
3385 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
3386 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
3387 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
3388 vmware_password | **Optional.** The username's password. No value defined as default.
3389 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
3390 vmware_warn | **Optional.** The warning threshold. No value defined as default.
3391 vmware_crit | **Optional.** The critical threshold. No value defined as default.
3394 ##### <a id="plugin-contrib-vmware-esx-soap-host-io-read"></a> vmware-esx-soap-host-io-read
3396 Check command object for the `check_vmware_esx` plugin. Average number of kilobytes read from the disk each second.
3398 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
3401 ------------------------|--------------
3402 vmware_host | **Required.** ESX or ESXi hostname.
3403 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. In case the check is done through a Datacenter/vCenter host.
3404 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
3405 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
3406 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
3407 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
3408 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
3409 vmware_sessionfile | **Optional.** Session file name enhancement.
3410 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
3411 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
3412 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
3413 vmware_password | **Optional.** The username's password. No value defined as default.
3414 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
3415 vmware_warn | **Optional.** The warning threshold. No value defined as default.
3416 vmware_crit | **Optional.** The critical threshold. No value defined as default.
3419 ##### <a id="plugin-contrib-vmware-esx-soap-host-io-read-latency"></a> vmware-esx-soap-host-io-read-latency
3421 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.
3423 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
3426 ------------------------|--------------
3427 vmware_host | **Required.** ESX or ESXi hostname.
3428 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. In case the check is done through a Datacenter/vCenter host.
3429 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
3430 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
3431 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
3432 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
3433 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
3434 vmware_sessionfile | **Optional.** Session file name enhancement.
3435 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
3436 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
3437 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
3438 vmware_password | **Optional.** The username's password. No value defined as default.
3439 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
3440 vmware_warn | **Optional.** The warning threshold. No value defined as default.
3441 vmware_crit | **Optional.** The critical threshold. No value defined as default.
3444 ##### <a id="plugin-contrib-vmware-esx-soap-host-io-write"></a> vmware-esx-soap-host-io-write
3446 Check command object for the `check_vmware_esx` plugin. Average number of kilobytes written to disk each second.
3448 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
3451 ------------------------|--------------
3452 vmware_host | **Required.** ESX or ESXi hostname.
3453 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. In case the check is done through a Datacenter/vCenter host.
3454 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
3455 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
3456 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
3457 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
3458 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
3459 vmware_sessionfile | **Optional.** Session file name enhancement.
3460 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
3461 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
3462 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
3463 vmware_password | **Optional.** The username's password. No value defined as default.
3464 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
3465 vmware_warn | **Optional.** The warning threshold. No value defined as default.
3466 vmware_crit | **Optional.** The critical threshold. No value defined as default.
3469 ##### <a id="plugin-contrib-vmware-esx-soap-host-io-write-latency"></a> vmware-esx-soap-host-io-write-latency
3471 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.
3473 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
3476 ------------------------|--------------
3477 vmware_host | **Required.** ESX or ESXi hostname.
3478 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. In case the check is done through a Datacenter/vCenter host.
3479 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
3480 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
3481 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
3482 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
3483 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
3484 vmware_sessionfile | **Optional.** Session file name enhancement.
3485 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
3486 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
3487 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
3488 vmware_password | **Optional.** The username's password. No value defined as default.
3489 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
3490 vmware_warn | **Optional.** The warning threshold. No value defined as default.
3491 vmware_crit | **Optional.** The critical threshold. No value defined as default.
3494 ##### <a id="plugin-contrib-vmware-esx-soap-host-io-usage"></a> vmware-esx-soap-host-io-usage
3496 Check command object for the `check_vmware_esx` plugin. Aggregated disk I/O rate. For hosts, this metric includes the rates for all virtual machines running on the host.
3498 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
3501 ------------------------|--------------
3502 vmware_host | **Required.** ESX or ESXi hostname.
3503 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. In case the check is done through a Datacenter/vCenter host.
3504 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
3505 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
3506 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
3507 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
3508 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
3509 vmware_sessionfile | **Optional.** Session file name enhancement.
3510 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
3511 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
3512 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
3513 vmware_password | **Optional.** The username's password. No value defined as default.
3514 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
3515 vmware_warn | **Optional.** The warning threshold. No value defined as default.
3516 vmware_crit | **Optional.** The critical threshold. No value defined as default.
3519 ##### <a id="plugin-contrib-vmware-esx-soap-host-io-kernel-latency"></a> vmware-esx-soap-host-io-kernel-latency
3521 Check command object for the `check_vmware_esx` plugin. Average amount of time (ms) spent by VMkernel processing each SCSI command.
3523 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
3526 ------------------------|--------------
3527 vmware_host | **Required.** ESX or ESXi hostname.
3528 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. In case the check is done through a Datacenter/vCenter host.
3529 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
3530 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
3531 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
3532 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
3533 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
3534 vmware_sessionfile | **Optional.** Session file name enhancement.
3535 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
3536 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
3537 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
3538 vmware_password | **Optional.** The username's password. No value defined as default.
3539 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
3540 vmware_warn | **Optional.** The warning threshold. No value defined as default.
3541 vmware_crit | **Optional.** The critical threshold. No value defined as default.
3544 ##### <a id="plugin-contrib-vmware-esx-soap-host-io-device-latency"></a> vmware-esx-soap-host-io-device-latency
3546 Check command object for the `check_vmware_esx` plugin. Average amount of time (ms) to complete a SCSI command from the physical device.
3548 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
3551 ------------------------|--------------
3552 vmware_host | **Required.** ESX or ESXi hostname.
3553 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. In case the check is done through a Datacenter/vCenter host.
3554 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
3555 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
3556 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
3557 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
3558 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
3559 vmware_sessionfile | **Optional.** Session file name enhancement.
3560 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
3561 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
3562 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
3563 vmware_password | **Optional.** The username's password. No value defined as default.
3564 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
3565 vmware_warn | **Optional.** The warning threshold. No value defined as default.
3566 vmware_crit | **Optional.** The critical threshold. No value defined as default.
3569 ##### <a id="plugin-contrib-vmware-esx-soap-host-io-queue-latency"></a> vmware-esx-soap-host-io-queue-latency
3571 Check command object for the `check_vmware_esx` plugin. Average amount of time (ms) spent in the VMkernel queue.
3573 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
3576 ------------------------|--------------
3577 vmware_host | **Required.** ESX or ESXi hostname.
3578 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. In case the check is done through a Datacenter/vCenter host.
3579 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
3580 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
3581 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
3582 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
3583 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
3584 vmware_sessionfile | **Optional.** Session file name enhancement.
3585 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
3586 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
3587 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
3588 vmware_password | **Optional.** The username's password. No value defined as default.
3589 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
3590 vmware_warn | **Optional.** The warning threshold. No value defined as default.
3591 vmware_crit | **Optional.** The critical threshold. No value defined as default.
3594 ##### <a id="plugin-contrib-vmware-esx-soap-host-io-total-latency"></a> vmware-esx-soap-host-io-total-latency
3596 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.
3598 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
3601 ------------------------|--------------
3602 vmware_host | **Required.** ESX or ESXi hostname.
3603 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. In case the check is done through a Datacenter/vCenter host.
3604 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
3605 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
3606 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
3607 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
3608 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
3609 vmware_sessionfile | **Optional.** Session file name enhancement.
3610 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
3611 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
3612 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
3613 vmware_password | **Optional.** The username's password. No value defined as default.
3614 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
3615 vmware_warn | **Optional.** The warning threshold. No value defined as default.
3616 vmware_crit | **Optional.** The critical threshold. No value defined as default.
3619 ##### <a id="plugin-contrib-vmware-esx-soap-host-media"></a> vmware-esx-soap-host-media
3621 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.
3623 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
3626 ------------------------|--------------
3627 vmware_host | **Required.** ESX or ESXi hostname.
3628 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. In case the check is done through a Datacenter/vCenter host.
3629 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
3630 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
3631 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
3632 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
3633 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
3634 vmware_sessionfile | **Optional.** Session file name enhancement.
3635 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
3636 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
3637 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
3638 vmware_password | **Optional.** The username's password. No value defined as default.
3639 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
3640 vmware_exclude | **Optional.** Blacklist VMs name. No value defined as default.
3641 vmware_include | **Optional.** Whitelist VMs name. No value defined as default.
3642 vmware_isregexp | **Optional.** Treat blacklist and whitelist expressions as regexp.
3643 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.
3646 ##### <a id="plugin-contrib-vmware-esx-soap-host-service"></a> vmware-esx-soap-host-service
3648 Check command object for the `check_vmware_esx` plugin. Shows host service info.
3650 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
3653 ------------------------|--------------
3654 vmware_host | **Required.** ESX or ESXi hostname.
3655 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. In case the check is done through a Datacenter/vCenter host.
3656 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
3657 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
3658 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
3659 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
3660 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
3661 vmware_sessionfile | **Optional.** Session file name enhancement.
3662 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
3663 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
3664 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
3665 vmware_password | **Optional.** The username's password. No value defined as default.
3666 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
3667 vmware_exclude | **Optional.** Blacklist services name. No value defined as default.
3668 vmware_include | **Optional.** Whitelist services name. No value defined as default.
3669 vmware_isregexp | **Optional.** Treat blacklist and whitelist expressions as regexp.
3670 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.
3673 ##### <a id="plugin-contrib-vmware-esx-soap-host-runtime"></a> vmware-esx-soap-host-runtime
3675 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.
3677 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
3680 ------------------------|--------------
3681 vmware_host | **Required.** ESX or ESXi hostname.
3682 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. In case the check is done through a Datacenter/vCenter host.
3683 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
3684 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
3685 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
3686 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
3687 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
3688 vmware_sessionfile | **Optional.** Session file name enhancement.
3689 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
3690 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
3691 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
3692 vmware_password | **Optional.** The username's password. No value defined as default.
3693 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
3696 ##### <a id="plugin-contrib-vmware-esx-soap-host-runtime-con"></a> vmware-esx-soap-host-runtime-con
3698 Check command object for the `check_vmware_esx` plugin. Shows connection state.
3700 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
3703 ------------------------|--------------
3704 vmware_host | **Required.** ESX or ESXi hostname.
3705 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. In case the check is done through a Datacenter/vCenter host.
3706 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
3707 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
3708 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
3709 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
3710 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
3711 vmware_sessionfile | **Optional.** Session file name enhancement.
3712 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
3713 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
3714 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
3715 vmware_password | **Optional.** The username's password. No value defined as default.
3716 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
3719 ##### <a id="plugin-contrib-vmware-esx-soap-host-runtime-listvms"></a> vmware-esx-soap-host-runtime-listvms
3721 Check command object for the `check_vmware_esx` plugin. List of VMware machines and their status.
3723 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
3726 ------------------------|--------------
3727 vmware_host | **Required.** ESX or ESXi hostname.
3728 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. In case the check is done through a Datacenter/vCenter host.
3729 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
3730 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
3731 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
3732 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
3733 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
3734 vmware_sessionfile | **Optional.** Session file name enhancement.
3735 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
3736 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
3737 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
3738 vmware_password | **Optional.** The username's password. No value defined as default.
3739 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
3740 vmware_exclude | **Optional.** Blacklist VMs name. No value defined as default.
3741 vmware_include | **Optional.** Whitelist VMs name. No value defined as default.
3742 vmware_isregexp | **Optional.** Treat blacklist and whitelist expressions as regexp.
3743 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.
3746 ##### <a id="plugin-contrib-vmware-esx-soap-host-runtime-status"></a> vmware-esx-soap-host-runtime-status
3748 Check command object for the `check_vmware_esx` plugin. Overall object status (gray/green/red/yellow).
3750 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
3753 ------------------------|--------------
3754 vmware_host | **Required.** ESX or ESXi hostname.
3755 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. In case the check is done through a Datacenter/vCenter host.
3756 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
3757 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
3758 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
3759 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
3760 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
3761 vmware_sessionfile | **Optional.** Session file name enhancement.
3762 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
3763 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
3764 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
3765 vmware_password | **Optional.** The username's password. No value defined as default.
3766 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
3769 ##### <a id="plugin-contrib-vmware-esx-soap-host-runtime-health"></a> vmware-esx-soap-host-runtime-health
3771 Check command object for the `check_vmware_esx` plugin. Checks cpu/storage/memory/sensor status.
3773 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
3776 ------------------------|--------------
3777 vmware_host | **Required.** ESX or ESXi hostname.
3778 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. In case the check is done through a Datacenter/vCenter host.
3779 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
3780 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
3781 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
3782 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
3783 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
3784 vmware_sessionfile | **Optional.** Session file name enhancement.
3785 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
3786 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
3787 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
3788 vmware_password | **Optional.** The username's password. No value defined as default.
3789 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
3790 vmware_exclude | **Optional.** Blacklist status name. No value defined as default.
3791 vmware_include | **Optional.** Whitelist status name. No value defined as default.
3792 vmware_isregexp | **Optional.** Treat blacklist and whitelist expressions as regexp.
3795 ##### <a id="plugin-contrib-vmware-esx-soap-host-runtime-health-listsensors"></a> vmware-esx-soap-host-runtime-health-listsensors
3797 Check command object for the `check_vmware_esx` plugin. List all available sensors(use for listing purpose only).
3799 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
3802 ------------------------|--------------
3803 vmware_host | **Required.** ESX or ESXi hostname.
3804 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. In case the check is done through a Datacenter/vCenter host.
3805 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
3806 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
3807 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
3808 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
3809 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
3810 vmware_sessionfile | **Optional.** Session file name enhancement.
3811 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
3812 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
3813 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
3814 vmware_password | **Optional.** The username's password. No value defined as default.
3815 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
3816 vmware_exclude | **Optional.** Blacklist status name. No value defined as default.
3817 vmware_include | **Optional.** Whitelist status name. No value defined as default.
3818 vmware_isregexp | **Optional.** Treat blacklist and whitelist expressions as regexp.
3821 ##### <a id="plugin-contrib-vmware-esx-soap-host-runtime-health-nostoragestatus"></a> vmware-esx-soap-host-runtime-health-nostoragestatus
3823 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**.
3825 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
3828 ------------------------|--------------
3829 vmware_host | **Required.** ESX or ESXi hostname.
3830 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. In case the check is done through a Datacenter/vCenter host.
3831 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
3832 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
3833 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
3834 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
3835 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
3836 vmware_sessionfile | **Optional.** Session file name enhancement.
3837 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
3838 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
3839 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
3840 vmware_password | **Optional.** The username's password. No value defined as default.
3841 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
3842 vmware_exclude | **Optional.** Blacklist status name. No value defined as default.
3843 vmware_include | **Optional.** Whitelist status name. No value defined as default.
3844 vmware_isregexp | **Optional.** Treat blacklist and whitelist expressions as regexp.
3847 ##### <a id="plugin-contrib-vmware-esx-soap-host-runtime-storagehealth"></a> vmware-esx-soap-host-runtime-storagehealth
3849 Check command object for the `check_vmware_esx` plugin. Local storage status check.
3851 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
3854 ------------------------|--------------
3855 vmware_host | **Required.** ESX or ESXi hostname.
3856 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. In case the check is done through a Datacenter/vCenter host.
3857 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
3858 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
3859 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
3860 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
3861 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
3862 vmware_sessionfile | **Optional.** Session file name enhancement.
3863 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
3864 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
3865 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
3866 vmware_password | **Optional.** The username's password. No value defined as default.
3867 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
3868 vmware_exclude | **Optional.** Blacklist storage name. No value defined as default.
3869 vmware_include | **Optional.** Whitelist storage name. No value defined as default.
3870 vmware_isregexp | **Optional.** Treat blacklist and whitelist expressions as regexp.
3871 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.
3874 ##### <a id="plugin-contrib-vmware-esx-soap-host-runtime-temp"></a> vmware-esx-soap-host-runtime-temp
3876 Check command object for the `check_vmware_esx` plugin. Lists all temperature sensors.
3878 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
3881 ------------------------|--------------
3882 vmware_host | **Required.** ESX or ESXi hostname.
3883 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. In case the check is done through a Datacenter/vCenter host.
3884 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
3885 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
3886 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
3887 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
3888 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
3889 vmware_sessionfile | **Optional.** Session file name enhancement.
3890 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
3891 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
3892 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
3893 vmware_password | **Optional.** The username's password. No value defined as default.
3894 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
3895 vmware_exclude | **Optional.** Blacklist sensor name. No value defined as default.
3896 vmware_include | **Optional.** Whitelist sensor name. No value defined as default.
3897 vmware_isregexp | **Optional.** Treat blacklist and whitelist expressions as regexp.
3898 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.
3901 ##### <a id="plugin-contrib-vmware-esx-soap-host-runtime-issues"></a> vmware-esx-soap-host-runtime-issues
3903 Check command object for the `check_vmware_esx` plugin. Lists all configuration issues for the host.
3905 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
3908 ------------------------|--------------
3909 vmware_host | **Required.** ESX or ESXi hostname.
3910 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. In case the check is done through a Datacenter/vCenter host.
3911 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
3912 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
3913 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
3914 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
3915 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
3916 vmware_sessionfile | **Optional.** Session file name enhancement.
3917 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
3918 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
3919 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
3920 vmware_password | **Optional.** The username's password. No value defined as default.
3921 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
3922 vmware_exclude | **Optional.** Blacklist configuration issues. No value defined as default.
3923 vmware_include | **Optional.** Whitelist configuration issues. No value defined as default.
3924 vmware_isregexp | **Optional.** Treat blacklist and whitelist expressions as regexp.
3925 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.
3928 ##### <a id="plugin-contrib-vmware-esx-soap-host-storage"></a> vmware-esx-soap-host-storage
3930 Check command object for the `check_vmware_esx` plugin. Shows Host storage info.
3932 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
3935 ------------------------|--------------
3936 vmware_host | **Required.** ESX or ESXi hostname.
3937 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. In case the check is done through a Datacenter/vCenter host.
3938 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
3939 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
3940 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
3941 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
3942 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
3943 vmware_sessionfile | **Optional.** Session file name enhancement.
3944 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
3945 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
3946 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
3947 vmware_password | **Optional.** The username's password. No value defined as default.
3948 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
3949 vmware_exclude | **Optional.** Blacklist adapters, luns and paths. No value defined as default.
3950 vmware_include | **Optional.** Whitelist adapters, luns and paths. No value defined as default.
3951 vmware_isregexp | **Optional.** Treat blacklist and whitelist expressions as regexp.
3954 ##### <a id="plugin-contrib-vmware-esx-soap-host-storage-adapter"></a> vmware-esx-soap-host-storage-adapter
3956 Check command object for the `check_vmware_esx` plugin. List host bus adapters.
3958 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
3961 ------------------------|--------------
3962 vmware_host | **Required.** ESX or ESXi hostname.
3963 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. In case the check is done through a Datacenter/vCenter host.
3964 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
3965 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
3966 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
3967 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
3968 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
3969 vmware_sessionfile | **Optional.** Session file name enhancement.
3970 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
3971 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
3972 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
3973 vmware_password | **Optional.** The username's password. No value defined as default.
3974 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
3975 vmware_exclude | **Optional.** Blacklist adapters. No value defined as default.
3976 vmware_include | **Optional.** Whitelist adapters. No value defined as default.
3977 vmware_isregexp | **Optional.** Treat blacklist and whitelist expressions as regexp.
3978 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.
3981 ##### <a id="plugin-contrib-vmware-esx-soap-host-storage-lun"></a> vmware-esx-soap-host-storage-lun
3983 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.
3985 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
3988 ------------------------|--------------
3989 vmware_host | **Required.** ESX or ESXi hostname.
3990 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. In case the check is done through a Datacenter/vCenter host.
3991 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
3992 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
3993 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
3994 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
3995 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
3996 vmware_sessionfile | **Optional.** Session file name enhancement.
3997 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
3998 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
3999 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
4000 vmware_password | **Optional.** The username's password. No value defined as default.
4001 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
4002 vmware_exclude | **Optional.** Blacklist luns. No value defined as default.
4003 vmware_include | **Optional.** Whitelist luns. No value defined as default.
4004 vmware_isregexp | **Optional.** Treat blacklist and whitelist expressions as regexp.
4005 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.
4008 ##### <a id="plugin-contrib-vmware-esx-soap-host-storage-path"></a> vmware-esx-soap-host-storage-path
4010 Check command object for the `check_vmware_esx` plugin. List multipaths and the associated paths.
4012 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
4015 ------------------------|--------------
4016 vmware_host | **Required.** ESX or ESXi hostname.
4017 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. In case the check is done through a Datacenter/vCenter host.
4018 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
4019 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
4020 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
4021 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
4022 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
4023 vmware_sessionfile | **Optional.** Session file name enhancement.
4024 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
4025 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
4026 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
4027 vmware_password | **Optional.** The username's password. No value defined as default.
4028 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
4029 vmware_alertonly | **Optional.** List only alerting units. Important here to avoid masses of data. Defaults to "false".
4030 vmware_exclude | **Optional.** Blacklist paths. No value defined as default.
4031 vmware_include | **Optional.** Whitelist paths. No value defined as default.
4032 vmware_isregexp | **Optional.** Treat blacklist and whitelist expressions as regexp.
4033 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.
4036 ##### <a id="plugin-contrib-vmware-esx-soap-vm-cpu"></a> vmware-esx-soap-vm-cpu
4038 Check command object for the `check_vmware_esx` plugin. Shows all CPU usage info.
4040 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
4043 ------------------------|--------------
4044 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. Conflicts with **vmware_host**.
4045 vmware_host | **Optional.** ESX or ESXi hostname. Conflicts with **vmware_datacenter**.
4046 vmware_vmname | **Required.** Virtual machine name.
4047 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
4048 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
4049 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
4050 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
4051 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
4052 vmware_sessionfile | **Optional.** Session file name enhancement.
4053 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
4054 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
4055 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
4056 vmware_password | **Optional.** The username's password. No value defined as default.
4057 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
4061 ##### <a id="plugin-contrib-vmware-esx-soap-vm-cpu-ready"></a> vmware-esx-soap-vm-cpu-ready
4063 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.
4065 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
4068 ------------------------|--------------
4069 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. Conflicts with **vmware_host**.
4070 vmware_host | **Optional.** ESX or ESXi hostname. Conflicts with **vmware_datacenter**.
4071 vmware_vmname | **Required.** Virtual machine name.
4072 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
4073 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
4074 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
4075 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
4076 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
4077 vmware_sessionfile | **Optional.** Session file name enhancement.
4078 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
4079 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
4080 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
4081 vmware_password | **Optional.** The username's password. No value defined as default.
4082 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
4083 vmware_warn | **Optional.** The warning threshold. No value defined as default.
4084 vmware_crit | **Optional.** The critical threshold. No value defined as default.
4087 ##### <a id="plugin-contrib-vmware-esx-soap-vm-cpu-wait"></a> vmware-esx-soap-vm-cpu-wait
4089 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.
4091 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
4094 ------------------------|--------------
4095 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. Conflicts with **vmware_host**.
4096 vmware_host | **Optional.** ESX or ESXi hostname. Conflicts with **vmware_datacenter**.
4097 vmware_vmname | **Required.** Virtual machine name.
4098 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
4099 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
4100 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
4101 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
4102 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
4103 vmware_sessionfile | **Optional.** Session file name enhancement.
4104 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
4105 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
4106 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
4107 vmware_password | **Optional.** The username's password. No value defined as default.
4108 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
4109 vmware_warn | **Optional.** The warning threshold. No value defined as default.
4110 vmware_crit | **Optional.** The critical threshold. No value defined as default.
4113 ##### <a id="plugin-contrib-vmware-esx-soap-vm-cpu-usage"></a> vmware-esx-soap-vm-cpu-usage
4115 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.
4117 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
4120 ------------------------|--------------
4121 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. Conflicts with **vmware_host**.
4122 vmware_host | **Optional.** ESX or ESXi hostname. Conflicts with **vmware_datacenter**.
4123 vmware_vmname | **Required.** Virtual machine name.
4124 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
4125 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
4126 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
4127 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
4128 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
4129 vmware_sessionfile | **Optional.** Session file name enhancement.
4130 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
4131 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
4132 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
4133 vmware_password | **Optional.** The username's password. No value defined as default.
4134 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
4135 vmware_warn | **Optional.** Warning threshold in percent. Defaults to "80%".
4136 vmware_crit | **Optional.** Critical threshold in percent. Defaults to "90%".
4139 ##### <a id="plugin-contrib-vmware-esx-soap-vm-mem"></a> vmware-esx-soap-vm-mem
4141 Check command object for the `check_vmware_esx` plugin. Shows all memory info, except overall.
4143 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
4146 ------------------------|--------------
4147 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. Conflicts with **vmware_host**.
4148 vmware_host | **Optional.** ESX or ESXi hostname. Conflicts with **vmware_datacenter**.
4149 vmware_vmname | **Required.** Virtual machine name.
4150 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
4151 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
4152 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
4153 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
4154 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
4155 vmware_sessionfile | **Optional.** Session file name enhancement.
4156 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
4157 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
4158 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
4159 vmware_password | **Optional.** The username's password. No value defined as default.
4160 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
4163 ##### <a id="plugin-contrib-vmware-esx-soap-vm-mem-usage"></a> vmware-esx-soap-vm-mem-usage
4165 Check command object for the `check_vmware_esx` plugin. Average mem usage in percentage of configured virtual machine "physical" memory.
4167 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
4170 ------------------------|--------------
4171 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. Conflicts with **vmware_host**.
4172 vmware_host | **Optional.** ESX or ESXi hostname. Conflicts with **vmware_datacenter**.
4173 vmware_vmname | **Required.** Virtual machine name.
4174 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
4175 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
4176 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
4177 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
4178 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
4179 vmware_sessionfile | **Optional.** Session file name enhancement.
4180 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
4181 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
4182 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
4183 vmware_password | **Optional.** The username's password. No value defined as default.
4184 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
4185 vmware_warn | **Optional.** Warning threshold in percent. Defaults to "80%".
4186 vmware_crit | **Optional.** Critical threshold in percent. Defaults to "90%".
4189 ##### <a id="plugin-contrib-vmware-esx-soap-vm-mem-consumed"></a> vmware-esx-soap-vm-mem-consumed
4191 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>
4192 **vm consumed memory = memory granted -- memory saved**
4194 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
4197 ------------------------|--------------
4198 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. Conflicts with **vmware_host**.
4199 vmware_host | **Optional.** ESX or ESXi hostname. Conflicts with **vmware_datacenter**.
4200 vmware_vmname | **Required.** Virtual machine name.
4201 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
4202 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
4203 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
4204 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
4205 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
4206 vmware_sessionfile | **Optional.** Session file name enhancement.
4207 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
4208 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
4209 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
4210 vmware_password | **Optional.** The username's password. No value defined as default.
4211 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
4212 vmware_warn | **Optional.** The warning threshold. No value defined as default.
4213 vmware_crit | **Optional.** The critical threshold. No value defined as default.
4216 ##### <a id="plugin-contrib-vmware-esx-soap-vm-mem-memctl"></a> vmware-esx-soap-vm-mem-memctl
4218 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.
4220 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
4223 ------------------------|--------------
4224 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. Conflicts with **vmware_host**.
4225 vmware_host | **Optional.** ESX or ESXi hostname. Conflicts with **vmware_datacenter**.
4226 vmware_vmname | **Required.** Virtual machine name.
4227 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
4228 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
4229 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
4230 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
4231 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
4232 vmware_sessionfile | **Optional.** Session file name enhancement.
4233 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
4234 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
4235 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
4236 vmware_password | **Optional.** The username's password. No value defined as default.
4237 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
4238 vmware_warn | **Optional.** The warning threshold. No value defined as default.
4239 vmware_crit | **Optional.** The critical threshold. No value defined as default.
4243 ##### <a id="plugin-contrib-vmware-esx-soap-vm-net"></a> vmware-esx-soap-vm-net
4245 Check command object for the `check_vmware_esx` plugin. Shows net info.
4247 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
4250 ------------------------|--------------
4251 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. Conflicts with **vmware_host**.
4252 vmware_host | **Optional.** ESX or ESXi hostname. Conflicts with **vmware_datacenter**.
4253 vmware_vmname | **Required.** Virtual machine name.
4254 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
4255 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
4256 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
4257 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
4258 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
4259 vmware_sessionfile | **Optional.** Session file name enhancement.
4260 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
4261 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
4262 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
4263 vmware_password | **Optional.** The username's password. No value defined as default.
4264 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
4267 ##### <a id="plugin-contrib-vmware-esx-soap-vm-net-usage"></a> vmware-esx-soap-vm-net-usage
4269 Check command object for the `check_vmware_esx` plugin. Overall network usage in KBps(Kilobytes per Second).
4271 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
4274 ------------------------|--------------
4275 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. Conflicts with **vmware_host**.
4276 vmware_host | **Optional.** ESX or ESXi hostname. Conflicts with **vmware_datacenter**.
4277 vmware_vmname | **Required.** Virtual machine name.
4278 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
4279 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
4280 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
4281 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
4282 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
4283 vmware_sessionfile | **Optional.** Session file name enhancement.
4284 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
4285 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
4286 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
4287 vmware_password | **Optional.** The username's password. No value defined as default.
4288 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
4289 vmware_warn | **Optional.** The warning threshold. No value defined as default.
4290 vmware_crit | **Optional.** The critical threshold. No value defined as default.
4293 ##### <a id="plugin-contrib-vmware-esx-soap-vm-net-receive"></a> vmware-esx-soap-vm-net-receive
4295 Check command object for the `check_vmware_esx` plugin. Receive in KBps(Kilobytes per Second).
4297 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
4300 ------------------------|--------------
4301 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. Conflicts with **vmware_host**.
4302 vmware_host | **Optional.** ESX or ESXi hostname. Conflicts with **vmware_datacenter**.
4303 vmware_vmname | **Required.** Virtual machine name.
4304 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
4305 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
4306 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
4307 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
4308 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
4309 vmware_sessionfile | **Optional.** Session file name enhancement.
4310 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
4311 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
4312 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
4313 vmware_password | **Optional.** The username's password. No value defined as default.
4314 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
4315 vmware_warn | **Optional.** The warning threshold. No value defined as default.
4316 vmware_crit | **Optional.** The critical threshold. No value defined as default.
4319 ##### <a id="plugin-contrib-vmware-esx-soap-vm-net-send"></a> vmware-esx-soap-vm-net-send
4321 Check command object for the `check_vmware_esx` plugin. Send in KBps(Kilobytes per Second).
4323 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
4326 ------------------------|--------------
4327 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. Conflicts with **vmware_host**.
4328 vmware_host | **Optional.** ESX or ESXi hostname. Conflicts with **vmware_datacenter**.
4329 vmware_vmname | **Required.** Virtual machine name.
4330 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
4331 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
4332 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
4333 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
4334 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
4335 vmware_sessionfile | **Optional.** Session file name enhancement.
4336 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
4337 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
4338 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
4339 vmware_password | **Optional.** The username's password. No value defined as default.
4340 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
4341 vmware_warn | **Optional.** The warning threshold. No value defined as default.
4342 vmware_crit | **Optional.** The critical threshold. No value defined as default.
4345 ##### <a id="plugin-contrib-vmware-esx-soap-vm-io"></a> vmware-esx-soap-vm-io
4347 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.
4349 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
4352 ------------------------|--------------
4353 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. Conflicts with **vmware_host**.
4354 vmware_host | **Optional.** ESX or ESXi hostname. Conflicts with **vmware_datacenter**.
4355 vmware_vmname | **Required.** Virtual machine name.
4356 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
4357 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
4358 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
4359 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
4360 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
4361 vmware_sessionfile | **Optional.** Session file name enhancement.
4362 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
4363 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
4364 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
4365 vmware_password | **Optional.** The username's password. No value defined as default.
4366 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
4369 ##### <a id="plugin-contrib-vmware-esx-soap-vm-io-read"></a> vmware-esx-soap-vm-io-read
4371 Check command object for the `check_vmware_esx` plugin. Average number of kilobytes read from the disk each second.
4373 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
4376 ------------------------|--------------
4377 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. Conflicts with **vmware_host**.
4378 vmware_host | **Optional.** ESX or ESXi hostname. Conflicts with **vmware_datacenter**.
4379 vmware_vmname | **Required.** Virtual machine name.
4380 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
4381 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
4382 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
4383 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
4384 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
4385 vmware_sessionfile | **Optional.** Session file name enhancement.
4386 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
4387 vmware_nosession | **Optional.** No auth session - IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
4388 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
4389 vmware_password | **Optional.** The username's password. No value defined as default.
4390 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
4391 vmware_warn | **Optional.** The warning threshold. No value defined as default.
4392 vmware_crit | **Optional.** The critical threshold. No value defined as default.
4395 ##### <a id="plugin-contrib-vmware-esx-soap-vm-io-write"></a> vmware-esx-soap-vm-io-write
4397 Check command object for the `check_vmware_esx` plugin. Average number of kilobytes written to disk each second.
4399 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
4402 ------------------------|--------------
4403 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. Conflicts with **vmware_host**.
4404 vmware_host | **Optional.** ESX or ESXi hostname. Conflicts with **vmware_datacenter**.
4405 vmware_vmname | **Required.** Virtual machine name.
4406 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
4407 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
4408 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
4409 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
4410 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
4411 vmware_sessionfile | **Optional.** Session file name enhancement.
4412 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
4413 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
4414 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
4415 vmware_password | **Optional.** The username's password. No value defined as default.
4416 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
4417 vmware_warn | **Optional.** The warning threshold. No value defined as default.
4418 vmware_crit | **Optional.** The critical threshold. No value defined as default.
4421 ##### <a id="plugin-contrib-vmware-esx-soap-vm-io-usage"></a> vmware-esx-soap-vm-io-usage
4423 Check command object for the `check_vmware_esx` plugin. Aggregated disk I/O rate.
4425 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
4428 ------------------------|--------------
4429 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. Conflicts with **vmware_host**.
4430 vmware_host | **Optional.** ESX or ESXi hostname. Conflicts with **vmware_datacenter**.
4431 vmware_vmname | **Required.** Virtual machine name.
4432 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
4433 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
4434 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
4435 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
4436 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
4437 vmware_sessionfile | **Optional.** Session file name enhancement.
4438 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
4439 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
4440 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
4441 vmware_password | **Optional.** The username's password. No value defined as default.
4442 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
4443 vmware_warn | **Optional.** The warning threshold. No value defined as default.
4444 vmware_crit | **Optional.** The critical threshold. No value defined as default.
4447 ##### <a id="plugin-contrib-vmware-esx-soap-vm-runtime"></a> vmware-esx-soap-vm-runtime
4449 Check command object for the `check_vmware_esx` plugin. Shows virtual machine runtime info.
4451 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
4454 ------------------------|--------------
4455 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. Conflicts with **vmware_host**.
4456 vmware_host | **Optional.** ESX or ESXi hostname. Conflicts with **vmware_datacenter**.
4457 vmware_vmname | **Required.** Virtual machine name.
4458 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
4459 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
4460 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
4461 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
4462 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
4463 vmware_sessionfile | **Optional.** Session file name enhancement.
4464 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
4465 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
4466 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
4467 vmware_password | **Optional.** The username's password. No value defined as default.
4468 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
4471 ##### <a id="plugin-contrib-vmware-esx-soap-vm-runtime-con"></a> vmware-esx-soap-vm-runtime-con
4473 Check command object for the `check_vmware_esx` plugin. Shows the connection state.
4475 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
4478 ------------------------|--------------
4479 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. Conflicts with **vmware_host**.
4480 vmware_host | **Optional.** ESX or ESXi hostname. Conflicts with **vmware_datacenter**.
4481 vmware_vmname | **Required.** Virtual machine name.
4482 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
4483 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
4484 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
4485 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
4486 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
4487 vmware_sessionfile | **Optional.** Session file name enhancement.
4488 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
4489 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
4490 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
4491 vmware_password | **Optional.** The username's password. No value defined as default.
4492 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
4495 ##### <a id="plugin-contrib-vmware-esx-soap-vm-runtime-powerstate"></a> vmware-esx-soap-vm-runtime-powerstate
4497 Check command object for the `check_vmware_esx` plugin. Shows virtual machine power state: poweredOn, poweredOff or suspended.
4499 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
4502 ------------------------|--------------
4503 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. Conflicts with **vmware_host**.
4504 vmware_host | **Optional.** ESX or ESXi hostname. Conflicts with **vmware_datacenter**.
4505 vmware_vmname | **Required.** Virtual machine name.
4506 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
4507 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
4508 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
4509 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
4510 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
4511 vmware_sessionfile | **Optional.** Session file name enhancement.
4512 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
4513 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
4514 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
4515 vmware_password | **Optional.** The username's password. No value defined as default.
4516 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
4519 ##### <a id="plugin-contrib-vmware-esx-soap-vm-runtime-status"></a> vmware-esx-soap-vm-runtime-status
4521 Check command object for the `check_vmware_esx` plugin. Overall object status (gray/green/red/yellow).
4523 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
4526 ------------------------|--------------
4527 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. Conflicts with **vmware_host**.
4528 vmware_host | **Optional.** ESX or ESXi hostname. Conflicts with **vmware_datacenter**.
4529 vmware_vmname | **Required.** Virtual machine name.
4530 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
4531 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
4532 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
4533 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
4534 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
4535 vmware_sessionfile | **Optional.** Session file name enhancement.
4536 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
4537 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
4538 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
4539 vmware_password | **Optional.** The username's password. No value defined as default.
4540 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
4543 ##### <a id="plugin-contrib-vmware-esx-soap-vm-runtime-consoleconnections"></a> vmware-esx-soap-vm-runtime-consoleconnections
4545 Check command object for the `check_vmware_esx` plugin. Console connections to virtual machine.
4547 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
4550 ------------------------|--------------
4551 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. Conflicts with **vmware_host**.
4552 vmware_host | **Optional.** ESX or ESXi hostname. Conflicts with **vmware_datacenter**.
4553 vmware_vmname | **Required.** Virtual machine name.
4554 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
4555 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
4556 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
4557 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
4558 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
4559 vmware_sessionfile | **Optional.** Session file name enhancement.
4560 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
4561 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
4562 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
4563 vmware_password | **Optional.** The username's password. No value defined as default.
4564 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
4565 vmware_warn | **Optional.** The warning threshold. No value defined as default.
4566 vmware_crit | **Optional.** The critical threshold. No value defined as default.
4569 ##### <a id="plugin-contrib-vmware-esx-soap-vm-runtime-gueststate"></a> vmware-esx-soap-vm-runtime-gueststate
4571 Check command object for the `check_vmware_esx` plugin. Guest OS status. Needs VMware Tools installed and running.
4573 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
4576 ------------------------|--------------
4577 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. Conflicts with **vmware_host**.
4578 vmware_host | **Optional.** ESX or ESXi hostname. Conflicts with **vmware_datacenter**.
4579 vmware_vmname | **Required.** Virtual machine name.
4580 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
4581 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
4582 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
4583 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
4584 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
4585 vmware_sessionfile | **Optional.** Session file name enhancement.
4586 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
4587 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
4588 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
4589 vmware_password | **Optional.** The username's password. No value defined as default.
4590 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
4592 ##### <a id="plugin-contrib-vmware-esx-soap-vm-runtime-tools"></a> vmware-esx-soap-vm-runtime-tools
4594 Check command object for the `check_vmware_esx` plugin. Guest OS status. VMware tools status.
4596 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
4599 ------------------------|--------------
4600 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. Conflicts with **vmware_host**.
4601 vmware_host | **Optional.** ESX or ESXi hostname. Conflicts with **vmware_datacenter**.
4602 vmware_vmname | **Required.** Virtual machine name.
4603 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
4604 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
4605 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
4606 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
4607 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
4608 vmware_sessionfile | **Optional.** Session file name enhancement.
4609 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
4610 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
4611 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
4612 vmware_password | **Optional.** The username's password. No value defined as default.
4613 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
4614 vmware_openvmtools | **Optional** Prevent CRITICAL state for installed and running Open VM Tools.
4617 ##### <a id="plugin-contrib-vmware-esx-soap-vm-runtime-issues"></a> vmware-esx-soap-vm-runtime-issues
4619 Check command object for the `check_vmware_esx` plugin. All issues for the virtual machine.
4621 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
4624 ------------------------|--------------
4625 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. Conflicts with **vmware_host**.
4626 vmware_host | **Optional.** ESX or ESXi hostname. Conflicts with **vmware_datacenter**.
4627 vmware_vmname | **Required.** Virtual machine name.
4628 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
4629 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
4630 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
4631 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
4632 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
4633 vmware_sessionfile | **Optional.** Session file name enhancement.
4634 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
4635 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
4636 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
4637 vmware_password | **Optional.** The username's password. No value defined as default.
4638 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
4639 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.
4642 ### <a id="plugin-contrib-web"></a> Web
4644 This category includes all plugins for web-based checks.
4646 #### <a id="plugin-contrib-command-webinject"></a> webinject
4648 Check command object for the [check_webinject](http://www.webinject.org/manual.html) plugin.
4650 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
4653 ------------------------|--------------
4654 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.
4655 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.
4656 webinject_no_output | **Optional.** Suppresses all output to STDOUT except the results summary.
4657 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.
4658 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.
4659 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.
4661 #### <a id="plugin-contrib-command-jmx4perl"></a> jmx4perl
4663 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.
4665 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
4668 -----------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------
4669 jmx4perl_url | **Required.** URL to agent web application. Defaults to "http://$address$:8080/jolokia".
4670 jmx4perl_product | **Optional.** Name of app server product (e.g. jboss), by default is uses an autodetection facility.
4671 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.
4672 jmx4perl_mbean | **Optional.** MBean name (e.g. java.lang:type=Memory).
4673 jmx4perl_attribute | **Optional.** Attribute name (e.g. HeapMemoryUsage).
4674 jmx4perl_operation | **Optional.** Operation to execute.
4675 jmx4perl_value | **Optional.** Shortcut for specifying mbean/attribute/path. Slashes within names must be escaped with backslash.
4676 jmx4perl_delta | **Optional.** Switches on incremental mode. Optional argument are seconds used for normalizing.
4677 jmx4perl_path | **Optional.** Inner path for extracting a single value from a complex attribute or return value (e.g. used).
4678 jmx4perl_target | **Optional.** JSR-160 Service URL specifing the target server.
4679 jmx4perl_target_user | **Optional.** Username to use for JSR-160 connection.
4680 jmx4perl_target_password | **Optional.** Password to use for JSR-160 connection.
4681 jmx4perl_proxy | **Optional.** Proxy to use.
4682 jmx4perl_user | **Optional.** User for HTTP authentication.
4683 jmx4perl_password | **Optional.** Password for HTTP authentication.
4684 jmx4perl_name | **Optional.** Name to use for output, by default a standard value based on the MBean and attribute will be used.
4685 jmx4perl_method | **Optional.** HTTP method to use, either get or post. By default a method is determined automatically based on the request type.
4686 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.
4687 jmx4perl_base_mbean | **Optional.** Base MBean name, interprets critical and warning values as relative in the range 0 .. 100%. Requires "jmx4perl_base_attribute".
4688 jmx4perl_base_attribute | **Optional.** Base attribute for a relative check. Requires "jmx4perl_base_mbean".
4689 jmx4perl_base_path | **Optional.** Base path for relative checks, where this path is used on the base attribute's value.
4690 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.
4691 jmx4perl_null | **Optional.** Value which should be used in case of a null return value of an operation or attribute. Defaults to null.
4692 jmx4perl_string | **Optional.** Force string comparison for critical and warning checks. Defaults to false.
4693 jmx4perl_numeric | **Optional.** Force numeric comparison for critical and warning checks. Defaults to false.
4694 jmx4perl_critical | **Optional.** Critical threshold for value.
4695 jmx4perl_warning | **Optional.** Warning threshold for value.
4696 jmx4perl_label | **Optional.** Label to be used for printing out the result of the check. For placeholders which can be used see the documentation.
4697 jmx4perl_perfdata | **Optional.** Whether performance data should be omitted, which are included by default. Defaults to "on" for numeric values, to "off" for strings.
4698 jmx4perl_unknown_is_critical | **Optional.** Map UNKNOWN errors to errors with a CRITICAL status. Defaults to false.
4699 jmx4perl_timeout | **Optional.** Seconds before plugin times out. Defaults to "15".
4700 jmx4perl_config | **Optional.** Path to configuration file.
4701 jmx4perl_server | **Optional.** Symbolic name of server url to use, which needs to be configured in the configuration file.
4702 jmx4perl_check | **Optional.** Name of a check configuration as defined in the configuration file, use array if you need arguments.
4704 #### <a id="plugin-contrib-command-squid"></a> squid
4706 Plugin for monitoring [Squid](https://exchange.icinga.com/exchange/check_squid).
4708 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
4711 ------------------------|----------------------------------------------------------------------------------
4712 squid_hostname | **Optional.** The host's address. Defaults to "$address$" if the host's `address` attribute is set, "$address6$" otherwise.
4713 squid_data | **Optional.** Data to fetch (default: Connections) available data: Connections Cache Resources Memory FileDescriptors.
4714 squid_port | **Optional.** Port number (default: 3128).
4715 squid_user | **Optional.** WWW user
4716 squid_password | **Optional.** WWW password
4717 squid_warning | **Optional.** Warning threshold. See http://nagiosplug.sourceforge.net/developer-guidelines.html#THRESHOLDFORMAT for the threshold format.
4718 squid_critical | **Optional.** Critical threshold. See http://nagiosplug.sourceforge.net/developer-guidelines.html#THRESHOLDFORMAT for the threshold format.
4719 squid_client | **Optional.** Path of squidclient (default: /usr/bin/squidclient).
4720 squid_timeout | **Optional.** Seconds before plugin times out (default: 15).
4723 #### <a id="plugin-contrib-command-nginx_status"></a> nginx_status
4725 Plugin for monitoring [nginx_status](https://github.com/regilero/check_nginx_status).
4727 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
4730 ------------------------|----------------------------------------------------------------------------------
4731 nginx_status_host_address | **Optional.** The host's address. Defaults to "$address$" if the host's `address` attribute is set, `address6` otherwise.
4732 nginx_status_port | **Optional.** the http port.
4733 nginx_status_url | **Optional.** URL to use, instead of the default (http://`nginx_status_hostname`/nginx_status).
4734 nginx_status_servername | **Optional.** ServerName to use if you specified an IP to match the good Virtualhost in your target
4735 nginx_status_ssl | **Optional.** set to use ssl connection
4736 nginx_status_disable_sslverify | **Optional.** set to disable SSL hostname verification
4737 nginx_status_user | **Optional.** Username for basic auth
4738 nginx_status_pass | **Optional.** Password for basic auth
4739 nginx_status_realm | **Optional.** Realm for basic auth
4740 nginx_status_maxreach | **Optional.** Number of max processes reached (since last check) that should trigger an alert
4741 nginx_status_timeout | **Optional.** timeout in seconds
4742 nginx_status_warn | **Optional.** Warning threshold (number of active connections, ReqPerSec or ConnPerSec that will cause a WARNING) like '10000,100,200'.
4743 nginx_status_critical | **Optional.** Critical threshold (number of active connections, ReqPerSec or ConnPerSec that will cause a CRITICAL) like '20000,200,300'.
4746 #### <a id="plugin-contrib-command-apache_status"></a> apache_status
4748 Plugin for monitoring [apache_status](https://github.com/lbetz/check_apache_status).
4750 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
4753 ------------------------|----------------------------------------------------------------------------------
4754 apache_status_address | **Optional.** The host's address. Defaults to "$address$" if the host's `address` attribute is set, `address6` otherwise.
4755 apache_status_port | **Optional.** the http port.
4756 apache_status_url | **Optional.** URL to use, instead of the default (http://`apache_status_address`/server-status).
4757 apache_status_ssl | **Optional.** set to use ssl connection
4758 apache_status_timeout | **Optional.** timeout in seconds
4759 apache_status_warning | **Optional.** Warning threshold (number of open slots, busy workers and idle workers that will cause a WARNING) like ':20,50,:50'.
4760 apache_status_critical | **Optional.** Critical threshold (number of open slots, busy workers and idle workers that will cause a CRITICAL) like ':10,25,:20'.
4763 #### <a id="plugin-contrib-command-kdc"></a> kdc
4765 Plugin for monitoring [kdc](https://exchange.nagios.org/directory/Plugins/Security/check_kdc/details).
4767 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
4770 ----------------|--------------------------------------------------------------------------
4771 kdc_address | **Optional.** The host's address. Defaults to "$address$" if the host's `address` attribute is set, `address6` otherwise.
4772 kdc_port | **Optional** Port on which KDC runs (default 88).
4773 kdc_principal | **Required** Principal name to authenticate as (including realm).
4774 kdc_keytab | **Required** Keytab file containing principal's key.
4777 #### <a id="plugin-contrib-command-rbl"></a> rbl
4779 Plugin for monitoring [rbl](https://github.com/matteocorti/check_rbl)
4781 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
4784 ----------------|--------------------------------------------------------------------------
4785 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.
4786 rbl_server | **Required** List of RBL servers as an array.
4787 rbl_warning | **Optional** Number of blacklisting servers for a warning.
4788 rbl_critical | **Optional** Number of blacklisting servers for a critical.
4789 tbl_timeout | **Optional** Seconds before plugin times out (default: 15).
projects / icinga2 / blob