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. Defaults to "none", "tmpfs", "sysfs", "proc", "devtmpfs", "devfs", "mtmfs", "tracefs", "cgroup", "fuse.gvfsd-fuse", "fuse.gvfs-fuse-daemon", "fdescfs".
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_query_type | **Optional.** The DNS record query type where TYPE =(A, AAAA, SRV, TXT, MX, ANY). The default query type is 'A' (IPv4 host entry)
326 dns_expected_answers | **Optional.** The answer(s) to look for. A hostname must end with a dot. Multiple answers must be defined as array.
327 dns_authoritative | **Optional.** Expect the server to send an authoritative answer.
328 dns_wtime | **Optional.** Return warning if elapsed time exceeds value.
329 dns_ctime | **Optional.** Return critical if elapsed time exceeds value.
330 dns_timeout | **Optional.** Seconds before connection times out. Defaults to 10.
333 ### <a id="plugin-check-command-dummy"></a> dummy
335 The [check_dummy](https://www.monitoring-plugins.org/doc/man/check_dummy.html) plugin
336 will simply return the state corresponding to the numeric value of the `dummy_state`
337 argument with optional text.
339 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
342 ----------------|--------------
343 dummy_state | **Optional.** The state. Can be one of 0 (ok), 1 (warning), 2 (critical) and 3 (unknown). Defaults to 0.
344 dummy_text | **Optional.** Plugin output. Defaults to "Check was successful.".
347 ### <a id="plugin-check-command-file-age"></a> file_age
349 The [check_file_age](https://www.monitoring-plugins.org/doc/man/check_file_age.html) plugin
350 checks a file's size and modification time to make sure it's not empty and that it's sufficiently recent.
352 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
355 -----------------------|--------------------------------------------------------------------------------------------------------
356 file_age_file | **Required.** File to monitor.
357 file_age_warning_time | **Optional.** File must be no more than this many seconds old as warning threshold. Defaults to "240s".
358 file_age_critical_time | **Optional.** File must be no more than this many seconds old as critical threshold. Defaults to "600s".
359 file_age_warning_size | **Optional.** File must be at least this many bytes long as warning threshold. No default given.
360 file_age_critical_size | **Optional.** File must be at least this many bytes long as critical threshold. Defaults to "0B".
361 file_age_ignoremissing | **Optional.** Return OK if the file does not exist. Defaults to false.
364 ### <a id="plugin-check-command-flexlm"></a> flexlm
366 The [check_flexlm](https://www.monitoring-plugins.org/doc/man/check_flexlm.html) plugin
367 checks available flexlm license managers. Requires the `lmstat` command.
369 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
372 -------------------|----------------------------------------------------------
373 flexlm_licensefile | **Required.** Name of license file (usually license.dat).
374 flexlm_timeout | **Optional.** Plugin time out in seconds. Defaults to 15.
377 ### <a id="plugin-check-command-fping4"></a> fping4
379 The [check_fping](https://www.monitoring-plugins.org/doc/man/check_fping.html) plugin
380 will use the `fping` command to ping the specified host for a fast check. Note that it is
381 necessary to set the suid flag on fping.
383 This CheckCommand expects an IPv4 address.
385 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
388 ----------------|--------------
389 fping_address | **Optional.** The host's IPv4 address. Defaults to "$address$".
390 fping_wrta | **Optional.** The RTA warning threshold in milliseconds. Defaults to 100.
391 fping_wpl | **Optional.** The packet loss warning threshold in %. Defaults to 5.
392 fping_crta | **Optional.** The RTA critical threshold in milliseconds. Defaults to 200.
393 fping_cpl | **Optional.** The packet loss critical threshold in %. Defaults to 15.
394 fping_number | **Optional.** The number of packets to send. Defaults to 5.
395 fping_interval | **Optional.** The interval between packets in milli-seconds. Defaults to 500.
396 fping_bytes | **Optional.** The size of ICMP packet.
397 fping_target_timeout | **Optional.** The target timeout in milli-seconds.
398 fping_source_ip | **Optional.** The name or ip address of the source ip.
399 fping_source_interface | **Optional.** The source interface name.
402 ### <a id="plugin-check-command-fping6"></a> fping6
404 The [check_fping](https://www.monitoring-plugins.org/doc/man/check_fping.html) plugin
405 will use the `fping` command to ping the specified host for a fast check. Note that it is
406 necessary to set the suid flag on fping.
408 This CheckCommand expects an IPv6 address.
410 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
413 ----------------|--------------
414 fping_address | **Optional.** The host's IPv6 address. Defaults to "$address6$".
415 fping_wrta | **Optional.** The RTA warning threshold in milliseconds. Defaults to 100.
416 fping_wpl | **Optional.** The packet loss warning threshold in %. Defaults to 5.
417 fping_crta | **Optional.** The RTA critical threshold in milliseconds. Defaults to 200.
418 fping_cpl | **Optional.** The packet loss critical threshold in %. Defaults to 15.
419 fping_number | **Optional.** The number of packets to send. Defaults to 5.
420 fping_interval | **Optional.** The interval between packets in milli-seconds. Defaults to 500.
421 fping_bytes | **Optional.** The size of ICMP packet.
422 fping_target_timeout | **Optional.** The target timeout in milli-seconds.
423 fping_source_ip | **Optional.** The name or ip address of the source ip.
424 fping_source_interface | **Optional.** The source interface name.
427 ### <a id="plugin-check-command-ftp"></a> ftp
429 The [check_ftp](https://www.monitoring-plugins.org/doc/man/check_ftp.html) plugin
430 tests FTP connections with the specified host (or unix socket).
432 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
435 -------------------|--------------
436 ftp_address | **Optional.** The host's address. Defaults to "$address$" if the host's `address` attribute is set, "$address6$" otherwise.
437 ftp_port | **Optional.** The FTP port number.
438 ftp_expect | **Optional.** String to expect in server response. Multiple strings must be defined as array.
439 ftp_all | **Optional.** All expect strings need to occur in server response. Defaults to false.
440 ftp_escape_send | **Optional.** Enable usage of \\n, \\r, \\t or \\\\ in send string.
441 ftp_send | **Optional.** String to send to the server.
442 ftp_escape_quit | **Optional.** Enable usage of \\n, \\r, \\t or \\\\ in quit string.
443 ftp_quit | **Optional.** String to send server to initiate a clean close of the connection.
444 ftp_refuse | **Optional.** Accept TCP refusals with states ok, warn, crit. Defaults to crit.
445 ftp_mismatch | **Optional.** Accept expected string mismatches with states ok, warn, crit. Defaults to warn.
446 ftp_jail | **Optional.** Hide output from TCP socket.
447 ftp_maxbytes | **Optional.** Close connection once more than this number of bytes are received.
448 ftp_delay | **Optional.** Seconds to wait between sending string and polling for response.
449 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.
450 ftp_ssl | **Optional.** Use SSL for the connection. Defaults to false.
451 ftp_wtime | **Optional.** Response time to result in warning status (seconds).
452 ftp_ctime | **Optional.** Response time to result in critical status (seconds).
453 ftp_timeout | **Optional.** Seconds before connection times out. Defaults to 10.
454 ftp_ipv4 | **Optional.** Use IPv4 connection. Defaults to false.
455 ftp_ipv6 | **Optional.** Use IPv6 connection. Defaults to false.
458 ### <a id="plugin-check-command-game"></a> game
460 The [check_game](https://www.monitoring-plugins.org/doc/man/check_game.html) plugin
461 tests game server connections with the specified host.
462 This plugin uses the 'qstat' command, the popular game server status query tool.
463 If you don't have the package installed, you will need to [download](http://www.activesw.com/people/steve/qstat.html)
464 or install the package `quakestat` before you can use this plugin.
466 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
469 -------------------|-------------------
470 game_game | **Required.** Name of the game.
471 game_ipaddress | **Required.** Ipaddress of the game server to query.
472 game_timeout | **Optional.** Seconds before connection times out. Defaults to 10.
473 game_port | **Optional.** Port to connect to.
474 game_gamefield | **Optional.** Field number in raw qstat output that contains game name.
475 game_mapfield | **Optional.** Field number in raw qstat output that contains map name.
476 game_pingfield | **Optional.** Field number in raw qstat output that contains ping time.
477 game_gametime | **Optional.** Field number in raw qstat output that contains game time.
478 game_hostname | **Optional.** Name of the host running the game.
481 ### <a id="plugin-check-command-hostalive"></a> hostalive
483 Check command object for the [check_ping](https://www.monitoring-plugins.org/doc/man/check_ping.html)
484 plugin with host check default values. This variant uses the host's `address` attribute
485 if available and falls back to using the `address6` attribute if the `address` attribute is not set.
487 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
490 ----------------|--------------
491 ping_address | **Optional.** The host's address. Defaults to "$address$" if the host's `address` attribute is set, "$address6$" otherwise.
492 ping_wrta | **Optional.** The RTA warning threshold in milliseconds. Defaults to 3000.
493 ping_wpl | **Optional.** The packet loss warning threshold in %. Defaults to 80.
494 ping_crta | **Optional.** The RTA critical threshold in milliseconds. Defaults to 5000.
495 ping_cpl | **Optional.** The packet loss critical threshold in %. Defaults to 100.
496 ping_packets | **Optional.** The number of packets to send. Defaults to 5.
497 ping_timeout | **Optional.** The plugin timeout in seconds. Defaults to 0 (no timeout).
500 ### <a id="plugin-check-command-hostalive4"></a> hostalive4
502 Check command object for the [check_ping](https://www.monitoring-plugins.org/doc/man/check_ping.html)
503 plugin with host check default values. This variant uses the host's `address` attribute.
505 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
508 ----------------|--------------
509 ping_address | **Optional.** The host's IPv4 address. Defaults to "$address$".
510 ping_wrta | **Optional.** The RTA warning threshold in milliseconds. Defaults to 3000.
511 ping_wpl | **Optional.** The packet loss warning threshold in %. Defaults to 80.
512 ping_crta | **Optional.** The RTA critical threshold in milliseconds. Defaults to 5000.
513 ping_cpl | **Optional.** The packet loss critical threshold in %. Defaults to 100.
514 ping_packets | **Optional.** The number of packets to send. Defaults to 5.
515 ping_timeout | **Optional.** The plugin timeout in seconds. Defaults to 0 (no timeout).
518 ### <a id="plugin-check-command-hostalive6"></a> hostalive6
520 Check command object for the [check_ping](https://www.monitoring-plugins.org/doc/man/check_ping.html)
521 plugin with host check default values. This variant uses the host's `address6` attribute.
523 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
526 ----------------|--------------
527 ping_address | **Optional.** The host's IPv6 address. Defaults to "$address6$".
528 ping_wrta | **Optional.** The RTA warning threshold in milliseconds. Defaults to 3000.
529 ping_wpl | **Optional.** The packet loss warning threshold in %. Defaults to 80.
530 ping_crta | **Optional.** The RTA critical threshold in milliseconds. Defaults to 5000.
531 ping_cpl | **Optional.** The packet loss critical threshold in %. Defaults to 100.
532 ping_packets | **Optional.** The number of packets to send. Defaults to 5.
533 ping_timeout | **Optional.** The plugin timeout in seconds. Defaults to 0 (no timeout).
536 ### <a id="plugin-check-command-hpjd"></a> hpjd
538 The [check_hpjd](https://www.monitoring-plugins.org/doc/man/check_hpjd.html) plugin
539 tests the state of an HP printer with a JetDirect card. Net-snmp must be installed
540 on the computer running the plugin.
542 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
545 ----------------|--------------
546 hpjd_address | **Optional.** The host's address. Defaults to "$address$" if the host's `address` attribute is set, "$address6$" otherwise.
547 hpjd_port | **Optional.** The host's SNMP port. Defaults to 161.
548 hpjd_community | **Optional.** The SNMP community. Defaults to "public".
551 ### <a id="plugin-check-command-http"></a> http
553 The [check_http](https://www.monitoring-plugins.org/doc/man/check_http.html) plugin
554 tests the HTTP service on the specified host. It can test normal (http) and secure
555 (https) servers, follow redirects, search for strings and regular expressions,
556 check connection times, and report on certificate expiration times.
558 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
561 ---------------------------------|---------------------------------
562 http_address | **Optional.** The host's address. Defaults to "$address$" if the host's `address` attribute is set, "$address6$" otherwise.
563 http_vhost | **Optional.** The virtual host that should be sent in the "Host" header.
564 http_uri | **Optional.** The request URI for GET or POST. Defaults to `/`.
565 http_port | **Optional.** The TCP port. Defaults to 80 when not using SSL, 443 otherwise.
566 http_ssl | **Optional.** Whether to use SSL. Defaults to false.
567 http_ssl_force_tlsv1 | **Optional.** Whether to force TLSv1.
568 http_ssl_force_tlsv1_1 | **Optional.** Whether to force TLSv1.1.
569 http_ssl_force_tlsv1_2 | **Optional.** Whether to force TLSv1.2.
570 http_ssl_force_sslv2 | **Optional.** Whether to force SSLv2.
571 http_ssl_force_sslv3 | **Optional.** Whether to force SSLv3.
572 http_ssl_force_tlsv1_or_higher | **Optional.** Whether to force TLSv1 or higher.
573 http_ssl_force_tlsv1_1_or_higher | **Optional.** Whether to force TLSv1.1 or higher.
574 http_ssl_force_tlsv1_2_or_higher | **Optional.** Whether to force TLSv1.2 or higher.
575 http_ssl_force_sslv2_or_higher | **Optional.** Whether to force SSLv2 or higher.
576 http_ssl_force_sslv3_or_higher | **Optional.** Whether to force SSLv3 or higher.
577 http_sni | **Optional.** Whether to use SNI. Defaults to false.
578 http_auth_pair | **Optional.** Add 'username:password' authorization pair.
579 http_proxy_auth_pair | **Optional.** Add 'username:password' authorization pair for proxy.
580 http_ignore_body | **Optional.** Don't download the body, just the headers.
581 http_linespan | **Optional.** Allow regex to span newline.
582 http_expect_body_regex | **Optional.** A regular expression which the body must match against. Incompatible with http_ignore_body.
583 http_expect_body_eregi | **Optional.** A case-insensitive expression which the body must match against. Incompatible with http_ignore_body.
584 http_invertregex | **Optional.** Changes behaviour of http_expect_body_regex and http_expect_body_eregi to return CRITICAL if found, OK if not.
585 http_warn_time | **Optional.** The warning threshold.
586 http_critical_time | **Optional.** The critical threshold.
587 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.
588 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.
589 http_clientcert | **Optional.** Name of file contains the client certificate (PEM format).
590 http_privatekey | **Optional.** Name of file contains the private key (PEM format).
591 http_headerstring | **Optional.** String to expect in the response headers.
592 http_string | **Optional.** String to expect in the content.
593 http_post | **Optional.** URL encoded http POST data.
594 http_method | **Optional.** Set http method (for example: HEAD, OPTIONS, TRACE, PUT, DELETE).
595 http_maxage | **Optional.** Warn if document is more than seconds old.
596 http_contenttype | **Optional.** Specify Content-Type header when POSTing.
597 http_useragent | **Optional.** String to be sent in http header as User Agent.
598 http_header | **Optional.** Any other tags to be sent in http header.
599 http_extendedperfdata | **Optional.** Print additional perfdata. Defaults to false.
600 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)
601 http_pagesize | **Optional.** Minimum page size required:Maximum page size required.
602 http_timeout | **Optional.** Seconds before connection times out.
603 http_ipv4 | **Optional.** Use IPv4 connection. Defaults to false.
604 http_ipv6 | **Optional.** Use IPv6 connection. Defaults to false.
605 http_link | **Optional.** Wrap output in HTML link. Defaults to false.
606 http_verbose | **Optional.** Show details for command-line debugging. Defaults to false.
609 ### <a id="plugin-check-command-icmp"></a> icmp
611 The [check_icmp](https://www.monitoring-plugins.org/doc/man/check_icmp.html) plugin
612 check_icmp allows for checking multiple hosts at once compared to `check_ping`.
613 The main difference is that check_ping executes the system's ping(1) command and
614 parses its output while check_icmp talks ICMP itself. check_icmp must be installed
617 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
620 ----------------|--------------
621 icmp_address | **Optional.** The host's address. This can either be a single address or an array of addresses. Defaults to "$address$".
622 icmp_wrta | **Optional.** The RTA warning threshold in milliseconds. Defaults to 100.
623 icmp_wpl | **Optional.** The packet loss warning threshold in %. Defaults to 5.
624 icmp_crta | **Optional.** The RTA critical threshold in milliseconds. Defaults to 200.
625 icmp_cpl | **Optional.** The packet loss critical threshold in %. Defaults to 15.
626 icmp_source | **Optional.** The source IP address to send packets from.
627 icmp_packets | **Optional.** The number of packets to send. Defaults to 5.
628 icmp_packet_interval | **Optional** The maximum packet interval. Defaults to 80 (milliseconds).
629 icmp_target_interval | **Optional.** The maximum target interval.
630 icmp_hosts_alive | **Optional.** The number of hosts which have to be alive for the check to succeed.
631 icmp_data_bytes | **Optional.** Payload size for each ICMP request. Defaults to 8.
632 icmp_timeout | **Optional.** The plugin timeout in seconds. Defaults to 10 (seconds).
633 icmp_ttl | **Optional.** The TTL on outgoing packets.
636 ### <a id="plugin-check-command-imap"></a> imap
638 The [check_imap](https://www.monitoring-plugins.org/doc/man/check_imap.html) plugin
639 tests IMAP connections with the specified host (or unix socket).
641 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
644 ----------------------|--------------
645 imap_address | **Optional.** The host's address. Defaults to "$address$" if the host's `address` attribute is set, "$address6$" otherwise.
646 imap_port | **Optional.** The port that should be checked. Defaults to 143.
647 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.
648 imap_send | **Optional.** String to send to the server.
649 imap_expect | **Optional.** String to expect in server response. Multiple strings must be defined as array.
650 imap_all | **Optional.** All expect strings need to occur in server response. Default is any.
651 imap_quit | **Optional.** String to send server to initiate a clean close of the connection.
652 imap_refuse | **Optional.** Accept TCP refusals with states ok, warn, crit (default: crit).
653 imap_mismatch | **Optional.** Accept expected string mismatches with states ok, warn, crit (default: warn).
654 imap_jail | **Optional.** Hide output from TCP socket.
655 imap_maxbytes | **Optional.** Close connection once more than this number of bytes are received.
656 imap_delay | **Optional.** Seconds to wait between sending string and polling for response.
657 imap_certificate_age | **Optional.** Minimum number of days a certificate has to be valid.
658 imap_ssl | **Optional.** Use SSL for the connection.
659 imap_warning | **Optional.** Response time to result in warning status (seconds).
660 imap_critical | **Optional.** Response time to result in critical status (seconds).
661 imap_timeout | **Optional.** Seconds before connection times out (default: 10).
662 imap_ipv4 | **Optional.** Use IPv4 connection. Defaults to false.
663 imap_ipv6 | **Optional.** Use IPv6 connection. Defaults to false.
666 ### <a id="plugin-check-command-ldap"></a> ldap
668 The [check_ldap](https://www.monitoring-plugins.org/doc/man/check_ldap.html) plugin
669 can be used to check LDAP servers.
671 The plugin can also be used for monitoring ldaps connections instead of the deprecated `check_ldaps`.
672 This can be ensured by enabling `ldap_starttls` or `ldap_ssl`.
674 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
677 ----------------|--------------
678 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.
679 ldap_port | **Optional.** Port number. Defaults to 389.
680 ldap_attr | **Optional.** LDAP attribute to search for (default: "(objectclass=*)"
681 ldap_base | **Required.** LDAP base (eg. ou=myunit,o=myorg,c=at).
682 ldap_bind | **Optional.** LDAP bind DN (if required).
683 ldap_pass | **Optional.** LDAP password (if required).
684 ldap_starttls | **Optional.** Use STARTSSL mechanism introduced in protocol version 3.
685 ldap_ssl | **Optional.** Use LDAPS (LDAP v2 SSL method). This also sets the default port to 636.
686 ldap_v2 | **Optional.** Use LDAP protocol version 2 (enabled by default).
687 ldap_v3 | **Optional.** Use LDAP protocol version 3 (disabled by default)
688 ldap_warning | **Optional.** Response time to result in warning status (seconds).
689 ldap_critical | **Optional.** Response time to result in critical status (seconds).
690 ldap_timeout | **Optional.** Seconds before connection times out (default: 10).
691 ldap_verbose | **Optional.** Show details for command-line debugging (disabled by default)
693 ### <a id="plugin-check-command-load"></a> load
695 The [check_load](https://www.monitoring-plugins.org/doc/man/check_load.html) plugin
696 tests the current system load average.
698 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
701 ----------------|--------------
702 load_wload1 | **Optional.** The 1-minute warning threshold. Defaults to 5.
703 load_wload5 | **Optional.** The 5-minute warning threshold. Defaults to 4.
704 load_wload15 | **Optional.** The 15-minute warning threshold. Defaults to 3.
705 load_cload1 | **Optional.** The 1-minute critical threshold. Defaults to 10.
706 load_cload5 | **Optional.** The 5-minute critical threshold. Defaults to 6.
707 load_cload15 | **Optional.** The 15-minute critical threshold. Defaults to 4.
708 load_percpu | **Optional.** Divide the load averages by the number of CPUs (when possible). Defaults to false.
710 ### <a id="plugin-check-command-mailq"></a> mailq
712 The [check_mailq](https://www.monitoring-plugins.org/doc/man/check_mailq.html) plugin
713 checks the number of messages in the mail queue (supports multiple sendmail queues, qmail).
715 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
718 ------------------------|--------------
719 mailq_warning | **Required.** Min. number of messages in queue to generate warning.
720 mailq_critical | **Required.** Min. number of messages in queue to generate critical alert ( w < c ).
721 mailq_domain_warning | **Optional.** Min. number of messages for same domain in queue to generate warning
722 mailq_domain_critical | **Optional.** Min. number of messages for same domain in queue to generate critical alert ( W < C ).
723 mailq_timeout | **Optional.** Plugin timeout in seconds (default = 15).
724 mailq_servertype | **Optional.** [ sendmail \| qmail \| postfix \| exim \| nullmailer ] (default = autodetect).
725 mailq_sudo | **Optional.** Use sudo to execute the mailq command.
727 ### <a id="plugin-check-command-mysql"></a> mysql
729 The [check_mysql](https://www.monitoring-plugins.org/doc/man/check_mysql.html) plugin
730 tests connections to a MySQL server.
732 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
735 ------------------------|---------------------------------------------------------------
736 mysql_hostname | **Optional.** Host name, IP Address, or unix socket (must be an absolute path).
737 mysql_port | **Optional.** Port number (default: 3306).
738 mysql_ignore_auth | **Optional.** Ignore authentication failure and check for mysql connectivity only.
739 mysql_database | **Optional.** Check database with indicated name.
740 mysql_file | **Optional.** Read from the specified client options file.
741 mysql_group | **Optional.** Use a client options group.
742 mysql_username | **Optional.** Connect using the indicated username.
743 mysql_password | **Optional.** Use the indicated password to authenticate the connection.
744 mysql_check_slave | **Optional.** Check if the slave thread is running properly.
745 mysql_warning | **Optional.** Exit with WARNING status if slave server is more than INTEGER seconds behind master.
746 mysql_critical | **Optional.** Exit with CRITICAL status if slave server is more then INTEGER seconds behind master.
747 mysql_ssl | **Optional.** Use ssl encryptation.
748 mysql_cacert | **Optional.** Path to CA signing the cert.
749 mysql_cert | **Optional.** Path to SSL certificate.
750 mysql_key | **Optional.** Path to private SSL key.
751 mysql_cadir | **Optional.** Path to CA directory.
752 mysql_ciphers | **Optional.** List of valid SSL ciphers.
755 ### <a id="plugin-check-command-mysql-query"></a> mysql_query
757 The [check_mysql_query](https://www.monitoring-plugins.org/doc/man/check_mysql_query.html) plugin
758 checks a query result against threshold levels.
759 The result from the query should be numeric. For extra security, create a user with minimal access.
761 **Note**: You must specify `mysql_query_password` with an empty string to force an empty password,
762 overriding any my.cnf settings.
764 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
767 ------------------------|---------------------------------------------------------------
768 mysql_query_hostname | **Optional.** Host name, IP Address, or unix socket (must be an absolute path).
769 mysql_query_port | **Optional.** Port number (default: 3306).
770 mysql_query_database | **Optional.** Check database with indicated name.
771 mysql_query_file | **Optional.** Read from the specified client options file.
772 mysql_query_group | **Optional.** Use a client options group.
773 mysql_query_username | **Optional.** Connect using the indicated username.
774 mysql_query_password | **Optional.** Use the indicated password to authenticate the connection.
775 mysql_query_execute | **Required.** SQL Query to run on the MySQL Server.
776 mysql_query_warning | **Optional.** Exit with WARNING status if query is outside of the range (format: start:end).
777 mysql_query_critical | **Optional.** Exit with CRITICAL status if query is outside of the range.
780 ### <a id="plugin-check-command-negate"></a> negate
782 The [negate](https://www.monitoring-plugins.org/doc/man/negate.html) plugin
783 negates the status of a plugin (returns OK for CRITICAL and vice-versa).
784 Additional switches can be used to control which state becomes what.
786 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
789 ------------------------|---------------------------------------------------------------
790 negate_timeout | **Optional.** Seconds before plugin times out (default: 11).
791 negate_timeout_result | **Optional.** Custom result on Negate timeouts, default to UNKNOWN.
792 negate_ok | **Optional.** OK, WARNING, CRITICAL or UNKNOWN.
793 negate_warning | Numeric values are accepted.
794 negate_critical | If nothing is specified, permutes OK and CRITICAL.
795 negate_substitute | **Optional.** Substitute output text as well. Will only substitute text in CAPITALS.
796 negate_command | **Required.** Command to be negated.
797 negate_arguments | **Optional.** Arguments for the negated command.
799 ### <a id="plugin-check-command-nrpe"></a> nrpe
801 The `check_nrpe` plugin can be used to query an [NRPE](http://docs.icinga.com/latest/en/nrpe.html)
802 server or [NSClient++](https://www.nsclient.org). **Note**: This plugin
803 is considered insecure/deprecated.
805 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
808 ----------------|--------------
809 nrpe_address | **Optional.** The host's address. Defaults to "$address$" if the host's `address` attribute is set, "$address6$" otherwise.
810 nrpe_port | **Optional.** The NRPE port. Defaults to 5666.
811 nrpe_command | **Optional.** The command that should be executed.
812 nrpe_no_ssl | **Optional.** Whether to disable SSL or not. Defaults to `false`.
813 nrpe_timeout_unknown | **Optional.** Whether to set timeouts to unknown instead of critical state. Defaults to `false`.
814 nrpe_timeout | **Optional.** The timeout in seconds.
815 nrpe_arguments | **Optional.** Arguments that should be passed to the command. Multiple arguments must be defined as array.
816 nrpe_ipv4 | **Optional.** Use IPv4 connection. Defaults to false.
817 nrpe_ipv6 | **Optional.** Use IPv6 connection. Defaults to false.
820 ### <a id="plugin-check-command-nscp"></a> nscp
822 The [check_nt](https://www.monitoring-plugins.org/doc/man/check_nt.html) plugin
823 collects data from the [NSClient++](https://www.nsclient.org) service.
825 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
828 ----------------|--------------
829 nscp_address | **Optional.** The host's address. Defaults to "$address$" if the host's `address` attribute is set, "$address6$" otherwise.
830 nscp_port | **Optional.** The NSClient++ port. Defaults to 12489.
831 nscp_password | **Optional.** The NSClient++ password.
832 nscp_variable | **Required.** The variable that should be checked.
833 nscp_params | **Optional.** Parameters for the query. Multiple parameters must be defined as array.
834 nscp_warn | **Optional.** The warning threshold.
835 nscp_crit | **Optional.** The critical threshold.
836 nscp_timeout | **Optional.** The query timeout in seconds.
837 nscp_showall | **Optional.** Use with SERVICESTATE to see working services or PROCSTATE for running processes. Defaults to false.
840 ### <a id="plugin-check-command-ntp-time"></a> ntp_time
842 The [check_ntp_time](https://www.monitoring-plugins.org/doc/man/check_ntp_time.html) plugin
843 checks the clock offset between the local host and a remote NTP server.
845 **Note**: If you want to monitor an NTP server, please use `ntp_peer`.
847 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
850 ----------------|--------------
851 ntp_address | **Optional.** The host's address. Defaults to "$address$" if the host's `address` attribute is set, "$address6$" otherwise.
852 ntp_port | **Optional.** Port number (default: 123).
853 ntp_quiet | **Optional.** Returns UNKNOWN instead of CRITICAL if offset cannot be found.
854 ntp_warning | **Optional.** Offset to result in warning status (seconds).
855 ntp_critical | **Optional.** Offset to result in critical status (seconds).
856 ntp_timeoffset | **Optional.** Expected offset of the ntp server relative to local server (seconds).
857 ntp_timeout | **Optional.** Seconds before connection times out (default: 10).
858 ntp_ipv4 | **Optional.** Use IPv4 connection. Defaults to false.
859 ntp_ipv6 | **Optional.** Use IPv6 connection. Defaults to false.
862 ### <a id="plugin-check-command-ntp-peer"></a> ntp_peer
864 The [check_ntp_peer](https://www.monitoring-plugins.org/doc/man/check_ntp_peer.html) plugin
865 checks the health of an NTP server. It supports checking the offset with the sync peer, the
866 jitter and stratum. This plugin will not check the clock offset between the local host and NTP
867 server; please use `ntp_time` for that purpose.
869 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
872 ----------------|--------------
873 ntp_address | **Optional.** The host's address. Defaults to "$address$" if the host's `address` attribute is set, "$address6$" otherwise.
874 ntp_port | **Optional.** The port to use. Default to 123.
875 ntp_warning | **Optional.** Offset to result in warning status (seconds).
876 ntp_critical | **Optional.** Offset to result in critical status (seconds).
877 ntp_wstratum | **Optional.** Warning threshold for stratum of server's synchronization peer.
878 ntp_cstratum | **Optional.** Critical threshold for stratum of server's synchronization peer.
879 ntp_wjitter | **Optional.** Warning threshold for jitter.
880 ntp_cjitter | **Optional.** Critical threshold for jitter.
881 ntp_wsource | **Optional.** Warning threshold for number of usable time sources.
882 ntp_csource | **Optional.** Critical threshold for number of usable time sources.
883 ntp_timeout | **Optional.** Seconds before connection times out (default: 10).
884 ntp_ipv4 | **Optional.** Use IPv4 connection. Defaults to false.
885 ntp_ipv6 | **Optional.** Use IPv6 connection. Defaults to false.
888 ### <a id="plugin-check-command-passive"></a> passive
890 Specialised check command object for passive checks executing the `check_dummy` plugin with appropriate default values.
892 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
895 ----------------|--------------
896 dummy_state | **Optional.** The state. Can be one of 0 (ok), 1 (warning), 2 (critical) and 3 (unknown). Defaults to 3.
897 dummy_text | **Optional.** Plugin output. Defaults to "No Passive Check Result Received.".
899 ### <a id="plugin-check-command-pgsql"></a> pgsql
901 The [check_pgsql](https://www.monitoring-plugins.org/doc/man/check_pgsql.html) plugin
902 tests a PostgreSQL DBMS to determine whether it is active and accepting queries.
903 If a query is specified using the `pgsql_query` attribute, it will be executed after
904 connecting to the server. The result from the query has to be numeric in order
905 to compare it against the query thresholds if set.
907 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
910 ------------------------|---------------------------------------------------------------
911 pgsql_hostname | **Optional.** Host name, IP Address, or unix socket (must be an absolute path).
912 pgsql_port | **Optional.** Port number (default: 5432).
913 pgsql_database | **Optional.** Database to check (default: template1).
914 pgsql_username | **Optional.** Login name of user.
915 pgsql_password | **Optional.** Password (BIG SECURITY ISSUE).
916 pgsql_options | **Optional.** Connection parameters (keyword = value), see below.
917 pgsql_warning | **Optional.** Response time to result in warning status (seconds).
918 pgsql_critical | **Optional.** Response time to result in critical status (seconds).
919 pgsql_timeout | **Optional.** Seconds before connection times out (default: 10).
920 pgsql_query | **Optional.** SQL query to run. Only first column in first row will be read.
921 pgsql_query_warning | **Optional.** SQL query value to result in warning status (double).
922 pgsql_query_critical | **Optional.** SQL query value to result in critical status (double).
924 ### <a id="plugin-check-command-ping"></a> ping
926 The [check_ping](https://www.monitoring-plugins.org/doc/man/check_ping.html) plugin
927 uses the ping command to probe the specified host for packet loss (percentage) and
928 round trip average (milliseconds).
930 This command uses the host's `address` attribute if available and falls back to using
931 the `address6` attribute if the `address` attribute is not set.
933 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
936 ----------------|--------------
937 ping_address | **Optional.** The host's address. Defaults to "$address$" if the host's `address` attribute is set, "$address6$" otherwise.
938 ping_wrta | **Optional.** The RTA warning threshold in milliseconds. Defaults to 100.
939 ping_wpl | **Optional.** The packet loss warning threshold in %. Defaults to 5.
940 ping_crta | **Optional.** The RTA critical threshold in milliseconds. Defaults to 200.
941 ping_cpl | **Optional.** The packet loss critical threshold in %. Defaults to 15.
942 ping_packets | **Optional.** The number of packets to send. Defaults to 5.
943 ping_timeout | **Optional.** The plugin timeout in seconds. Defaults to 0 (no timeout).
946 ### <a id="plugin-check-command-ping4"></a> ping4
948 The [check_ping](https://www.monitoring-plugins.org/doc/man/check_ping.html) plugin
949 uses the ping command to probe the specified host for packet loss (percentage) and
950 round trip average (milliseconds).
952 This command uses the host's `address` attribute if not explicitely specified using
953 the `ping_address` attribute.
955 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
958 ----------------|--------------
959 ping_address | **Optional.** The host's IPv4 address. Defaults to "$address$".
960 ping_wrta | **Optional.** The RTA warning threshold in milliseconds. Defaults to 100.
961 ping_wpl | **Optional.** The packet loss warning threshold in %. Defaults to 5.
962 ping_crta | **Optional.** The RTA critical threshold in milliseconds. Defaults to 200.
963 ping_cpl | **Optional.** The packet loss critical threshold in %. Defaults to 15.
964 ping_packets | **Optional.** The number of packets to send. Defaults to 5.
965 ping_timeout | **Optional.** The plugin timeout in seconds. Defaults to 0 (no timeout).
967 ### <a id="plugin-check-command-ping6"></a> ping6
969 The [check_ping](https://www.monitoring-plugins.org/doc/man/check_ping.html) plugin
970 uses the ping command to probe the specified host for packet loss (percentage) and
971 round trip average (milliseconds).
973 This command uses the host's `address6` attribute if not explicitely specified using
974 the `ping_address` attribute.
976 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
979 ----------------|--------------
980 ping_address | **Optional.** The host's IPv6 address. Defaults to "$address6$".
981 ping_wrta | **Optional.** The RTA warning threshold in milliseconds. Defaults to 100.
982 ping_wpl | **Optional.** The packet loss warning threshold in %. Defaults to 5.
983 ping_crta | **Optional.** The RTA critical threshold in milliseconds. Defaults to 200.
984 ping_cpl | **Optional.** The packet loss critical threshold in %. Defaults to 15.
985 ping_packets | **Optional.** The number of packets to send. Defaults to 5.
986 ping_timeout | **Optional.** The plugin timeout in seconds. Defaults to 0 (no timeout).
989 ### <a id="plugin-check-command-pop"></a> pop
991 The [check_pop](https://www.monitoring-plugins.org/doc/man/check_pop.html) plugin
992 tests POP connections with the specified host (or unix socket).
994 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
997 ---------------------|--------------
998 pop_address | **Optional.** The host's address. Defaults to "$address$" if the host's `address` attribute is set, "$address6$" otherwise.
999 pop_port | **Optional.** The port that should be checked. Defaults to 110.
1000 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.
1001 pop_send | **Optional.** String to send to the server.
1002 pop_expect | **Optional.** String to expect in server response. Multiple strings must be defined as array.
1003 pop_all | **Optional.** All expect strings need to occur in server response. Default is any.
1004 pop_quit | **Optional.** String to send server to initiate a clean close of the connection.
1005 pop_refuse | **Optional.** Accept TCP refusals with states ok, warn, crit (default: crit).
1006 pop_mismatch | **Optional.** Accept expected string mismatches with states ok, warn, crit (default: warn).
1007 pop_jail | **Optional.** Hide output from TCP socket.
1008 pop_maxbytes | **Optional.** Close connection once more than this number of bytes are received.
1009 pop_delay | **Optional.** Seconds to wait between sending string and polling for response.
1010 pop_certificate_age | **Optional.** Minimum number of days a certificate has to be valid.
1011 pop_ssl | **Optional.** Use SSL for the connection.
1012 pop_warning | **Optional.** Response time to result in warning status (seconds).
1013 pop_critical | **Optional.** Response time to result in critical status (seconds).
1014 pop_timeout | **Optional.** Seconds before connection times out (default: 10).
1015 pop_ipv4 | **Optional.** Use IPv4 connection. Defaults to false.
1016 pop_ipv6 | **Optional.** Use IPv6 connection. Defaults to false.
1019 ### <a id="plugin-check-command-processes"></a> procs
1021 The [check_procs](https://www.monitoring-plugins.org/doc/man/check_procs.html) plugin
1022 checks all processes and generates WARNING or CRITICAL states if the specified
1023 metric is outside the required threshold ranges. The metric defaults to number
1024 of processes. Search filters can be applied to limit the processes to check.
1026 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
1029 ---------------------|--------------
1030 procs_warning | **Optional.** The process count warning threshold. Defaults to 250.
1031 procs_critical | **Optional.** The process count critical threshold. Defaults to 400.
1032 procs_metric | **Optional.** Check thresholds against metric.
1033 procs_timeout | **Optional.** Seconds before plugin times out.
1034 procs_traditional | **Optional.** Filter own process the traditional way by PID instead of /proc/pid/exe. Defaults to false.
1035 procs_state | **Optional.** Only scan for processes that have one or more of the status flags you specify.
1036 procs_ppid | **Optional.** Only scan for children of the parent process ID indicated.
1037 procs_vsz | **Optional.** Only scan for processes with VSZ higher than indicated.
1038 procs_rss | **Optional.** Only scan for processes with RSS higher than indicated.
1039 procs_pcpu | **Optional.** Only scan for processes with PCPU higher than indicated.
1040 procs_user | **Optional.** Only scan for processes with user name or ID indicated.
1041 procs_argument | **Optional.** Only scan for processes with args that contain STRING.
1042 procs_argument_regex | **Optional.** Only scan for processes with args that contain the regex STRING.
1043 procs_command | **Optional.** Only scan for exact matches of COMMAND (without path).
1044 procs_nokthreads | **Optional.** Only scan for non kernel threads. Defaults to false.
1047 ### <a id="plugin-check-command-radius"></a> radius
1049 The [check_radius](https://www.monitoring-plugins.org/doc/man/check_radius.html) plugin
1050 checks a RADIUS server to see if it is accepting connections. The server to test
1051 must be specified in the invocation, as well as a user name and password. A configuration
1052 file may also be present. The format of the configuration file is described in the
1053 radiusclient library sources. The password option presents a substantial security
1054 issue because the password can possibly be determined by careful watching of the
1055 command line in a process listing. This risk is exacerbated because the plugin will
1056 typically be executed at regular predictable intervals. Please be sure that the
1057 password used does not allow access to sensitive system resources.
1060 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
1063 -------------------|--------------
1064 radius_address | **Optional.** The radius server's address. Defaults to "$address$" if the host's `address` attribute is set, "$address6$" otherwise.
1065 radius_config_file | **Required.** The radius configuration file.
1066 radius_username | **Required.** The radius username to test.
1067 radius_password | **Required.** The radius password to test.
1068 radius_port | **Optional.** The radius port number (default 1645).
1069 radius_nas_id | **Optional.** The NAS identifier.
1070 radius_nas_address | **Optional.** The NAS IP address.
1071 radius_expect | **Optional.** The response string to expect from the server.
1072 radius_retries | **Optional.** The number of times to retry a failed connection.
1073 radius_timeout | **Optional.** The number of seconds before connection times out (default: 10).
1076 ### <a id="plugin-check-command-simap"></a> simap
1078 The [check_simap](https://www.monitoring-plugins.org/doc/man/check_simap.html) plugin
1079 tests SIMAP connections with the specified host (or unix socket).
1081 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
1084 -----------------------|--------------
1085 simap_address | **Optional.** The host's address. Defaults to "$address$" if the host's `address` attribute is set, "$address6$" otherwise.
1086 simap_port | **Optional.** The port that should be checked. Defaults to 993.
1087 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.
1088 simap_send | **Optional.** String to send to the server.
1089 simap_expect | **Optional.** String to expect in server response. Multiple strings must be defined as array.
1090 simap_all | **Optional.** All expect strings need to occur in server response. Default is any.
1091 simap_quit | **Optional.** String to send server to initiate a clean close of the connection.
1092 simap_refuse | **Optional.** Accept TCP refusals with states ok, warn, crit (default: crit).
1093 simap_mismatch | **Optional.** Accept expected string mismatches with states ok, warn, crit (default: warn).
1094 simap_jail | **Optional.** Hide output from TCP socket.
1095 simap_maxbytes | **Optional.** Close connection once more than this number of bytes are received.
1096 simap_delay | **Optional.** Seconds to wait between sending string and polling for response.
1097 simap_certificate_age | **Optional.** Minimum number of days a certificate has to be valid.
1098 simap_ssl | **Optional.** Use SSL for the connection.
1099 simap_warning | **Optional.** Response time to result in warning status (seconds).
1100 simap_critical | **Optional.** Response time to result in critical status (seconds).
1101 simap_timeout | **Optional.** Seconds before connection times out (default: 10).
1102 simap_ipv4 | **Optional.** Use IPv4 connection. Defaults to false.
1103 simap_ipv6 | **Optional.** Use IPv6 connection. Defaults to false.
1105 ### <a id="plugin-check-command-smart"></a> smart
1107 The [check_ide_smart](https://www.monitoring-plugins.org/doc/man/check_ide_smart.html) plugin
1108 checks a local hard drive with the (Linux specific) SMART interface. Requires installation of `smartctl`.
1110 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
1113 ----------------|--------------
1114 smart_device | **Required.** The name of a local hard drive to monitor.
1117 ### <a id="plugin-check-command-smtp"></a> smtp
1119 The [check_smtp](https://www.monitoring-plugins.org/doc/man/check_smtp.html) plugin
1120 will attempt to open an SMTP connection with the host.
1122 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
1125 ----------------------|--------------
1126 smtp_address | **Optional.** The host's address. Defaults to "$address$" if the host's `address` attribute is set, "$address6$" otherwise.
1127 smtp_port | **Optional.** The port that should be checked. Defaults to 25.
1128 smtp_mail_from | **Optional.** Test a MAIL FROM command with the given email address.
1129 smtp_expect | **Optional.** String to expect in first line of server response (default: '220').
1130 smtp_command | **Optional.** SMTP command (may be used repeatedly).
1131 smtp_response | **Optional.** Expected response to command (may be used repeatedly).
1132 smtp_helo_fqdn | **Optional.** FQDN used for HELO
1133 smtp_certificate_age | **Optional.** Minimum number of days a certificate has to be valid.
1134 smtp_starttls | **Optional.** Use STARTTLS for the connection.
1135 smtp_authtype | **Optional.** SMTP AUTH type to check (default none, only LOGIN supported).
1136 smtp_authuser | **Optional.** SMTP AUTH username.
1137 smtp_authpass | **Optional.** SMTP AUTH password.
1138 smtp_ignore_quit | **Optional.** Ignore failure when sending QUIT command to server.
1139 smtp_warning | **Optional.** Response time to result in warning status (seconds).
1140 smtp_critical | **Optional.** Response time to result in critical status (seconds).
1141 smtp_timeout | **Optional.** Seconds before connection times out (default: 10).
1142 smtp_ipv4 | **Optional.** Use IPv4 connection. Defaults to false.
1143 smtp_ipv6 | **Optional.** Use IPv6 connection. Defaults to false.
1146 ### <a id="plugin-check-command-snmp"></a> snmp
1148 The [check_snmp](https://www.monitoring-plugins.org/doc/man/check_snmp.html) plugin
1149 checks the status of remote machines and obtains system information via SNMP.
1151 **Note**: This plugin uses the `snmpget` command included with the NET-SNMP package.
1153 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
1156 --------------------|--------------
1157 snmp_address | **Optional.** The host's address. Defaults to "$address$" if the host's `address` attribute is set, "$address6$" otherwise.
1158 snmp_oid | **Required.** The SNMP OID.
1159 snmp_community | **Optional.** The SNMP community. Defaults to "public".
1160 snmp_port | **Optional.** The SNMP port. Defaults to "161".
1161 snmp_retries | **Optional.** Number of retries to be used in the SNMP requests.
1162 snmp_warn | **Optional.** The warning threshold.
1163 snmp_crit | **Optional.** The critical threshold.
1164 snmp_string | **Optional.** Return OK state if the string matches exactly with the output value
1165 snmp_ereg | **Optional.** Return OK state if extended regular expression REGEX matches with the output value
1166 snmp_eregi | **Optional.** Return OK state if case-insensitive extended REGEX matches with the output value
1167 snmp_label | **Optional.** Prefix label for output value
1168 snmp_invert_search | **Optional.** Invert search result and return CRITICAL state if found
1169 snmp_units | **Optional.** Units label(s) for output value (e.g., 'sec.').
1170 snmp_version | **Optional.** Version to use. E.g. 1, 2, 2c or 3.
1171 snmp_miblist | **Optional.** MIB's to use, comma separated. Defaults to "ALL".
1172 snmp_rate_multiplier | **Optional.** Converts rate per second. For example, set to 60 to convert to per minute.
1173 snmp_rate | **Optional.** Boolean. Enable rate calculation.
1174 snmp_getnext | **Optional.** Boolean. Use SNMP GETNEXT. Defaults to false.
1175 snmp_timeout | **Optional.** The command timeout in seconds. Defaults to 10 seconds.
1177 ### <a id="plugin-check-command-snmpv3"></a> snmpv3
1179 Check command object for the [check_snmp](https://www.monitoring-plugins.org/doc/man/check_snmp.html)
1180 plugin, using SNMPv3 authentication and encryption options.
1182 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
1185 ---------------------|--------------
1186 snmpv3_address | **Optional.** The host's address. Defaults to "$address$" if the host's `address` attribute is set, "$address6$" otherwise.
1187 snmpv3_getnext | **Optional.** Use SNMP GETNEXT instead of SNMP GET.
1188 snmpv3_seclevel | **Optional.** The security level. Defaults to authPriv.
1189 snmpv3_auth_alg | **Optional.** The authentication algorithm. Defaults to SHA.
1190 snmpv3_user | **Required.** The username to log in with.
1191 snmpv3_auth_key | **Required,** The authentication key. Required if `snmpv3_seclevel` is set to `authPriv` otherwise optional.
1192 snmpv3_priv_key | **Required.** The encryption key.
1193 snmpv3_oid | **Required.** The SNMP OID.
1194 snmpv3_priv_alg | **Optional.** The encryption algorithm. Defaults to AES.
1195 snmpv3_warn | **Optional.** The warning threshold.
1196 snmpv3_crit | **Optional.** The critical threshold.
1197 snmpv3_string | **Optional.** Return OK state (for that OID) if STRING is an exact match.
1198 snmpv3_ereg | **Optional.** Return OK state (for that OID) if extended regular expression REGEX matches.
1199 snmpv3_eregi | **Optional.** Return OK state (for that OID) if case-insensitive extended REGEX matches.
1200 snmpv3_invert_search | **Optional.** Invert search result and return CRITICAL if found
1201 snmpv3_label | **Optional.** Prefix label for output value.
1202 snmpv3_units | **Optional.** Units label(s) for output value (e.g., 'sec.').
1203 snmpv3_rate_multiplier | **Optional.** Converts rate per second. For example, set to 60 to convert to per minute.
1204 snmpv3_rate | **Optional.** Boolean. Enable rate calculation.
1205 snmpv3_timeout | **Optional.** The command timeout in seconds. Defaults to 10 seconds.
1207 ### <a id="plugin-check-command-snmp-uptime"></a> snmp-uptime
1209 Check command object for the [check_snmp](https://www.monitoring-plugins.org/doc/man/check_snmp.html)
1210 plugin, using the uptime OID by default.
1212 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
1215 ----------------|--------------
1216 snmp_address | **Optional.** The host's address. Defaults to "$address$" if the host's `address` attribute is set, "$address6$" otherwise.
1217 snmp_oid | **Optional.** The SNMP OID. Defaults to "1.3.6.1.2.1.1.3.0".
1218 snmp_community | **Optional.** The SNMP community. Defaults to "public".
1221 ### <a id="plugin-check-command-spop"></a> spop
1223 The [check_spop](https://www.monitoring-plugins.org/doc/man/check_spop.html) plugin
1224 tests SPOP connections with the specified host (or unix socket).
1226 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
1229 ----------------------|--------------
1230 spop_address | **Optional.** The host's address. Defaults to "$address$" if the host's `address` attribute is set, "$address6$" otherwise.
1231 spop_port | **Optional.** The port that should be checked. Defaults to 995.
1232 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.
1233 spop_send | **Optional.** String to send to the server.
1234 spop_expect | **Optional.** String to expect in server response. Multiple strings must be defined as array.
1235 spop_all | **Optional.** All expect strings need to occur in server response. Default is any.
1236 spop_quit | **Optional.** String to send server to initiate a clean close of the connection.
1237 spop_refuse | **Optional.** Accept TCP refusals with states ok, warn, crit (default: crit).
1238 spop_mismatch | **Optional.** Accept expected string mismatches with states ok, warn, crit (default: warn).
1239 spop_jail | **Optional.** Hide output from TCP socket.
1240 spop_maxbytes | **Optional.** Close connection once more than this number of bytes are received.
1241 spop_delay | **Optional.** Seconds to wait between sending string and polling for response.
1242 spop_certificate_age | **Optional.** Minimum number of days a certificate has to be valid.
1243 spop_ssl | **Optional.** Use SSL for the connection.
1244 spop_warning | **Optional.** Response time to result in warning status (seconds).
1245 spop_critical | **Optional.** Response time to result in critical status (seconds).
1246 spop_timeout | **Optional.** Seconds before connection times out (default: 10).
1247 spop_ipv4 | **Optional.** Use IPv4 connection. Defaults to false.
1248 spop_ipv6 | **Optional.** Use IPv6 connection. Defaults to false.
1251 ### <a id="plugin-check-command-ssh"></a> ssh
1253 The [check_ssh](https://www.monitoring-plugins.org/doc/man/check_ssh.html) plugin
1254 connects to an SSH server at a specified host and port.
1256 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
1259 ----------------|--------------
1260 ssh_address | **Optional.** The host's address. Defaults to "$address$" if the host's `address` attribute is set, "$address6$" otherwise.
1261 ssh_port | **Optional.** The port that should be checked. Defaults to 22.
1262 ssh_timeout | **Optional.** Seconds before connection times out. Defaults to 10.
1263 ssh_ipv4 | **Optional.** Use IPv4 connection. Defaults to false.
1264 ssh_ipv6 | **Optional.** Use IPv6 connection. Defaults to false.
1267 ### <a id="plugin-check-command-ssl"></a> ssl
1269 Check command object for the [check_tcp](https://www.monitoring-plugins.org/doc/man/check_tcp.html) plugin,
1270 using ssl-related options.
1272 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
1275 ------------------------------|--------------
1276 ssl_address | **Optional.** The host's address. Defaults to "$address$" if the host's `address` attribute is set, "$address6$" otherwise.
1277 ssl_port | **Required.** The port that should be checked.
1278 ssl_timeout | **Optional.** Timeout in seconds for the connect and handshake. The plugin default is 10 seconds.
1279 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.
1280 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.
1281 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$".
1284 ### <a id="plugin-check-command-ssmtp"></a> ssmtp
1286 The [check_ssmtp](https://www.monitoring-plugins.org/doc/man/check_ssmtp.html) plugin
1287 tests SSMTP connections with the specified host (or unix socket).
1289 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
1292 -----------------------|--------------
1293 ssmtp_address | **Optional.** The host's address. Defaults to "$address$" if the host's `address` attribute is set, "$address6$" otherwise.
1294 ssmtp_port | **Optional.** The port that should be checked. Defaults to 465.
1295 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.
1296 ssmtp_send | **Optional.** String to send to the server.
1297 ssmtp_expect | **Optional.** String to expect in server response. Multiple strings must be defined as array.
1298 ssmtp_all | **Optional.** All expect strings need to occur in server response. Default is any.
1299 ssmtp_quit | **Optional.** String to send server to initiate a clean close of the connection.
1300 ssmtp_refuse | **Optional.** Accept TCP refusals with states ok, warn, crit (default: crit).
1301 ssmtp_mismatch | **Optional.** Accept expected string mismatches with states ok, warn, crit (default: warn).
1302 ssmtp_jail | **Optional.** Hide output from TCP socket.
1303 ssmtp_maxbytes | **Optional.** Close connection once more than this number of bytes are received.
1304 ssmtp_delay | **Optional.** Seconds to wait between sending string and polling for response.
1305 ssmtp_certificate_age | **Optional.** Minimum number of days a certificate has to be valid.
1306 ssmtp_ssl | **Optional.** Use SSL for the connection.
1307 ssmtp_warning | **Optional.** Response time to result in warning status (seconds).
1308 ssmtp_critical | **Optional.** Response time to result in critical status (seconds).
1309 ssmtp_timeout | **Optional.** Seconds before connection times out (default: 10).
1310 ssmtp_ipv4 | **Optional.** Use IPv4 connection. Defaults to false.
1311 ssmtp_ipv6 | **Optional.** Use IPv6 connection. Defaults to false.
1314 ### <a id="plugin-check-command-swap"></a> swap
1316 The [check_swap](https://www.monitoring-plugins.org/doc/man/check_swap.html) plugin
1317 checks the swap space on a local machine.
1319 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
1322 ----------------|--------------
1323 swap_wfree | **Optional.** The free swap space warning threshold in % (enable `swap_integer` for number values). Defaults to `50%`.
1324 swap_cfree | **Optional.** The free swap space critical threshold in % (enable `swap_integer` for number values). Defaults to `25%`.
1325 swap_integer | **Optional.** Specifies whether the thresholds are passed as number or percent value. Defaults to false (percent values).
1326 swap_allswaps | **Optional.** Conduct comparisons for all swap partitions, one by one. Defaults to false.
1327 swap_noswap | **Optional.** Resulting state when there is no swap regardless of thresholds. Possible values are "ok", "warning", "critical", "unknown". Defaults to "critical".
1330 ### <a id="plugin-check-command-tcp"></a> tcp
1332 The [check_tcp](https://www.monitoring-plugins.org/doc/man/check_tcp.html) plugin
1333 tests TCP connections with the specified host (or unix socket).
1335 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
1338 ----------------|--------------
1339 tcp_address | **Optional.** The host's address. Defaults to "$address$" if the host's `address` attribute is set, "$address6$" otherwise.
1340 tcp_port | **Required.** The port that should be checked.
1341 tcp_expect | **Optional.** String to expect in server response. Multiple strings must be defined as array.
1342 tcp_all | **Optional.** All expect strings need to occur in server response. Defaults to false.
1343 tcp_escape_send | **Optional.** Enable usage of \\n, \\r, \\t or \\\\ in send string.
1344 tcp_send | **Optional.** String to send to the server.
1345 tcp_escape_quit | **Optional.** Enable usage of \\n, \\r, \\t or \\\\ in quit string.
1346 tcp_quit | **Optional.** String to send server to initiate a clean close of the connection.
1347 tcp_refuse | **Optional.** Accept TCP refusals with states ok, warn, crit. Defaults to crit.
1348 tcp_mismatch | **Optional.** Accept expected string mismatches with states ok, warn, crit. Defaults to warn.
1349 tcp_jail | **Optional.** Hide output from TCP socket.
1350 tcp_maxbytes | **Optional.** Close connection once more than this number of bytes are received.
1351 tcp_delay | **Optional.** Seconds to wait between sending string and polling for response.
1352 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.
1353 tcp_ssl | **Optional.** Use SSL for the connection. Defaults to false.
1354 tcp_wtime | **Optional.** Response time to result in warning status (seconds).
1355 tcp_ctime | **Optional.** Response time to result in critical status (seconds).
1356 tcp_timeout | **Optional.** Seconds before connection times out. Defaults to 10.
1357 tcp_ipv4 | **Optional.** Use IPv4 connection. Defaults to false.
1358 tcp_ipv6 | **Optional.** Use IPv6 connection. Defaults to false.
1361 ### <a id="plugin-check-command-udp"></a> udp
1363 The [check_udp](https://www.monitoring-plugins.org/doc/man/check_udp.html) plugin
1364 tests UDP connections with the specified host (or unix socket).
1366 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
1369 ----------------|--------------
1370 udp_address | **Optional.** The host's address. Defaults to "$address$" if the host's `address` attribute is set, "$address6$" otherwise.
1371 udp_port | **Required.** The port that should be checked.
1372 udp_send | **Required.** The payload to send in the UDP datagram.
1373 udp_expect | **Required.** The payload to expect in the response datagram.
1374 udp_quit | **Optional.** The payload to send to 'close' the session.
1375 udp_ipv4 | **Optional.** Use IPv4 connection. Defaults to false.
1376 udp_ipv6 | **Optional.** Use IPv6 connection. Defaults to false.
1379 ### <a id="plugin-check-command-ups"></a> ups
1381 The [check_ups](https://www.monitoring-plugins.org/doc/man/check_ups.html) plugin
1382 tests the UPS service on the specified host. [Network UPS Tools](http://www.networkupstools.org)
1383 must be running for this plugin to work.
1385 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
1388 ----------------|--------------
1389 ups_address | **Required.** The address of the host running upsd. Defaults to "$address$" if the host's `address` attribute is set, "$address6$" otherwise.
1390 ups_name | **Required.** The UPS name. Defaults to `ups`.
1391 ups_port | **Optional.** The port to which to connect. Defaults to 3493.
1392 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`.
1393 ups_warning | **Optional.** The warning threshold for the selected variable.
1394 ups_critical | **Optional.** The critical threshold for the selected variable.
1395 ups_celsius | **Optional.** Display the temperature in degrees Celsius instead of Fahrenheit. Defaults to `false`.
1396 ups_timeout | **Optional.** The number of seconds before the connection times out. Defaults to 10.
1399 ### <a id="plugin-check-command-users"></a> users
1401 The [check_users](https://www.monitoring-plugins.org/doc/man/check_users.html) plugin
1402 checks the number of users currently logged in on the local system and generates an
1403 error if the number exceeds the thresholds specified.
1405 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
1408 ----------------|--------------
1409 users_wgreater | **Optional.** The user count warning threshold. Defaults to 20.
1410 users_cgreater | **Optional.** The user count critical threshold. Defaults to 50.
1412 ## <a id="windows-plugins"></a> Windows Plugins for Icinga 2
1414 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.
1416 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:
1418 include <windows-plugins>
1420 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.
1423 ### <a id="windows-plugins-thresholds"></a> Threshold syntax
1425 So not specified differently the thresholds for the plugins all follow the same pattern
1428 :------------|:----------
1429 "29" | The threshold is 29.
1430 "!29" | The threshold is 29, but the negative of the result is returned.
1431 "[10-40]" | The threshold is a range from (including) 20 to 40, a value inside means the threshold has been exceeded.
1432 "![10-40]" | Same as above, but the result is inverted.
1435 ### <a id="windows-plugins-disk-windows"></a> disk-windows
1437 Check command object for the `check_disk.exe` plugin.
1438 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.).
1443 :-------------------|:------------
1444 disk\_win\_warn | **Optional**. The warning threshold.
1445 disk\_win\_crit | **Optional**. The critical threshold.
1446 disk\_win\_path | **Optional**. Check only these paths, default checks all.
1447 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.
1448 disk\_win\_exclude | **Optional**. Exclude these drives from check.
1450 ### <a id="windows-plugins-load-windows"></a> load-windows
1452 Check command object for the `check_load.exe` plugin.
1453 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).
1458 :---------------|:------------
1459 load\_win\_warn | **Optional**. The warning threshold.
1460 load\_win\_crit | **Optional**. The critical threshold.
1463 ### <a id="windows-plugins-memory-windows"></a> memory-windows
1465 Check command object for the `check_memory.exe` plugin.
1466 The memory collection is instant.
1470 > Percentage based thresholds can be used by adding a '%' to the threshold
1471 > value. Keep in mind that memory\_win\_unit is applied before the
1472 > value is calculated.
1477 :-----------------|:------------
1478 memory\_win\_warn | **Optional**. The warning threshold.
1479 memory\_win\_crit | **Optional**. The critical threshold.
1480 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.
1483 ### <a id="windows-plugins-network-windows"></a> network-windows
1485 Check command object for the `check_network.exe` plugin.
1486 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).
1491 :-------------------|:------------
1492 network\_win\_warn | **Optional**. The warning threshold.
1493 network\_win\_crit | **Optional**. The critical threshold.
1494 network\_no\_isatap | **Optional**. Do not print ISATAP interfaces.
1497 ### <a id="windows-plugins-perfmon-windows"></a> perfmon-windows
1499 Check command object for the `check_perfmon.exe` plugin.
1500 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`.
1502 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"`
1507 :---------------------|:------------
1508 perfmon\_win\_warn | **Optional**. The warning threshold.
1509 perfmon\_win\_crit | **Optional**. The critical threshold.
1510 perfmon\_win\_counter | **Required**. The Performance Counter to use. Ex. `\Processor(_Total)\% Idle Time`.
1511 perfmon\_win\_wait | **Optional**. Time in milliseconds to wait between data collection (default: 1000).
1512 perfmon\_win\_type | **Optional**. Format in which to expect perfomance values. Possible are: long, int64 and double (default).
1513 perfmon\_win\_syntax | **Optional**. Use this in the performance output instead of `perfmon\_win\_counter`. Exists for graphice compatibility reasons.
1516 ### <a id="windows-plugins-ping-windows"></a> ping-windows
1518 Check command object for the `check_ping.exe` plugin.
1519 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.
1524 :------------------|:------------
1525 ping\_win\_warn | **Optional**. The warning threshold. RTA and package loss separated by comma.
1526 ping\_win\_crit | **Optional**. The critical threshold. RTA and package loss separated by comma.
1527 ping\_win\_address | **Required**. An IPv4 or IPv6 address
1528 ping\_win\_packets | **Optional**. Number of packages to send. Default: 5.
1529 ping\_win\_timeout | **Optional**. The timeout in milliseconds. Default: 1000
1532 ### <a id="windows-plugins-procs-windows"></a> procs-windows
1534 Check command object for `check_procs.exe` plugin.
1535 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.
1540 :----------------|:------------
1541 procs\_win\_warn | **Optional**. The warning threshold.
1542 procs\_win\_crit | **Optional**. The critical threshold.
1543 procs\_win\_user | **Optional**. Count this useres processes.
1546 ### <a id="windows-plugins-service-windows"></a> service-windows
1548 Check command object for `check_service.exe` plugin.
1549 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.
1554 :---------------------|:------------
1555 service\_win\_warn | **Optional**. Warn when service is not running.
1556 service\_win\_service | **Required**. The critical threshold.
1559 ### <a id="windows-plugins-swap-windows"></a> swap-windows
1561 Check command object for `check_swap.exe` plugin.
1562 The data collection is instant.
1567 :---------------|:------------
1568 swap\_win\_warn | **Optional**. The warning threshold.
1569 swap\_win\_crit | **Optional**. The critical threshold.
1570 swap\_win\_unit | **Optional**. The unit to display the received value in, thresholds are interpreted in this unit. Defaults to "mb" (megabyte).
1573 ### <a id="windows-plugins-update-windows"></a> update-windows
1575 Check command object for `check_update.exe` plugin.
1576 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.
1580 > The Network Services Account which runs Icinga 2 by default does not have the required
1581 > permissions to run this check.
1586 :-------------------|:------------
1587 update\_win\_warn | If set, returns warning when important updates are available
1588 update\_win\_crit | If set, return critical when important updates that require a reboot are available.
1589 update\_win\_reboot | Set to treat 'may need update' as 'definitely needs update'
1592 ### <a id="windows-plugins-uptime-windows"></a> uptime-windows
1594 Check command opject for `check_uptime.exe` plugin.
1595 Uses GetTickCount64 to get the uptime, so boot time is not included.
1600 :-----------------|:------------
1601 uptime\_win\_warn | **Optional**. The warning threshold.
1602 uptime\_win\_crit | **Optional**. The critical threshold.
1603 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).
1606 ### <a id="windows-plugins-users-windows"></a> users-windows
1608 Check command object for `check_users.exe` plugin.
1613 :----------------|:------------
1614 users\_win\_warn | **Optional**. The warning threshold.
1615 users\_win\_crit | **Optional**. The critical threshold.
1618 ## <a id="nscp-plugin-check-commands"></a> Plugin Check Commands for NSClient++
1620 Icinga 2 can use the `nscp client` command to run arbitrary NSClient++ checks.
1622 You can enable these check commands by adding the following the include directive in your
1623 [icinga2.conf](4-configuring-icinga-2.md#icinga2-conf) configuration file:
1627 You can also optionally specify an alternative installation directory for NSClient++ by adding
1628 the NscpPath constant in your [constants.conf](4-configuring-icinga-2.md#constants-conf) configuration
1631 const NscpPath = "C:\\Program Files (x86)\\NSClient++"
1633 By default Icinga 2 uses the Microsoft Installer API to determine where NSClient++ is installed. It should
1634 not be necessary to manually set this constant.
1636 Note that it is not necessary to run NSClient++ as a Windows service for these commands to work.
1638 ### <a id="nscp-check-local"></a> nscp-local
1640 Check command object for NSClient++
1642 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
1645 ----------------|--------------
1646 nscp_log_level | **Optional.** The log level. Defaults to "critical".
1647 nscp_load_all | **Optional.** Whether to load all modules. Defaults to false.
1648 nscp_modules | **Optional.** An array of NSClient++ modules to load. Defaults to `[ "CheckSystem" ]`.
1649 nscp_boot | **Optional.** Whether to use the --boot option. Defaults to true.
1650 nscp_query | **Required.** The NSClient++ query. Try `nscp client -q x` for a list.
1651 nscp_arguments | **Optional.** An array of query arguments.
1652 nscp_showall | **Optional.** Shows more details in plugin output, default to false.
1654 ### <a id="nscp-check-local-cpu"></a> nscp-local-cpu
1656 Check command object for the `check_cpu` NSClient++ plugin.
1659 --------------------|------------------
1660 nscp_cpu_time | **Optional.** Calculate avarage usage for the given time intervals. Value has to be an array, default to [ "1m", "5m", "15m" ].
1661 nscp_cpu_warning | **Optional.** Threshold for WARNING state in percent, default to 80.
1662 nscp_cpu_critical | **Optional.** Threshold for CRITICAL state in percent, default to 90.
1663 nscp_cpu_arguments | **Optional.** Additional arguments.
1664 nscp_cpu_showall | **Optional.** Shows more details in plugin output, default to false.
1666 ### <a id="nscp-check-local-memory"></a> nscp-local-memory
1668 Check command object for the `check_memory` NSClient++ plugin.
1671 ----------------------|------------------
1672 nscp_memory_committed | **Optional.** Check for committed memory, default to false.
1673 nscp_memory_physical | **Optional.** Check for physical memory, default to true.
1674 nscp_memory_free | **Optional.** Switch between checking free (true) or used memory (false), default to false.
1675 nscp_memory_warning | **Optional.** Threshold for WARNING state in percent or absolut (use MB, GB, ...), default to 80 (free=false) or 20 (free=true).
1676 nscp_memory_critical | **Optional.** Threshold for CRITICAL state in percent or absolut (use MB, GB, ...), default to 90 (free=false) or 10 (free=true).
1677 nscp_memory_arguments | **Optional.** Additional arguments.
1678 nscp_memory_showall | **Optional.** Shows more details in plugin output, default to false.
1680 ### <a id="nscp-check-local-os-version"></a> nscp-local-os-version
1682 Check command object for the `check_os_version` NSClient++ plugin.
1684 This command has the same custom attributes like the `nscp-local` check command.
1686 ### <a id="nscp-check-local-pagefile"></a> nscp-local-pagefile
1688 Check command object for the `check_pagefile` NSClient++ plugin.
1690 This command has the same custom attributes like the `nscp-local` check command.
1692 ### <a id="nscp-check-local-process"></a> nscp-local-process
1694 Check command object for the `check_process` NSClient++ plugin.
1696 This command has the same custom attributes like the `nscp-local` check command.
1698 ### <a id="nscp-check-local-service"></a> nscp-local-service
1700 Check command object for the `check_service` NSClient++ plugin.
1703 -----------------------|------------------
1704 nscp_service_name | **Required.** Name of service to check.
1705 nscp_service_type | **Optional.** Type to check, default to state.
1706 nscp_service_ok | **Optional.** State for return an OK, i.e. for type=state running, stopped, ...
1707 nscp_service_otype | **Optional.** Dedicate type for nscp_service_ok, default to nscp_service_state.
1708 nscp_service_warning | **Optional.** State for return an WARNING.
1709 nscp_service_wtype | **Optional.** Dedicate type for nscp_service_warning, default to nscp_service_state.
1710 nscp_service_critical | **Optional.** State for return an CRITICAL.
1711 nscp_service_ctype | **Optional.** Dedicate type for nscp_service_critical, default to nscp_service_state.
1712 nscp_service_arguments | **Optional.** Additional arguments.
1713 nscp_service_showall | **Optional.** Shows more details in plugin output, default to true.
1715 ### <a id="nscp-check-local-uptime"></a> nscp-local-uptime
1717 Check command object for the `check_uptime` NSClient++ plugin.
1719 This command has the same custom attributes like the `nscp-local` check command.
1721 ### <a id="nscp-check-local-version"></a> nscp-local-version
1723 Check command object for the `check_version` NSClient++ plugin.
1725 This command has the same custom attributes like the `nscp-local` check command.
1726 In addition to that the default value for `nscp_modules` is set to `[ "CheckHelpers" ]`.
1728 ### <a id="nscp-check-local-disk"></a> nscp-local-disk
1730 Check command object for the `check_drivesize` NSClient++ plugin.
1733 -----------------------|------------------
1734 nscp_disk_drive | **Optional.** Drive character, default to all drives.
1735 nscp_disk_free | **Optional.** Switch between checking free space (free=true) or used space (free=false), default to false.
1736 nscp_disk_warning | **Optional.** Threshold for WARNING in percent or absolut (use MB, GB, ...), default to 80 (used) or 20 percent (free).
1737 nscp_disk_critical | **Optional.** Threshold for CRITICAL in percent or absolut (use MB, GB, ...), default to 90 (used) or 10 percent (free).
1738 nscp_disk_arguments | **Optional.** Additional arguments.
1739 nscp_disk_showall | **Optional.** Shows more details in plugin output, default to true.
1740 nscp_modules | **Optional.** An array of NSClient++ modules to load. Defaults to `[ "CheckDisk" ]`.
1742 ### <a id="nscp-check-local-counter"></a> nscp-local-counter
1744 Check command object for the `check_pdh` NSClient++ plugin.
1747 -----------------------|------------------
1748 nscp_counter_name | **Required.** Performance counter name.
1749 nscp_counter_warning | **Optional.** WARNING Threshold.
1750 nscp_counter_critical | **Optional.** CRITICAL Threshold.
1751 nscp_counter_arguments | **Optional.** Additional arguments.
1752 nscp_counter_showall | **Optional.** Shows more details in plugin output, default to false.
1753 nscp_counter_perfsyntax | **Optional.** Apply performance data label, e.g. `Total Processor Time` to avoid special character problems. Defaults to `nscp_counter_name`.
1757 ## <a id="snmp-manubulon-plugin-check-commands"></a> Plugin Check Commands for Manubulon SNMP
1759 The `SNMP Manubulon Plugin Check Commands` provide configuration for plugin check
1760 commands provided by the [SNMP Manubulon project](http://nagios.manubulon.com/index_snmp.html).
1762 **Note:** Some plugin parameters are only available in Debian packages or in a
1763 [forked repository](https://github.com/dnsmichi/manubulon-snmp) with patches applied.
1765 The SNMP manubulon plugin check commands assume that the global constant named `ManubulonPluginDir`
1766 is set to the path where the Manubublon SNMP plugins are installed.
1768 You can enable these plugin check commands by adding the following the include directive in your
1769 [icinga2.conf](4-configuring-icinga-2.md#icinga2-conf) configuration file:
1773 ### Checks by Host Type
1775 **N/A** : Not available for this type.
1777 **SNMP** : Available for simple SNMP query.
1781 **Specific** : Script name for platform specific checks.
1784 Host type | Interface | storage | load/cpu | mem | process | env | specific
1785 ------------------------|------------|----------|-----------|-----|----------|-----|-------------------------
1786 Linux | Yes | Yes | Yes | Yes | Yes | No |
1787 Windows | Yes | Yes | Yes | Yes | Yes | No | check_snmp_win.pl
1788 Cisco router/switch | Yes | N/A | Yes | Yes | N/A | Yes |
1789 HP router/switch | Yes | N/A | Yes | Yes | N/A | No |
1790 Bluecoat proxy | Yes | SNMP | Yes | SNMP| No | Yes |
1791 CheckPoint on SPLAT | Yes | Yes | Yes | Yes | Yes | No | check_snmp_cpfw.pl
1792 CheckPoint on Nokia IP | Yes | Yes | Yes | No | ?? | No | check_snmp_vrrp.pl
1793 Boostedge | Yes | Yes | Yes | Yes | ?? | No | check_snmp_boostedge.pl
1794 AS400 | Yes | Yes | Yes | Yes | No | No |
1795 NetsecureOne Netbox | Yes | Yes | Yes | ?? | Yes | No |
1796 Radware Linkproof | Yes | N/A | SNMP | SNMP| No | No | check_snmp_linkproof_nhr <br> check_snmp_vrrp.pl
1797 IronPort | Yes | SNMP | SNMP | SNMP| No | Yes |
1798 Cisco CSS | Yes | ?? | Yes | Yes | No | ?? | check_snmp_css.pl
1801 ### <a id="plugin-check-command-snmp-load"></a> snmp-load
1803 Check command object for the [check_snmp_load.pl](http://nagios.manubulon.com/snmp_load.html) plugin.
1805 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
1809 ------------------------|--------------
1810 snmp_address | **Optional.** The host's address. Defaults to "$address$" if the host's `address` attribute is set, "$address6$" otherwise.
1811 snmp_nocrypt | **Optional.** Define SNMP encryption. If set, **snmp_v3** needs to be set. Defaults to false.
1812 snmp_community | **Optional.** The SNMP community. Defaults to "public".
1813 snmp_port | **Optional.** The SNMP port connection.
1814 snmp_v2 | **Optional.** SNMP version to 2c. Defaults to false.
1815 snmp_v3 | **Optional.** SNMP version to 3. Defaults to false.
1816 snmp_login | **Optional.** SNMP version 3 username. Defaults to "snmpuser".
1817 snmp_password | **Required.** SNMP version 3 password. No value defined as default.
1818 snmp_v3_use_privpass | **Optional.** Define to use SNMP version 3 priv password. Defaults to false.
1819 snmp_v3_use_authprotocol| **Optional.** Define to use SNMP version 3 authentication protocol. Defaults to false.
1820 snmp_authprotocol | **Optional.** SNMP version 3 authentication protocol. Defaults to "md5,des".
1821 snmp_privpass | **Required.** SNMP version 3 priv password. No value defined as default.
1822 snmp_warn | **Optional.** The warning threshold. Change the `snmp_load_type` var to "netsl" for using 3 values.
1823 snmp_crit | **Optional.** The critical threshold. Change the `snmp_load_type` var to "netsl" for using 3 values.
1824 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.
1825 snmp_perf | **Optional.** Enable perfdata values. Defaults to true.
1826 snmp_timeout | **Optional.** The command timeout in seconds. Defaults to 5 seconds.
1828 ### <a id="plugin-check-command-snmp-memory"></a> snmp-memory
1830 Check command object for the [check_snmp_mem.pl](http://nagios.manubulon.com/snmp_mem.html) plugin.
1832 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
1835 ------------------------|--------------
1836 snmp_address | **Optional.** The host's address. Defaults to "$address$" if the host's `address` attribute is set, "$address6$" otherwise.
1837 snmp_nocrypt | **Optional.** Define SNMP encryption. If set, **snmp_v3** needs to be set. Defaults to false.
1838 snmp_community | **Optional.** The SNMP community. Defaults to "public".
1839 snmp_port | **Optional.** The SNMP port connection.
1840 snmp_v2 | **Optional.** SNMP version to 2c. Defaults to false.
1841 snmp_v3 | **Optional.** SNMP version to 3. Defaults to false.
1842 snmp_login | **Optional.** SNMP version 3 username. Defaults to "snmpuser".
1843 snmp_password | **Required.** SNMP version 3 password. No value defined as default.
1844 snmp_v3_use_privpass | **Optional.** Define to use SNMP version 3 priv password. Defaults to false.
1845 snmp_v3_use_authprotocol| **Optional.** Define to use SNMP version 3 authentication protocol. Defaults to false.
1846 snmp_authprotocol | **Optional.** SNMP version 3 authentication protocol. Defaults to "md5,des".
1847 snmp_privpass | **Required.** SNMP version 3 priv password. No value defined as default.
1848 snmp_warn | **Optional.** The warning threshold.
1849 snmp_crit | **Optional.** The critical threshold.
1850 snmp_is_cisco | **Optional.** Change OIDs for Cisco switches. Defaults to false.
1851 snmp_is_hp | **Optional.** Change OIDs for HP/Procurve switches. Defaults to false.
1852 snmp_perf | **Optional.** Enable perfdata values. Defaults to true.
1853 snmp_timeout | **Optional.** The command timeout in seconds. Defaults to 5 seconds.
1855 ### <a id="plugin-check-command-snmp-storage"></a> snmp-storage
1857 Check command object for the [check_snmp_storage.pl](http://nagios.manubulon.com/snmp_storage.html) plugin.
1859 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
1862 ------------------------|--------------
1863 snmp_address | **Optional.** The host's address. Defaults to "$address$" if the host's `address` attribute is set, "$address6$" otherwise.
1864 snmp_nocrypt | **Optional.** Define SNMP encryption. If set, **snmp_v3** needs to be set. Defaults to false.
1865 snmp_community | **Optional.** The SNMP community. Defaults to "public".
1866 snmp_port | **Optional.** The SNMP port connection.
1867 snmp_v2 | **Optional.** SNMP version to 2c. Defaults to false.
1868 snmp_v3 | **Optional.** SNMP version to 3. Defaults to false.
1869 snmp_login | **Optional.** SNMP version 3 username. Defaults to "snmpuser".
1870 snmp_password | **Required.** SNMP version 3 password. No value defined as default.
1871 snmp_v3_use_privpass | **Optional.** Define to use SNMP version 3 priv password. Defaults to false.
1872 snmp_v3_use_authprotocol| **Optional.** Define to use SNMP version 3 authentication protocol. Defaults to false.
1873 snmp_authprotocol | **Optional.** SNMP version 3 authentication protocol. Defaults to "md5,des".
1874 snmp_privpass | **Required.** SNMP version 3 priv password. No value defined as default.
1875 snmp_warn | **Optional.** The warning threshold.
1876 snmp_crit | **Optional.** The critical threshold.
1877 snmp_storage_name | **Optional.** Storage name. Default to regex "^/$$". More options available in the [snmp storage](http://nagios.manubulon.com/snmp_storage.html) documentation.
1878 snmp_perf | **Optional.** Enable perfdata values. Defaults to true.
1879 snmp_timeout | **Optional.** The command timeout in seconds. Defaults to 5 seconds.
1881 ### <a id="plugin-check-command-snmp-interface"></a> snmp-interface
1883 Check command object for the [check_snmp_int.pl](http://nagios.manubulon.com/snmp_int.html) plugin.
1885 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
1888 ----------------------------|--------------
1889 snmp_address | **Optional.** The host's address. Defaults to "$address$" if the host's `address` attribute is set, "$address6$" otherwise.
1890 snmp_nocrypt | **Optional.** Define SNMP encryption. If set, **snmp_v3** needs to be set. Defaults to false.
1891 snmp_community | **Optional.** The SNMP community. Defaults to "public".
1892 snmp_port | **Optional.** The SNMP port connection.
1893 snmp_v2 | **Optional.** SNMP version to 2c. Defaults to false.
1894 snmp_v3 | **Optional.** SNMP version to 3. Defaults to false.
1895 snmp_login | **Optional.** SNMP version 3 username. Defaults to "snmpuser".
1896 snmp_password | **Required.** SNMP version 3 password. No value defined as default.
1897 snmp_v3_use_privpass | **Optional.** Define to use SNMP version 3 priv password. Defaults to false.
1898 snmp_v3_use_authprotocol | **Optional.** Define to use SNMP version 3 authentication protocol. Defaults to false.
1899 snmp_authprotocol | **Optional.** SNMP version 3 authentication protocol. Defaults to "md5,des".
1900 snmp_privpass | **Required.** SNMP version 3 priv password. No value defined as default.
1901 snmp_warn | **Optional.** The warning threshold.
1902 snmp_crit | **Optional.** The critical threshold.
1903 snmp_interface | **Optional.** Network interface name. Default to regex "eth0".
1904 snmp_interface_inverse | **Optional.** Inverse Interface check, down is ok. Defaults to false as it is missing.
1905 snmp_interface_perf | **Optional.** Check the input/ouput bandwidth of the interface. Defaults to true.
1906 snmp_interface_label | **Optional.** Add label before speed in output: in=, out=, errors-out=, etc.
1907 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.
1908 snmp_interface_percent | **Optional.** Output performance data in % of max speed. Defaults to false.
1909 snmp_interface_kbits | **Optional.** Make the warning and critical levels in KBits/s. Defaults to true.
1910 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.
1911 snmp_interface_64bit | **Optional.** Use 64 bits counters instead of the standard counters when checking bandwidth & performance data for interface >= 1Gbps. Defaults to false.
1912 snmp_interface_errors | **Optional.** Add error & discard to Perfparse output. Defaults to true.
1913 snmp_interface_noregexp | **Optional.** Do not use regexp to match interface name in description OID. Defaults to false.
1914 snmp_interface_delta | **Optional.** Delta time of perfcheck. Defaults to "300" (5 min).
1915 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.
1916 snmp_interface_ifname | **Optional.** Switch from IF-MIB::ifDescr to IF-MIB::ifName when looking up the interface's name.
1917 snmp_interface_ifalias | **Optional.** Switch from IF-MIB::ifDescr to IF-MIB::ifAlias when looking up the interface's name.
1918 snmp_perf | **Optional.** Enable perfdata values. Defaults to true.
1919 snmp_timeout | **Optional.** The command timeout in seconds. Defaults to 5 seconds.
1921 ### <a id="plugin-check-command-snmp-process"></a> snmp-process
1923 Check command object for the [check_snmp_process.pl](http://nagios.manubulon.com/snmp_process.html) plugin.
1925 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
1928 ------------------------|--------------
1929 snmp_address | **Optional.** The host's address. Defaults to "$address$" if the host's `address` attribute is set, "$address6$" otherwise.
1930 snmp_nocrypt | **Optional.** Define SNMP encryption. If set, **snmp_v3** needs to be set. Defaults to false.
1931 snmp_community | **Optional.** The SNMP community. Defaults to "public".
1932 snmp_port | **Optional.** The SNMP port connection.
1933 snmp_v2 | **Optional.** SNMP version to 2c. Defaults to false.
1934 snmp_v3 | **Optional.** SNMP version to 3. Defaults to false.
1935 snmp_login | **Optional.** SNMP version 3 username. Defaults to "snmpuser".
1936 snmp_password | **Required.** SNMP version 3 password. No value defined as default.
1937 snmp_v3_use_privpass | **Optional.** Define to use SNMP version 3 priv password. Defaults to false.
1938 snmp_v3_use_authprotocol| **Optional.** Define to use SNMP version 3 authentication protocol. Defaults to false.
1939 snmp_authprotocol | **Optional.** SNMP version 3 authentication protocol. Defaults to "md5,des".
1940 snmp_privpass | **Required.** SNMP version 3 priv password. No value defined as default..
1941 snmp_warn | **Optional.** The warning threshold.
1942 snmp_crit | **Optional.** The critical threshold.
1943 snmp_process_name | **Optional.** Name of the process (regexp). No trailing slash!. Defaults to ".*".
1944 snmp_perf | **Optional.** Enable perfdata values. Defaults to true.
1945 snmp_timeout | **Optional.** The command timeout in seconds. Defaults to 5 seconds.
1946 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.
1950 ## <a id="plugin-contrib"></a> Contributed Plugin Check Commands
1952 The contributed Plugin Check Commands provides various additional command definitions
1953 contributed by community members.
1955 These check commands assume that the global constant named `PluginContribDir`
1956 is set to the path where the user installs custom plugins and can be enabled by
1957 uncommenting the corresponding line in [icinga2.conf](4-configuring-icinga-2.md#icinga2-conf):
1959 include <plugin-contrib>
1961 ### <a id="plugin-contrib-databases"></a> Databases
1963 All database plugins go in this category.
1965 #### <a id="plugin-contrib-command-db2_health"></a> db2_health
1967 The plugin `db2_health` utilises Perl DBD::DB2.
1968 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).
1970 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
1973 ---------------------------------|------------------------------------------------------------------------------------------------------------------------------
1974 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)
1975 db2_health_username | **Optional.** The username for the database connection.
1976 db2_health_password | **Optional.** The password for the database connection.
1977 db2_health_port | **Optional.** The port where DB2 is listening.
1978 db2_health_warning | **Optional.** The warning threshold depending on the mode.
1979 db2_health_critical | **Optional.** The critical threshold depending on the mode.
1980 db2_health_mode | **Required.** The mode uses predefined keywords for the different checks. For example "connection-time", "database-usage" or "sql".
1981 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).
1982 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.
1983 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.
1984 db2_health_regexp | **Optional.** If set to true, "db2_health_name" will be interpreted as a regular expression. Defaults to false.
1985 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".
1986 db2_health_maxinactivity | **Optional.** Used for the maximum amount of time a certain event has not happened.
1987 db2_health_mitigation | **Optional.** Classifies the severity of an offline tablespace.
1988 db2_health_lookback | **Optional.** How many days in the past db2_health check should look back to calculate exitcode.
1989 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".
1990 db2_health_env_db2_version | **Optional.** Specifies the DB2 version as environment variable `DB2_VERSION`.
1992 #### <a id="plugin-contrib-command-mssql_health"></a> mssql_health
1994 The plugin `mssql_health` utilises Perl DBD::Sybase based on FreeTDS to connect to MSSQL databases for monitoring.
1995 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).
1997 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
2000 ---------------------------------|------------------------------------------------------------------------------------------------------------------------------
2001 mssql_health_hostname | **Optional.** Specifies the database hostname or address. No default because you typically use "mssql_health_server".
2002 mssql_health_port | **Optional.** Specifies the database port. No default because you typically use "mssql_health_server".
2003 mssql_health_server | **Optional.** The name of a predefined connection (in freetds.conf).
2004 mssql_health_currentdb | **Optional.** The name of a database which is used as the current database for the connection.
2005 mssql_health_username | **Optional.** The username for the database connection.
2006 mssql_health_password | **Optional.** The password for the database connection.
2007 mssql_health_warning | **Optional.** The warning threshold depending on the mode.
2008 mssql_health_critical | **Optional.** The critical threshold depending on the mode.
2009 mssql_health_mode | **Required.** The mode uses predefined keywords for the different checks. For example "connection-time", "database-free" or "sql".
2010 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).
2011 mssql_health_name | **Optional.** Depending on the mode this could be the database name or a SQL statement.
2012 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.
2013 mssql_health_regexp | **Optional.** If set to true, "mssql_health_name" will be interpreted as a regular expression. Defaults to false.
2014 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".
2015 mssql_health_offlineok | **Optional.** Set this to true if offline databases are perfectly ok for you. Defaults to false.
2016 mssql_health_commit | **Optional.** Set this to true to turn on autocommit for the dbd::sybase module. Defaults to false.
2018 #### <a id="plugin-contrib-command-mysql_health"></a> mysql_health
2020 The plugin `mysql_health` utilises Perl DBD::MySQL to connect to MySQL databases for monitoring.
2021 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).
2023 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
2026 ---------------------------------|------------------------------------------------------------------------------------------------------------------------------
2027 mysql_health_hostname | **Required.** Specifies the database hostname or address. Defaults to "$address$" or "$address6$" if the `address` attribute is not set.
2028 mysql_health_port | **Optional.** Specifies the database port. Defaults to 3306 (or 1186 for "mysql_health_mode" cluster).
2029 mysql_health_socket | **Optional.** Specifies the database unix socket. No default.
2030 mysql_health_username | **Optional.** The username for the database connection.
2031 mysql_health_password | **Optional.** The password for the database connection.
2032 mysql_health_database | **Optional.** The database to connect to. Defaults to information_schema.
2033 mysql_health_warning | **Optional.** The warning threshold depending on the mode.
2034 mysql_health_critical | **Optional.** The critical threshold depending on the mode.
2035 mysql_health_warningx | **Optional.** The extended warning thresholds depending on the mode.
2036 mysql_health_criticalx | **Optional.** The extended critical thresholds depending on the mode.
2037 mysql_health_mode | **Required.** The mode uses predefined keywords for the different checks. For example "connection-time", "slave-lag" or "sql".
2038 mysql_health_method | **Optional.** How the plugin should connect to the database (`dbi` for using DBD::Mysql (default), `mysql` for using the mysql-Tool).
2039 mysql_health_commit | **Optional.** Turns on autocommit for the dbd::* module.
2040 mysql_health_notemp | **Optional.** Ignore temporary databases/tablespaces.
2041 mysql_health_nooffline | **Optional.** Skip the offline databases.
2042 mysql_health_regexp | **Optional.** Parameter name/name2/name3 will be interpreted as (perl) regular expression.
2043 mysql_health_name | **Optional.** The name of a specific component to check.
2044 mysql_health_name2 | **Optional.** The secondary name of a component.
2045 mysql_health_name3 | **Optional.** The tertiary name of a component.
2046 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".
2047 mysql_health_labelformat | **Optional.** One of those formats pnp4nagios or groundwork. Defaults to pnp4nagios.
2048 mysql_health_extraopts | **Optional.** Read command line arguments from an external file.
2049 mysql_health_blacklist | **Optional.** Blacklist some (missing/failed) components"
2050 mysql_health_mitigation | **Optional.** "The parameter allows you to change a critical error to a warning."
2051 mysql_health_lookback | **Optional.** The amount of time you want to look back when calculating average rates."
2052 mysql_health_environment | **Optional.** Add a variable to the plugin's environment."
2053 mysql_health_morphmessage | **Optional.** Modify the final output message."
2054 mysql_health_morphperfdata | **Optional.** The parameter allows you to change performance data labels."
2055 mysql_health_selectedperfdata | **Optional.** The parameter allows you to limit the list of performance data."
2056 mysql_health_report | **Optional.** Can be used to shorten the output."
2057 mysql_health_multiline | **Optional.** Multiline output."
2058 mysql_health_negate | **Optional.** Emulate the negate plugin. --negate warning=critical --negate unknown=critical."
2059 mysql_health_withmymodulesdyndir | **Optional.** Add-on modules for the my-modes will be searched in this directory."
2060 mysql_health_statefilesdir | **Optional.** An alternate directory where the plugin can save files."
2061 mysql_health_isvalidtime | **Optional.** Signals the plugin to return OK if now is not a valid check time."
2062 mysql_health_timeout | **Optional.** Plugin timeout. Defaults to 60s.
2064 #### <a id="plugin-contrib-command-oracle_health"></a> oracle_health
2066 The plugin `oracle_health` utilises Perl DBD::Oracle based on oracle-instantclient-sdk or sqlplus to connect to Oracle databases for monitoring.
2067 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).
2069 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
2072 ---------------------------------|------------------------------------------------------------------------------------------------------------------------------
2073 oracle_health_connect | **Required.** Specifies the database connection string (from tnsnames.ora).
2074 oracle_health_username | **Optional.** The username for the database connection.
2075 oracle_health_password | **Optional.** The password for the database connection.
2076 oracle_health_warning | **Optional.** The warning threshold depending on the mode.
2077 oracle_health_critical | **Optional.** The critical threshold depending on the mode.
2078 oracle_health_mode | **Required.** The mode uses predefined keywords for the different checks. For example "connection-time", "flash-recovery-area-usage" or "sql".
2079 oracle_health_method | **Optional.** How the plugin should connect to the database (`dbi` for using DBD::Oracle (default), `sqlplus` for using the sqlplus-Tool).
2080 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.
2081 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.
2082 oracle_health_regexp | **Optional.** If set to true, "oracle_health_name" will be interpreted as a regular expression. Defaults to false.
2083 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".
2084 oracle_health_ident | **Optional.** If set to true, outputs instance and database names. Defaults to false.
2085 oracle_health_commit | **Optional.** Set this to true to turn on autocommit for the dbd::oracle module. Defaults to false.
2086 oracle_health_noperfdata | **Optional.** Set this to true if you want to disable perfdata. Defaults to false.
2087 oracle_health_timeout | **Optional.** Plugin timeout. Defaults to 60s.
2088 oracle_health_report | **Optional.** Select the plugin output format. Can be short or long. Default to long.
2093 --------------------|------------------------------------------------------------------------------------------------------------------------------------------
2094 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".
2095 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".
2097 #### <a id="plugin-contrib-command-postgres"></a> postgres
2099 The plugin `postgres` utilises the psql binary to connect to PostgreSQL databases for monitoring.
2100 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).
2102 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
2105 ---------------------------------|------------------------------------------------------------------------------------------------------------------------------
2106 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.
2107 postgres_port | **Optional.** Specifies the database port. Defaults to 5432.
2108 postgres_dbname | **Optional.** Specifies the database name to connect to. Defaults to "postgres" or "template1".
2109 postgres_dbuser | **Optional.** The username for the database connection. Defaults to "postgres".
2110 postgres_dbpass | **Optional.** The password for the database connection. You can use a .pgpass file instead.
2111 postgres_dbservice | **Optional.** Specifies the service name to use inside of pg_service.conf.
2112 postgres_warning | **Optional.** Specifies the warning threshold, range depends on the action.
2113 postgres_critical | **Optional.** Specifies the critical threshold, range depends on the action.
2114 postgres_include | **Optional.** Specifies name(s) items to specifically include (e.g. tables), depends on the action.
2115 postgres_exclude | **Optional.** Specifies name(s) items to specifically exclude (e.g. tables), depends on the action.
2116 postgres_includeuser | **Optional.** Include objects owned by certain users.
2117 postgres_excludeuser | **Optional.** Exclude objects owned by certain users.
2118 postgres_standby | **Optional.** Assume that the server is in continious WAL recovery mode if set to true. Defaults to false.
2119 postgres_production | **Optional.** Assume that the server is in production mode if set to true. Defaults to false.
2120 postgres_action | **Required.** Determines the test executed.
2121 postgres_unixsocket | **Optional.** If "postgres_unixsocket" is set to true, the unix socket is used instead of an address. Defaults to false.
2122 postgres_query | **Optional.** Query for "custom_query" action.
2123 postgres_valtype | **Optional.** Value type of query result for "custom_query".
2124 postgres_reverse | **Optional.** If "postgres_reverse" is set, warning and critical values are reversed for "custom_query" action.
2125 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).
2127 #### <a id="plugin-contrib-command-mongodb"></a> mongodb
2129 The plugin `mongodb` utilises Python PyMongo.
2130 For development check [https://github.com](https://github.com/mzupan/nagios-plugin-mongodb).
2132 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
2135 ---------------------------------|------------------------------------------------------------------------------------------------------------------------------
2136 mongodb_host | **Required.** Specifies the hostname or address.
2137 mongodb_port | **Required.** The port mongodb is runnung on.
2138 mongodb_user | **Optional.** The username you want to login as
2139 mongodb_passwd | **Optional.** The password you want to use for that user
2140 mongodb_warning | **Optional.** The warning threshold we want to set
2141 mongodb_critical | **Optional.** The critical threshold we want to set
2142 mongodb_action | **Required.** The action you want to take
2143 mongodb_maxlag | **Optional.** Get max replication lag (for replication_lag action only)
2144 mongodb_mappedmemory | **Optional.** Get mapped memory instead of resident (if resident memory can not be read)
2145 mongodb_perfdata | **Optional.** Enable output of Nagios performance data
2146 mongodb_database | **Optional.** Specify the database to check
2147 mongodb_alldatabases | **Optional.** Check all databases (action database_size)
2148 mongodb_ssl | **Optional.** Connect using SSL
2149 mongodb_replicaset | **Optional.** Connect to replicaset
2150 mongodb_replcheck | **Optional.** If set to true, will enable the mongodb_replicaset value needed for "replica_primary" check
2151 mongodb_querytype | **Optional.** The query type to check [query\|insert\|update\|delete\|getmore\|command] from queries_per_second
2152 mongodb_collection | **Optional.** Specify the collection to check
2153 mongodb_sampletime | **Optional.** Time used to sample number of pages faults
2155 #### <a id="plugin-contrib-command-elasticsearch"></a> elasticsearch
2157 An [ElasticSearch](https://www.elastic.co/products/elasticsearch) availability
2158 and performance monitoring plugin available for download at [GitHub](https://github.com/anchor/nagios-plugin-elasticsearch).
2159 The plugin requires the HTTP API enabled on your ElasticSearch node.
2162 -----------------------------|-------------------------------------------------------------------------------------------------------
2163 elasticsearch_failuredomain | **Optional.** A comma-separated list of ElasticSearch attributes that make up your cluster's failure domain.
2164 elasticsearch_host | **Optional.** Hostname or network address to probe. Defaults to 'localhost'.
2165 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.
2166 elasticsearch_port | **Optional.** TCP port to probe. The ElasticSearch API should be listening here. Defaults to 9200.
2167 elasticsearch_prefix | **Optional.** Optional prefix (e.g. 'es') for the ElasticSearch API. Defaults to ''.
2168 elasticsearch_yellowcritical | **Optional.** Instead of issuing a 'warning' for a yellow cluster state, issue a 'critical' alert. Defaults to false.
2170 #### <a id="plugin-contrib-command-redis"></a> redis
2172 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).
2173 It is provided by `William Leibzon` at [https://github.com](https://github.com/willixix/naglio-plugins/blob/master/check_redis.pl).
2176 -------------------------|--------------------------------------------------------------------------------------------------------------
2177 redis_hostname | **Required.** Hostname or IP Address to check. Defaults to "127.0.0.1".
2178 redis_port | **Optional.** Port number to query. Default to "6379".
2179 redis_database | **Optional.** Database name (usually a number) to query, needed for **redis_query**.
2180 redis_password | **Optional.** Password for Redis authentication. Safer alternative is to put them in a file and use **redis_credentials**.
2181 redis_credentials | **Optional.** Credentials file to read for Redis authentication.
2182 redis_timeout | **Optional.** Allows to set timeout for execution of this plugin.
2183 redis_variables | **Optional.** List of variables from info data to do threshold checks on.
2184 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.
2185 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.
2186 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.
2187 redis_perfvars | **Optional.** This allows to list variables which values will go only into perfparse output (and not for threshold checking).
2188 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.
2189 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".
2190 redis_query | **Optional.** Option specifies key to query and optional variable name to assign the results to after.
2191 redis_option | **Optional.** Specifiers are separated by "," and must include NAME or PATTERN.
2192 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.
2193 redis_hitrate | **Optional.** Calculates Hitrate and specify values are interpreted as WARNING and CRITICAL thresholds.
2194 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.
2195 redis_total_memory | **Optional.** Amount of memory on a system for memory utilization calculation. Use system memory or max_memory setting of redis.
2196 redis_replication_delay | **Optional.** Allows to set threshold on replication delay info.
2199 ### <a id="plugin-contrib-hardware"></a> Hardware
2201 This category includes all plugins for various hardware checks.
2203 #### <a id="plugin-contrib-command-hpasm"></a> hpasm
2205 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.
2207 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
2210 --------------------------------|-----------------------------------------------------------------------
2211 hpasm_hostname | **Optional.** The host's address. Defaults to "$address$" if the host's `address` attribute is set, "$address6$" otherwise.
2212 hpasm_community | **Optional.** SNMP community of the server (SNMP v1/2 only).
2213 hpasm_protocol | **Optional.** The SNMP protocol to use (default: 2c, other possibilities: 1,3).
2214 hpasm_port | **Optional.** The SNMP port to use (default: 161).
2215 hpasm_blacklist | **Optional.** Blacklist some (missing/failed) components.
2216 hpasm_ignore-dimms | **Optional.** Ignore "N/A"-DIMM status on misc. servers (e.g. older DL320).
2217 hpasm_ignore-fan-redundancy | **Optional.** Ignore missing redundancy partners.
2218 hpasm_customthresholds | **Optional.** Use custom thresholds for certain temperatures.
2219 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.
2220 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.
2221 hpasm_username | **Optional.** The securityName for the USM security model (SNMPv3 only).
2222 hpasm_authpassword | **Optional.** The authentication password for SNMPv3.
2223 hpasm_authprotocol | **Optional.** The authentication protocol for SNMPv3 (md5\|sha).
2224 hpasm_privpassword | **Optional.** The password for authPriv security level.
2225 hpasm_privprotocol | **Optional.** The private protocol for SNMPv3 (des\|aes\|aes128\|3des\|3desde).
2226 hpasm_servertype | **Optional.** The type of the server: proliant (default) or bladesystem.
2227 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.
2230 ### <a id="plugin-contrib-icingacli"></a> IcingaCLI
2232 This category includes all plugins using the icingacli provided by Icinga Web 2.
2234 #### <a id="plugin-contrib-icingacli-businessprocess"></a> Business Process
2236 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).
2238 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
2241 ------------------------------------------|-----------------------------------------------------------------------------------------
2242 icingacli_businessprocess_process | **Required.** Business process to monitor.
2243 icingacli_businessprocess_config | **Optional.** Configuration file containing your business process without file extension.
2244 icingacli_businessprocess_details | **Optional.** Get details for root cause analyses. Defaults to false.
2247 ### <a id="plugin-contrib-ipmi"></a> IPMI Devices
2249 This category includes all plugins for IPMI devices.
2251 #### <a id="plugin-contrib-command-ipmi-sensor"></a> ipmi-sensor
2253 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.
2255 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
2258 ---------------------------------|-----------------------------------------------------------------------------------------------------
2259 ipmi_address | **Required.** Specifies the remote host (IPMI device) to check. Defaults to "$address$".
2260 ipmi_config_file | **Optional.** Path to the FreeIPMI configuration file. It should contain IPMI username, IPMI password, and IPMI privilege-level.
2261 ipmi_username | **Optional.** The IPMI username.
2262 ipmi_password | **Optional.** The IPMI password.
2263 ipmi_privilege_level | **Optional.** The IPMI privilege level of the IPMI user.
2264 ipmi_backward_compatibility_mode | **Optional.** Enable backward compatibility mode, useful for FreeIPMI 0.5.\* (this omits FreeIPMI options "--quiet-cache" and "--sdr-cache-recreate").
2265 ipmi_sensor_type | **Optional.** Limit sensors to query based on IPMI sensor type. Examples for IPMI sensor types are 'Fan', 'Temperature' and 'Voltage'.
2266 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.
2267 ipmi_exclude_sensor_id | **Optional.** Exclude sensor matching ipmi_sensor_id.
2268 ipmi_exclude_sensor | **Optional.** Exclude sensor based on IPMI sensor type. (Comma-separated)
2269 ipmi_exclude_sel | **Optional.** Exclude SEL entries of specific sensor types. (comma-separated list).
2270 ipmi_sensor_id | **Optional.** Include sensor matching ipmi_sensor_id.
2271 ipmi_protocal_lan_version | **Optional.** Change the protocol LAN version. Defaults to "LAN_2_0".
2272 ipmi_number_of_active_fans | **Optional.** Number of fans that should be active. Otherwise a WARNING state is returned.
2273 ipmi_show_fru | **Optional.** Print the product serial number if it is available in the IPMI FRU data.
2274 ipmi_no_sel_checking | **Optional.** Turn off system event log checking via ipmi-sel.
2275 ipmi_verbose | **Optional.** Be Verbose multi line output, also with additional details for warnings.
2276 ipmi_debug | **Optional.** Be Verbose debugging output, followed by normal multi line output.
2281 ### <a id="plugins-contrib-log-management"></a> Log Management
2283 This category includes all plugins for log management, for example [Logstash](https://www.elastic.co/products/logstash).
2285 #### <a id="plugins-contrib-command-logstash"></a> logstash
2287 The [logstash](https://github.com/widhalmt/check_logstash) plugin connects to
2288 the Node API of Logstash. This plugin requires at least Logstash version 5.0.x.
2290 The Node API is not activated by default. You have to configure your Logstash
2291 installation in order to allow plugin connections.
2294 ---------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
2295 logstash_hostname | **Optional.** Hostname where Logstash is running. Defaults to `check_address`
2296 logstash_port | **Optional.** Port where Logstash is listening for API requests. Defaults to 9600
2297 logstash_filedesc_warn | **Optional.** Warning threshold of file descriptor usage in percent. Defaults to 85 (percent).
2298 logstash_filedesc_crit | **Optional.** Critical threshold of file descriptor usage in percent. Defaults to 95 (percent).
2299 logstash_heap_warn | **Optional.** Warning threshold of heap usage in percent. Defaults to 70 (percent).
2300 logstash_heap_crit | **Optional.** Critical threshold of heap usage in percent Defaults to 80 (percent).
2301 logstash_inflight_warn | **Optional.** Warning threshold of inflight events.
2302 logstash_inflight_crit | **Optional.** Critical threshold of inflight events.
2303 logstash_cpu_warn | **Optional.** Warning threshold for cpu usage in percent.
2304 logstash_cpu_crit | **Optional.** Critical threshold for cpu usage in percent.
2307 ### <a id="plugin-contrib-metrics"></a> Metrics
2309 This category includes all plugins for metric-based checks.
2311 #### <a id="plugin-contrib-command-graphite"></a> graphite
2313 Check command object for the [check_graphite](https://github.com/obfuscurity/nagios-scripts) plugin.
2315 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
2318 ------------------------------------|-----------------------------------------------------------------------------------------------------
2319 graphite_url | **Required.** Target url.
2320 graphite_metric | **Required.** Metric path string.
2321 graphite_shortname | **Optional.** Metric short name (used for performance data).
2322 graphite_duration | **Optional.** Length, in minute of data to parse (default: 5).
2323 graphite_function | **Optional.** Function applied to metrics for thresholds (default: average).
2324 graphite_warning | **Required.** Warning threshold.
2325 graphite_critical | **Required.** Critical threshold.
2326 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.
2327 graphite_message | **Optional.** Text message to output (default: "metric count:").
2328 graphite_zero_on_error | **Optional.** Return 0 on a graphite 500 error.
2329 graphite_link_graph | **Optional.** Add a link in the plugin output, showing a 24h graph for this metric in graphite.
2331 ### <a id="plugin-contrib-network-components"></a> Network Components
2333 This category includes all plugins for various network components like routers, switches and firewalls.
2335 #### <a id="plugin-contrib-command-interfacetable"></a> interfacetable
2337 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).
2339 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
2342 ------------------------------------|-----------------------------------------------------------------------------------------------------
2343 interfacetable_hostquery | **Required.** Specifies the remote host to poll. Defaults to "$address$".
2344 interfacetable_hostdisplay | **Optional.** Specifies the hostname to display in the HTML link. Defaults to "$host.display_name$".
2345 interfacetable_regex | **Optional.** Interface names and property names for some other options will be interpreted as regular expressions. Defaults to false.
2346 interfacetable_outputshort | **Optional.** Reduce the verbosity of the plugin output. Defaults to false.
2347 interfacetable_exclude | **Optional.** Comma separated list of interfaces globally excluded from the monitoring.
2348 interfacetable_include | **Optional.** Comma separated list of interfaces globally included in the monitoring.
2349 interfacetable_aliasmatching | **Optional.** Allow you to specify alias in addition to interface names. Defaults to false.
2350 interfacetable_excludetraffic | **Optional.** Comma separated list of interfaces excluded from traffic checks.
2351 interfacetable_includetraffic | **Optional.** Comma separated list of interfaces included for traffic checks.
2352 interfacetable_warningtraffic | **Optional.** Interface traffic load percentage leading to a warning alert.
2353 interfacetable_criticaltraffic | **Optional.** Interface traffic load percentage leading to a critical alert.
2354 interfacetable_pkt | **Optional.** Add unicast/non-unicast pkt stats for each interface.
2355 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.
2356 interfacetable_trackproperty | **Optional.** List of tracked properties.
2357 interfacetable_excludeproperty | **Optional.** Comma separated list of interfaces excluded from the property tracking.
2358 interfacetable_includeproperty | **Optional.** Comma separated list of interfaces included in the property tracking.
2359 interfacetable_community | **Optional.** Specifies the snmp v1/v2c community string. Defaults to "public" if using snmp v1/v2c, ignored using v3.
2360 interfacetable_snmpv2 | **Optional.** Use snmp v2c. Defaults to false.
2361 interfacetable_login | **Optional.** Login for snmpv3 authentication.
2362 interfacetable_passwd | **Optional.** Auth password for snmpv3 authentication.
2363 interfacetable_privpass | **Optional.** Priv password for snmpv3 authentication.
2364 interfacetable_protocols | **Optional.** Authentication protocol,Priv protocol for snmpv3 authentication.
2365 interfacetable_domain | **Optional.** SNMP transport domain.
2366 interfacetable_contextname | **Optional.** Context name for the snmp requests.
2367 interfacetable_port | **Optional.** SNMP port. Defaults to standard port.
2368 interfacetable_64bits | **Optional.** Use SNMP 64-bits counters. Defaults to false.
2369 interfacetable_maxrepetitions | **Optional.** Increasing this value may enhance snmp query performances by gathering more results at one time.
2370 interfacetable_snmptimeout | **Optional.** Define the Transport Layer timeout for the snmp queries.
2371 interfacetable_snmpretries | **Optional.** Define the number of times to retry sending a SNMP message.
2372 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.
2373 interfacetable_unixsnmp | **Optional.** Use unix snmp utilities for snmp requests. Defaults to false, which means use the perl bindings.
2374 interfacetable_enableperfdata | **Optional.** Enable port performance data. Defaults to false.
2375 interfacetable_perfdataformat | **Optional.** Define which performance data will be generated. Possible values are "full" (default), "loadonly", "globalonly".
2376 interfacetable_perfdatathreshold | **Optional.** Define which thresholds are printed in the generated performance data. Possible values are "full" (default), "loadonly", "globalonly".
2377 interfacetable_perfdatadir | **Optional.** When specified, the performance data are also written directly to a file, in the specified location.
2378 interfacetable_perfdataservicedesc | **Optional.** Specify additional parameters for output performance data to PNP. Defaults to "$service.name$", only affects **interfacetable_perfdatadir**.
2379 interfacetable_grapher | **Optional.** Specify the used graphing solution. Possible values are "pnp4nagios" (default), "nagiosgrapher", "netwaysgrapherv2" and "ingraph".
2380 interfacetable_grapherurl | **Optional.** Graphing system url. Default depends on **interfacetable_grapher**.
2381 interfacetable_portperfunit | **Optional.** Traffic could be reported in bits (counters) or in bps (calculated value).
2382 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".
2383 interfacetable_duplex | **Optional.** Add the duplex mode property for each interface in the interface table. Defaults to false.
2384 interfacetable_stp | **Optional.** Add the stp state property for each interface in the interface table. Defaults to false.
2385 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"
2386 interfacetable_noipinfo | **Optional.** Remove the ip information for each interface from the interface table. Defaults to false.
2387 interfacetable_alias | **Optional.** Add the alias information for each interface in the interface table. Defaults to false.
2388 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.
2389 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.
2390 interfacetable_delta | **Optional.** Set the delta used for interface throuput calculation in seconds.
2391 interfacetable_ifs | **Optional.** Input field separator. Defaults to ",".
2392 interfacetable_cache | **Optional.** Define the retention time of the cached data in seconds.
2393 interfacetable_noifloadgradient | **Optional.** Disable color gradient from green over yellow to red for the load percentage. Defaults to false.
2394 interfacetable_nohuman | **Optional.** Do not translate bandwidth usage in human readable format. Defaults to false.
2395 interfacetable_snapshot | **Optional.** Force the plugin to run like if it was the first launch. Defaults to false.
2396 interfacetable_timeout | **Optional.** Define the global timeout limit of the plugin in seconds. Defaults to "15s".
2397 interfacetable_css | **Optional.** Define the css stylesheet used by the generated html files. Possible values are "classic", "icinga", "icinga-alternate1" or "nagiosxi".
2398 interfacetable_config | **Optional.** Specify a config file to load.
2399 interfacetable_noconfigtable | **Optional.** Disable configuration table on the generated HTML page. Defaults to false.
2400 interfacetable_notips | **Optional.** Disable the tips in the generated html tables. Defaults to false.
2401 interfacetable_defaulttablesorting | **Optional.** Default table sorting can be "index" (default) or "name".
2402 interfacetable_tablesplit | **Optional.** Generate multiple interface tables, one per interface type. Defaults to false.
2403 interfacetable_notype | **Optional.** Remove the interface type for each interface. Defaults to false.
2405 #### <a id="plugin-contrib-command-iftraffic"></a> iftraffic
2407 The plugin [check_iftraffic](https://exchange.icinga.com/exchange/iftraffic)
2408 checks the utilization of a given interface name using the SNMP protocol.
2410 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
2413 ------------------------|---------------------------------------------------------
2414 iftraffic_address | **Required.** Specifies the remote host. Defaults to "$address$".
2415 iftraffic_community | **Optional.** SNMP community. Defaults to "public'" if omitted.
2416 iftraffic_interface | **Required.** Queried interface name.
2417 iftraffic_bandwidth | **Required.** Interface maximum speed in kilo/mega/giga/bits per second.
2418 iftraffic_units | **Optional.** Interface units can be one of these values: `g` (gigabits/s),`m` (megabits/s), `k` (kilobits/s),`b` (bits/s)
2419 iftraffic_warn | **Optional.** Percent of bandwidth usage necessary to result in warning status (defaults to `85`).
2420 iftraffic_crit | **Optional.** Percent of bandwidth usage necessary to result in critical status (defaults to `98`).
2421 iftraffic_max_counter | **Optional.** Maximum counter value of net devices in kilo/mega/giga/bytes.
2423 #### <a id="plugin-contrib-command-iftraffic64"></a> iftraffic64
2425 The plugin [check_iftraffic64](https://exchange.icinga.com/exchange/iftraffic64)
2426 checks the utilization of a given interface name using the SNMP protocol.
2428 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
2431 ------------------------|---------------------------------------------------------
2432 iftraffic64_address | **Required.** Specifies the remote host. Defaults to "$address$".
2433 iftraffic64_community | **Optional.** SNMP community. Defaults to "public'" if omitted.
2434 iftraffic64_interface | **Required.** Queried interface name.
2435 iftraffic64_bandwidth | **Required.** Interface maximum speed in kilo/mega/giga/bits per second.
2436 iftraffic64_units | **Optional.** Interface units can be one of these values: `g` (gigabits/s),`m` (megabits/s), `k` (kilobits/s),`b` (bits/s)
2437 iftraffic64_warn | **Optional.** Percent of bandwidth usage necessary to result in warning status (defaults to `85`).
2438 iftraffic64_crit | **Optional.** Percent of bandwidth usage necessary to result in critical status (defaults to `98`).
2439 iftraffic64_max_counter | **Optional.** Maximum counter value of net devices in kilo/mega/giga/bytes.
2441 #### <a id="plugin-contrib-command-interfaces"></a> interfaces
2443 The plugin [check_interfaces](https://www.netways.org/projects/check-interfaces)
2444 Check interfaces and utilization.
2446 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
2449 --------------------------|---------------------------------------------------------
2450 interfaces_address | **Optional.** The host's address. Defaults to "$address$" if the host's `address` attribute is set, "$address6$" otherwise.
2451 interfaces_regex | **Optional.** Interface list regexp.
2452 interfaces_exclude_regex | **Optional.** Interface list negative regexp.
2453 interfaces_errors | **Optional.** Number of in errors (CRC errors for cisco) to consider a warning (default 50).
2454 interface_out_errors | **Optional.** Number of out errors (collisions for cisco) to consider a warning (default same as in errors).
2455 interfaces_perfdata | **Optional.** perfdata from last check result.
2456 interfaces_prefix | **Optional.** Prefix interface names with this label.
2457 interfaces_lastcheck | **Optional.** Last checktime (unixtime).
2458 interfaces_bandwidth | **Optional.** Bandwidth warn level in percent.
2459 interfaces_speed | **Optional.** Override speed detection with this value (bits per sec).
2460 interfaces_trim | **Optional.** Cut this number of characters from the start of interface descriptions.
2461 interfaces_mode | **Optional.** Special operating mode (default,cisco,nonbulk,bintec).
2462 interfaces_auth_proto | **Optional.** SNMPv3 Auth Protocol (SHA\|MD5)
2463 interfaces_auth_phrase | **Optional.** SNMPv3 Auth Phrase
2464 interfaces_priv_proto | **Optional.** SNMPv3 Privacy Protocol (AES\|DES)
2465 interfaces_priv_phrase | **Optional.** SNMPv3 Privacy Phrase
2466 interfaces_user | **Optional.** SNMPv3 User
2467 interfaces_down_is_ok | **Optional.** Disables critical alerts for down interfaces.
2468 interfaces_aliases | **Optional.** Retrieves the interface description.
2469 interfaces_match_aliases | **Optional.** Also match against aliases (Option --aliases automatically enabled).
2470 interfaces_timeout | **Optional.** Sets the SNMP timeout (in ms).
2471 interfaces_sleep | **Optional.** Sleep between every SNMP query (in ms).
2472 interfaces_names | **Optional.** If set to true, use ifName instead of ifDescr.
2474 #### <a id="plugin-contrib-command-nwc_health"></a> nwc_health
2476 The plugin [check_nwc_health](https://labs.consol.de/de/nagios/check_nwc_health/index.html)
2477 Check switches, router, there interfaces and utilization.
2479 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
2482 --------------------------------|---------------------------------------------------------
2483 nwc_health_hostname | **Optional.** The host's address. Defaults to "$address$" if the host's `address` attribute is set, "$address6$" otherwise.
2484 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).
2485 nwc_health_timeout | **Optional.** Seconds before plugin times out (default: 15)
2486 nwc_health_blacklist | **Optional.** Blacklist some (missing/failed) components.
2487 nwc_health_port | **Optional.** The SNMP port to use (default: 161).
2488 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).
2489 nwc_health_protocol | **Optional.** The SNMP protocol to use (default: 2c, other possibilities: 1,3).
2490 nwc_health_community | **Optional.** SNMP community of the server (SNMP v1/2 only).
2491 nwc_health_username | **Optional.** The securityName for the USM security model (SNMPv3 only).
2492 nwc_health_authpassword | **Optional.** The authentication password for SNMPv3.
2493 nwc_health_authprotocol | **Optional.** The authentication protocol for SNMPv3 (md5\|sha).
2494 nwc_health_privpassword | **Optional.** The password for authPriv security level.
2495 nwc_health_privprotocol | **Optional.** The private protocol for SNMPv3 (des\|aes\|aes128\|3des\|3desde).
2496 nwc_health_contextengineid | **Optional.** The context engine id for SNMPv3 (10 to 64 hex characters).
2497 nwc_health_contextname | **Optional.** The context name for SNMPv3 (empty represents the default context).
2498 nwc_health_name | **Optional.** The name of an interface (ifDescr).
2499 nwc_health_drecksptkdb | **Optional.** This parameter must be used instead of --name, because Devel::ptkdb is stealing the latter from the command line.
2500 nwc_health_alias | **Optional.** The alias name of a 64bit-interface (ifAlias)
2501 nwc_health_regexp | **Optional.** A flag indicating that --name is a regular expression
2502 nwc_health_ifspeedin | **Optional.** Override the ifspeed oid of an interface (only inbound)
2503 nwc_health_ifspeedout | **Optional.** Override the ifspeed oid of an interface (only outbound)
2504 nwc_health_ifspeed | **Optional.** Override the ifspeed oid of an interface
2505 nwc_health_units | **Optional.** One of %, B, KB, MB, GB, Bit, KBi, MBi, GBi. (used for e.g. mode interface-usage)
2506 nwc_health_name2 | **Optional.** The secondary name of a component.
2507 nwc_health_role | **Optional.** The role of this device in a hsrp group (active/standby/listen).
2508 nwc_health_report | **Optional.** Can be used to shorten the output.
2509 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.
2510 nwc_health_warning | **Optional.** The warning threshold
2511 nwc_health_critical | **Optional.** The critical threshold
2512 nwc_health_warningx | **Optional.** The extended warning thresholds
2513 nwc_health_criticalx | **Optional.** The extended critical thresholds
2514 nwc_health_mitigation | **Optional.** The parameter allows you to change a critical error to a warning.
2515 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.
2516 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'
2517 nwc_health_negate | **Optional.** The parameter allows you to map exit levels, such as warning=critical.
2518 nwc_health_mymodules-dyn-dir | **Optional.** A directory where own extensions can be found.
2519 nwc_health_servertype | **Optional.** The type of the network device: cisco (default). Use it if auto-detection is not possible.
2520 nwc_health_statefilesdir | **Optional.** An alternate directory where the plugin can save files.
2521 nwc_health_oids | **Optional.** A list of oids which are downloaded and written to a cache file. Use it together with --mode oidcache.
2522 nwc_health_offline | **Optional.** The maximum number of seconds since the last update of cache file before it is considered too old.
2523 nwc_health_multiline | **Optional.** Multiline output
2526 ### <a id="plugin-contrib-operating-system"></a> Operating System
2528 In this category you can find plugins for gathering information about your operating system or the system beneath like memory usage.
2530 #### <a id="plugin-contrib-command-mem"></a> mem
2532 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).
2534 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
2537 -------------|-----------------------------------------------------------------------------------------------------------------------
2538 mem_used | **Optional.** Tell the plugin to check for used memory in opposite of **mem_free**. Must specify one of these as true.
2539 mem_free | **Optional.** Tell the plugin to check for free memory in opposite of **mem_used**. Must specify one of these as true.
2540 mem_cache | **Optional.** If set to true, plugin will count cache as free memory. Defaults to false.
2541 mem_warning | **Required.** Specify the warning threshold as number interpreted as percent.
2542 mem_critical | **Required.** Specify the critical threshold as number interpreted as percent.
2544 #### <a id="plugin-contrib-command-running_kernel"></a> running_kernel
2546 Check command object for the `check_running_kernel` plugin
2547 provided by the `nagios-plugin-contrib` package on Debian.
2552 ---------------------------|-------------
2553 running\_kernel\_use\_sudo | Whether to run the plugin with `sudo`. Defaults to false except on Ubuntu where it defaults to true.
2555 #### <a id="plugin-contrib-command-iostats"></a> iostats
2557 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.
2559 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
2562 ---------------|-----------------------------------------------------------------------------------------------------------------------
2563 iostats\_disk | **Required.** The device to monitor without path. e.g. sda or vda. (default: sda)
2564 iostats\_warning\_tps | **Required.** Warning threshold for tps (default: 3000)
2565 iostats\_warning\_read | **Required.** Warning threshold for KB/s reads (default: 50000)
2566 iostats\_warning\_write | **Required.** Warning threshold for KB/s writes (default: 10000)
2567 iostats\_warning\_wait | **Required.** Warning threshold for % iowait (default: 50)
2568 iostats\_critical\_tps | **Required.** Critical threshold for tps (default: 5000)
2569 iostats\_critical\_read | **Required.** Critical threshold for KB/s reads (default: 80000)
2570 iostats\_critical\_write | **Required.** Critical threshold for KB/s writes (default: 25000)
2571 iostats\_critical\_wait | **Required.** Critical threshold for % iowait (default: 80)
2573 #### <a id="plugin-contrib-command-iostat"></a> iostat
2575 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.
2577 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
2580 ---------------|-----------------------------------------------------------------------------------------------------------------------
2581 iostat\_disk | **Required.** The device to monitor without path. e.g. sda or vda. (default: sda)
2582 iostat\_wtps | **Required.** Warning threshold for tps (default: 100)
2583 iostat\_wread | **Required.** Warning threshold for KB/s reads (default: 100)
2584 iostat\_wwrite | **Required.** Warning threshold for KB/s writes (default: 100)
2585 iostat\_ctps | **Required.** Critical threshold for tps (default: 200)
2586 iostat\_cread | **Required.** Critical threshold for KB/s reads (default: 200)
2587 iostat\_cwrite | **Required.** Critical threshold for KB/s writes (default: 200)
2589 #### <a id="plugin-contrib-command-yum"></a> yum
2591 The plugin [check_yum](https://github.com/calestyo/check_yum) is used to check the YUM package
2592 management system for package updates.
2593 The plugin requires the `yum-plugin-security` package to differentiate between security and normal updates.
2595 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
2598 ------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
2599 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.
2600 yum_warn_on_any_update | **Optional.** Set to true to warn if there are any (non-security) package updates available. Defaults to false.
2601 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.
2602 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.
2603 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.
2604 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.
2605 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.
2606 yum_installroot | **Optional.** Specifies another installation root directory (for example a chroot).
2607 yum_timeout | **Optional.** Set a timeout in seconds after which the plugin will exit (defaults to 55 seconds).
2609 ### <a id="plugins-contrib-storage"></a> Storage
2611 This category includes all plugins for various storage and object storage technologies.
2613 #### <a id="plugins-contrib-command-glusterfs"></a> glusterfs
2615 The plugin [glusterfs](https://www.unixadm.org/software/nagios-stuff/checks/check_glusterfs) is used to check the GlusterFS storage health on the server.
2616 The plugin requires `sudo` permissions.
2619 ---------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
2620 glusterfs_perfdata | **Optional.** Print perfdata of all or the specified volume.
2621 glusterfs_warnonfailedheal | **Optional.** Warn if the *heal-failed* log contains entries. The log can be cleared by restarting glusterd.
2622 glusterfs_volume | **Optional.** Only check the specified *VOLUME*. If --volume is not set, all volumes are checked.
2623 glusterfs_disk_warning | **Optional.** Warn if disk usage is above *DISKWARN*. Defaults to 90 (percent).
2624 glusterfs_disk_critical | **Optional.** Return a critical error if disk usage is above *DISKCRIT*. Defaults to 95 (percent).
2625 glusterfs_inode_warning | **Optional.** Warn if inode usage is above *DISKWARN*. Defaults to 90 (percent).
2626 glusterfs_inode_critical | **Optional.** Return a critical error if inode usage is above *DISKCRIT*. Defaults to 95 (percent).
2629 ### <a id="plugin-contrib-virtualization"></a> Virtualization
2631 This category includes all plugins for various virtualization technologies.
2633 #### <a id="plugin-contrib-command-esxi-hardware"></a> esxi_hardware
2635 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.
2637 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
2640 ------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
2641 esxi_hardware_host | **Required.** Specifies the host to monitor. Defaults to "$address$".
2642 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.
2643 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.
2644 esxi_hardware_port | **Optional.** Specifies the CIM port to connect to. Defaults to 5989.
2645 esxi_hardware_vendor | **Optional.** Defines the vendor of the server: "auto", "dell", "hp", "ibm", "intel", "unknown" (default).
2646 esxi_hardware_html | **Optional.** Add web-links to hardware manuals for Dell servers (use your country extension). Only useful with **esxi_hardware_vendor** = dell.
2647 esxi_hardware_ignore | **Optional.** Comma separated list of elements to ignore.
2648 esxi_hardware_perfdata | **Optional.** Add performcedata for graphers like PNP4Nagios to the output. Defaults to false.
2649 esxi_hardware_nopower | **Optional.** Do not collect power performance data, when **esxi_hardware_perfdata** is set to true. Defaults to false.
2650 esxi_hardware_novolts | **Optional.** Do not collect voltage performance data, when **esxi_hardware_perfdata** is set to true. Defaults to false.
2651 esxi_hardware_nocurrent | **Optional.** Do not collect current performance data, when **esxi_hardware_perfdata** is set to true. Defaults to false.
2652 esxi_hardware_notemp | **Optional.** Do not collect temperature performance data, when **esxi_hardware_perfdata** is set to true. Defaults to false.
2653 esxi_hardware_nofan | **Optional.** Do not collect fan performance data, when **esxi_hardware_perfdata** is set to true. Defaults to false.
2655 #### <a id="plugin-contrib-vmware"></a> VMware
2657 Check commands for the [check_vmware_esx](https://github.com/BaldMansMojo/check_vmware_esx) plugin.
2659 ##### <a id="plugin-contrib-vmware-esx-dc-volumes"></a> vmware-esx-dc-volumes
2661 Check command object for the `check_vmware_esx` plugin. Shows all datastore volumes info.
2663 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
2666 ------------------------|--------------
2667 vmware_datacenter | **Required.** Datacenter/vCenter hostname.
2668 vmware_cluster | **Optional.** ESX or ESXi clustername.
2669 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
2670 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
2671 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
2672 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
2673 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
2674 vmware_sessionfile | **Optional.** Session file name enhancement.
2675 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
2676 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
2677 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
2678 vmware_password | **Optional.** The username's password. No value defined as default.
2679 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
2680 vmware_subselect | **Optional.** Volume name to be checked the free space.
2681 vmware_gigabyte | **Optional.** Output in GB instead of MB.
2682 vmware_usedspace | **Optional.** Output used space instead of free. Defaults to "false".
2683 vmware_alertonly | **Optional.** List only alerting volumes. Defaults to "false".
2684 vmware_exclude | **Optional.** Blacklist volumes name. No value defined as default.
2685 vmware_include | **Optional.** Whitelist volumes name. No value defined as default.
2686 vmware_isregexp | **Optional.** Treat blacklist and whitelist expressions as regexp.
2687 vmware_dc_volume_used | **Optional.** Output used space instead of free. Defaults to "true".
2688 vmware_warn | **Optional.** The warning threshold for volumes. Defaults to "80%".
2689 vmware_crit | **Optional.** The critical threshold for volumes. Defaults to "90%".
2692 ##### <a id="plugin-contrib-vmware-esx-dc-runtime-info"></a> vmware-esx-dc-runtime-info
2694 Check command object for the `check_vmware_esx` plugin. Shows all runtime info for the datacenter/Vcenter.
2696 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
2699 ------------------------|--------------
2700 vmware_datacenter | **Required.** Datacenter/vCenter hostname.
2701 vmware_cluster | **Optional.** ESX or ESXi clustername.
2702 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
2703 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
2704 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
2705 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
2706 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
2707 vmware_sessionfile | **Optional.** Session file name enhancement.
2708 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
2709 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
2710 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
2711 vmware_password | **Optional.** The username's password. No value defined as default.
2712 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
2715 ##### <a id="plugin-contrib-vmware-esx-dc-runtime-listvms"></a> vmware-esx-dc-runtime-listvms
2717 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.
2719 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
2722 ------------------------|--------------
2723 vmware_datacenter | **Required.** Datacenter/vCenter hostname.
2724 vmware_cluster | **Optional.** ESX or ESXi clustername.
2725 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
2726 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
2727 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
2728 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
2729 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
2730 vmware_sessionfile | **Optional.** Session file name enhancement.
2731 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
2732 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
2733 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
2734 vmware_password | **Optional.** The username's password. No value defined as default.
2735 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
2736 vmware_alertonly | **Optional.** List only alerting VMs. Important here to avoid masses of data.
2737 vmware_exclude | **Optional.** Blacklist VMs name. No value defined as default.
2738 vmware_include | **Optional.** Whitelist VMs name. No value defined as default.
2739 vmware_isregexp | **Optional.** Treat blacklist and whitelist expressions as regexp.
2740 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.
2743 ##### <a id="plugin-contrib-vmware-esx-dc-runtime-listhost"></a> vmware-esx-dc-runtime-listhost
2745 Check command object for the `check_vmware_esx` plugin. List of VMware ESX hosts and their power state.
2747 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
2750 ------------------------|--------------
2751 vmware_datacenter | **Required.** Datacenter/vCenter hostname.
2752 vmware_cluster | **Optional.** ESX or ESXi clustername.
2753 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
2754 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
2755 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
2756 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
2757 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
2758 vmware_sessionfile | **Optional.** Session file name enhancement.
2759 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
2760 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
2761 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
2762 vmware_password | **Optional.** The username's password. No value defined as default.
2763 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
2764 vmware_alertonly | **Optional.** List only alerting hosts. Important here to avoid masses of data.
2765 vmware_exclude | **Optional.** Blacklist VMware ESX hosts. No value defined as default.
2766 vmware_include | **Optional.** Whitelist VMware ESX hosts. No value defined as default.
2767 vmware_isregexp | **Optional.** Treat blacklist and whitelist expressions as regexp.
2768 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.
2771 ##### <a id="plugin-contrib-vmware-esx-dc-runtime-listcluster"></a> vmware-esx-dc-runtime-listcluster
2773 Check command object for the `check_vmware_esx` plugin. List of VMware clusters and their states.
2775 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
2778 ------------------------|--------------
2779 vmware_datacenter | **Required.** Datacenter/vCenter hostname.
2780 vmware_cluster | **Optional.** ESX or ESXi clustername.
2781 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
2782 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
2783 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
2784 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
2785 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
2786 vmware_sessionfile | **Optional.** Session file name enhancement.
2787 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
2788 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
2789 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
2790 vmware_password | **Optional.** The username's password. No value defined as default.
2791 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
2792 vmware_alertonly | **Optional.** List only alerting hosts. Important here to avoid masses of data.
2793 vmware_exclude | **Optional.** Blacklist VMware cluster. No value defined as default.
2794 vmware_include | **Optional.** Whitelist VMware cluster. No value defined as default.
2795 vmware_isregexp | **Optional.** Treat blacklist and whitelist expressions as regexp.
2796 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.
2799 ##### <a id="plugin-contrib-vmware-esx-dc-runtime-issues"></a> vmware-esx-dc-runtime-issues
2801 Check command object for the `check_vmware_esx` plugin. All issues for the host.
2803 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
2806 ------------------------|--------------
2807 vmware_datacenter | **Required.** Datacenter/vCenter hostname.
2808 vmware_cluster | **Optional.** ESX or ESXi clustername.
2809 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
2810 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
2811 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
2812 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
2813 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
2814 vmware_sessionfile | **Optional.** Session file name enhancement.
2815 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
2816 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
2817 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
2818 vmware_password | **Optional.** The username's password. No value defined as default.
2819 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
2820 vmware_exclude | **Optional.** Blacklist issues. No value defined as default.
2821 vmware_include | **Optional.** Whitelist issues. No value defined as default.
2822 vmware_isregexp | **Optional.** Treat blacklist and whitelist expressions as regexp.
2823 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.
2826 ##### <a id="plugin-contrib-vmware-esx-dc-runtime-status"></a> vmware-esx-dc-runtime-status
2828 Check command object for the `check_vmware_esx` plugin. Overall object status (gray/green/red/yellow).
2830 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
2833 ------------------------|--------------
2834 vmware_datacenter | **Required.** Datacenter/vCenter hostname.
2835 vmware_cluster | **Optional.** ESX or ESXi clustername.
2836 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
2837 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
2838 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
2839 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
2840 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
2841 vmware_sessionfile | **Optional.** Session file name enhancement.
2842 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
2843 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
2844 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
2845 vmware_password | **Optional.** The username's password. No value defined as default.
2846 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
2849 ##### <a id="plugin-contrib-vmware-esx-dc-runtime-tools"></a> vmware-esx-dc-runtime-tools
2851 Check command object for the `check_vmware_esx` plugin. Vmware Tools status.
2853 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
2856 ------------------------|--------------
2857 vmware_datacenter | **Required.** Datacenter/vCenter hostname.
2858 vmware_cluster | **Optional.** ESX or ESXi clustername.
2859 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
2860 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
2861 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
2862 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
2863 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
2864 vmware_sessionfile | **Optional.** Session file name enhancement.
2865 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
2866 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
2867 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
2868 vmware_password | **Optional.** The username's password. No value defined as default.
2869 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
2870 vmware_poweredonly | **Optional.** List only VMs which are powered on. No value defined as default.
2871 vmware_alertonly | **Optional.** List only alerting VMs. Important here to avoid masses of data.
2872 vmware_exclude | **Optional.** Blacklist VMs. No value defined as default.
2873 vmware_include | **Optional.** Whitelist VMs. No value defined as default.
2874 vmware_isregexp | **Optional.** Treat blacklist and whitelist expressions as regexp.
2875 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.
2876 vmware_openvmtools | **Optional** Prevent CRITICAL state for installed and running Open VM Tools.
2879 ##### <a id="plugin-contrib-vmware-esx-soap-host-check"></a> vmware-esx-soap-host-check
2881 Check command object for the `check_vmware_esx` plugin. Simple check to verify a successfull connection to VMware SOAP API.
2883 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
2886 ------------------------|--------------
2887 vmware_host | **Required.** ESX or ESXi hostname.
2888 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. In case the check is done through a Datacenter/vCenter host.
2889 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
2890 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
2891 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
2892 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
2893 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
2894 vmware_sessionfile | **Optional.** Session file name enhancement.
2895 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
2896 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
2897 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
2898 vmware_password | **Optional.** The username's password. No value defined as default.
2899 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
2902 ##### <a id="plugin-contrib-vmware-esx-soap-host-uptime"></a> vmware-esx-soap-host-uptime
2904 Check command object for the `check_vmware_esx` plugin. Displays uptime of the VMware host.
2906 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
2909 ------------------------|--------------
2910 vmware_host | **Required.** ESX or ESXi hostname.
2911 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. In case the check is done through a Datacenter/vCenter host.
2912 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
2913 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
2914 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
2915 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
2916 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
2917 vmware_sessionfile | **Optional.** Session file name enhancement.
2918 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
2919 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
2920 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
2921 vmware_password | **Optional.** The username's password. No value defined as default.
2922 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
2925 ##### <a id="plugin-contrib-vmware-esx-soap-host-cpu"></a> vmware-esx-soap-host-cpu
2927 Check command object for the `check_vmware_esx` plugin. CPU usage in percentage.
2929 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
2932 ------------------------|--------------
2933 vmware_host | **Required.** ESX or ESXi hostname.
2934 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. In case the check is done through a Datacenter/vCenter host.
2935 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
2936 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
2937 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
2938 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
2939 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
2940 vmware_sessionfile | **Optional.** Session file name enhancement.
2941 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
2942 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
2943 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
2944 vmware_password | **Optional.** The username's password. No value defined as default.
2945 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
2946 vmware_warn | **Optional.** The warning threshold in percent. Defaults to "80%".
2947 vmware_crit | **Optional.** The critical threshold in percent. Defaults to "90%".
2950 ##### <a id="plugin-contrib-vmware-esx-soap-host-cpu-ready"></a> vmware-esx-soap-host-cpu-ready
2952 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.
2954 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
2957 ------------------------|--------------
2958 vmware_host | **Required.** ESX or ESXi hostname.
2959 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. In case the check is done through a Datacenter/vCenter host.
2960 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
2961 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
2962 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
2963 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
2964 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
2965 vmware_sessionfile | **Optional.** Session file name enhancement.
2966 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
2967 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
2968 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
2969 vmware_password | **Optional.** The username's password. No value defined as default.
2970 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
2973 ##### <a id="plugin-contrib-vmware-esx-soap-host-cpu-wait"></a> vmware-esx-soap-host-cpu-wait
2975 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.
2977 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
2980 ------------------------|--------------
2981 vmware_host | **Required.** ESX or ESXi hostname.
2982 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. In case the check is done through a Datacenter/vCenter host.
2983 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
2984 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
2985 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
2986 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
2987 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
2988 vmware_sessionfile | **Optional.** Session file name enhancement.
2989 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
2990 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
2991 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
2992 vmware_password | **Optional.** The username's password. No value defined as default.
2993 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
2996 ##### <a id="plugin-contrib-vmware-esx-soap-host-cpu-usage"></a> vmware-esx-soap-host-cpu-usage
2998 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.
3000 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
3003 ------------------------|--------------
3004 vmware_host | **Required.** ESX or ESXi hostname.
3005 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. In case the check is done through a Datacenter/vCenter host.
3006 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
3007 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
3008 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
3009 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
3010 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
3011 vmware_sessionfile | **Optional.** Session file name enhancement.
3012 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
3013 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
3014 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
3015 vmware_password | **Optional.** The username's password. No value defined as default.
3016 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
3017 vmware_warn | **Optional.** The warning threshold in percent. Defaults to "80%".
3018 vmware_crit | **Optional.** The critical threshold in percent. Defaults to "90%".
3021 ##### <a id="plugin-contrib-vmware-esx-soap-host-mem"></a> vmware-esx-soap-host-mem
3023 Check command object for the `check_vmware_esx` plugin. All mem info(except overall and no thresholds).
3025 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
3028 ------------------------|--------------
3029 vmware_host | **Required.** ESX or ESXi hostname.
3030 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. In case the check is done through a Datacenter/vCenter host.
3031 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
3032 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
3033 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
3034 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
3035 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
3036 vmware_sessionfile | **Optional.** Session file name enhancement.
3037 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
3038 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
3039 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
3040 vmware_password | **Optional.** The username's password. No value defined as default.
3041 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
3044 ##### <a id="plugin-contrib-vmware-esx-soap-host-mem-usage"></a> vmware-esx-soap-host-mem-usage
3046 Check command object for the `check_vmware_esx` plugin. Average mem usage in percentage.
3048 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
3051 ------------------------|--------------
3052 vmware_host | **Required.** ESX or ESXi hostname.
3053 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. In case the check is done through a Datacenter/vCenter host.
3054 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
3055 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
3056 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
3057 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
3058 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
3059 vmware_sessionfile | **Optional.** Session file name enhancement.
3060 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
3061 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
3062 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
3063 vmware_password | **Optional.** The username's password. No value defined as default.
3064 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
3065 vmware_warn | **Optional.** The warning threshold in percent. Defaults to "80%".
3066 vmware_crit | **Optional.** The critical threshold in percent. Defaults to "90%".
3069 ##### <a id="plugin-contrib-vmware-esx-soap-host-mem-consumed"></a> vmware-esx-soap-host-mem-consumed
3071 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.
3073 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
3076 ------------------------|--------------
3077 vmware_host | **Required.** ESX or ESXi hostname.
3078 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. In case the check is done through a Datacenter/vCenter host.
3079 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
3080 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
3081 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
3082 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
3083 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
3084 vmware_sessionfile | **Optional.** Session file name enhancement.
3085 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
3086 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
3087 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
3088 vmware_password | **Optional.** The username's password. No value defined as default.
3089 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
3090 vmware_warn | **Optional.** The warning threshold in percent. No value defined as default.
3091 vmware_crit | **Optional.** The critical threshold in percent. No value defined as default.
3094 ##### <a id="plugin-contrib-vmware-esx-soap-host-mem-swapused"></a> vmware-esx-soap-host-mem-swapused
3096 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.
3098 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
3101 ------------------------|--------------
3102 vmware_host | **Required.** ESX or ESXi hostname.
3103 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. In case the check is done through a Datacenter/vCenter host.
3104 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
3105 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
3106 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
3107 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
3108 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
3109 vmware_sessionfile | **Optional.** Session file name enhancement.
3110 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
3111 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
3112 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
3113 vmware_password | **Optional.** The username's password. No value defined as default.
3114 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
3115 vmware_warn | **Optional.** The warning threshold in percent. No value defined as default.
3116 vmware_crit | **Optional.** The critical threshold in percent. No value defined as default.
3117 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.
3120 ##### <a id="plugin-contrib-vmware-esx-soap-host-mem-overhead"></a> vmware-esx-soap-host-mem-overhead
3122 Check command object for the `check_vmware_esx` plugin. Additional mem used by VM Server in MB.
3124 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
3127 ------------------------|--------------
3128 vmware_host | **Required.** ESX or ESXi hostname.
3129 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. In case the check is done through a Datacenter/vCenter host.
3130 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
3131 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
3132 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
3133 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
3134 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
3135 vmware_sessionfile | **Optional.** Session file name enhancement.
3136 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
3137 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
3138 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
3139 vmware_password | **Optional.** The username's password. No value defined as default.
3140 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
3141 vmware_warn | **Optional.** The warning threshold in percent. No value defined as default.
3142 vmware_crit | **Optional.** The critical threshold in percent. No value defined as default.
3145 ##### <a id="plugin-contrib-vmware-esx-soap-host-mem-memctl"></a> vmware-esx-soap-host-mem-memctl
3147 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.
3149 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
3152 ------------------------|--------------
3153 vmware_host | **Required.** ESX or ESXi hostname.
3154 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. In case the check is done through a Datacenter/vCenter host.
3155 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
3156 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
3157 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
3158 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
3159 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
3160 vmware_sessionfile | **Optional.** Session file name enhancement.
3161 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
3162 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
3163 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
3164 vmware_password | **Optional.** The username's password. No value defined as default.
3165 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
3166 vmware_warn | **Optional.** The warning threshold in percent. No value defined as default.
3167 vmware_crit | **Optional.** The critical threshold in percent. No value defined as default.
3168 vmware_multiline | **Optional.** Multiline output in overview. This mean technically that a multiline output uses a HTML **\<br\>** for the GUI. No value defined as default.
3171 ##### <a id="plugin-contrib-vmware-esx-soap-host-net"></a> vmware-esx-soap-host-net
3173 Check command object for the `check_vmware_esx` plugin. Shows net info.
3175 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
3178 ------------------------|--------------
3179 vmware_host | **Required.** ESX or ESXi hostname.
3180 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. In case the check is done through a Datacenter/vCenter host.
3181 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
3182 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
3183 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
3184 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
3185 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
3186 vmware_sessionfile | **Optional.** Session file name enhancement.
3187 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
3188 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
3189 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
3190 vmware_password | **Optional.** The username's password. No value defined as default.
3191 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
3192 vmware_exclude | **Optional.** Blacklist NICs. No value defined as default.
3193 vmware_isregexp | **Optional.** Treat blacklist expression as regexp.
3196 ##### <a id="plugin-contrib-vmware-esx-soap-host-net-usage"></a> vmware-esx-soap-host-net-usage
3198 Check command object for the `check_vmware_esx` plugin. Overall network usage in KBps(Kilobytes per Second).
3200 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
3203 ------------------------|--------------
3204 vmware_host | **Required.** ESX or ESXi hostname.
3205 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. In case the check is done through a Datacenter/vCenter host.
3206 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
3207 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
3208 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
3209 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
3210 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
3211 vmware_sessionfile | **Optional.** Session file name enhancement.
3212 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
3213 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
3214 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
3215 vmware_password | **Optional.** The username's password. No value defined as default.
3216 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
3217 vmware_warn | **Optional.** The warning threshold in KBps(Kilobytes per Second). No value defined as default.
3218 vmware_crit | **Optional.** The critical threshold in KBps(Kilobytes per Second). No value defined as default.
3221 ##### <a id="plugin-contrib-vmware-esx-soap-host-net-receive"></a> vmware-esx-soap-host-net-receive
3223 Check command object for the `check_vmware_esx` plugin. Data receive in KBps(Kilobytes per Second).
3225 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
3228 ------------------------|--------------
3229 vmware_host | **Required.** ESX or ESXi hostname.
3230 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. In case the check is done through a Datacenter/vCenter host.
3231 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
3232 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
3233 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
3234 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
3235 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
3236 vmware_sessionfile | **Optional.** Session file name enhancement.
3237 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
3238 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
3239 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
3240 vmware_password | **Optional.** The username's password. No value defined as default.
3241 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
3242 vmware_warn | **Optional.** The warning threshold in KBps(Kilobytes per Second). No value defined as default.
3243 vmware_crit | **Optional.** The critical threshold in KBps(Kilobytes per Second). No value defined as default.
3246 ##### <a id="plugin-contrib-vmware-esx-soap-host-net-send"></a> vmware-esx-soap-host-net-send
3248 Check command object for the `check_vmware_esx` plugin. Data send in KBps(Kilobytes per Second).
3250 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
3253 ------------------------|--------------
3254 vmware_host | **Required.** ESX or ESXi hostname.
3255 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. In case the check is done through a Datacenter/vCenter host.
3256 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
3257 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
3258 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
3259 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
3260 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
3261 vmware_sessionfile | **Optional.** Session file name enhancement.
3262 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
3263 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
3264 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
3265 vmware_password | **Optional.** The username's password. No value defined as default.
3266 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
3267 vmware_warn | **Optional.** The warning threshold in KBps(Kilobytes per Second). No value defined as default.
3268 vmware_crit | **Optional.** The critical threshold in KBps(Kilobytes per Second). No value defined as default.
3271 ##### <a id="plugin-contrib-vmware-esx-soap-host-net-nic"></a> vmware-esx-soap-host-net-nic
3273 Check command object for the `check_vmware_esx` plugin. Check all active NICs.
3275 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
3278 ------------------------|--------------
3279 vmware_host | **Required.** ESX or ESXi hostname.
3280 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. In case the check is done through a Datacenter/vCenter host.
3281 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
3282 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
3283 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
3284 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
3285 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
3286 vmware_sessionfile | **Optional.** Session file name enhancement.
3287 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
3288 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
3289 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
3290 vmware_password | **Optional.** The username's password. No value defined as default.
3291 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
3292 vmware_exclude | **Optional.** Blacklist NICs. No value defined as default.
3293 vmware_isregexp | **Optional.** Treat blacklist expression as regexp.
3296 ##### <a id="plugin-contrib-vmware-esx-soap-host-volumes"></a> vmware-esx-soap-host-volumes
3298 Check command object for the `check_vmware_esx` plugin. Shows all datastore volumes info.
3300 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
3303 ------------------------|--------------
3304 vmware_host | **Required.** ESX or ESXi hostname.
3305 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. In case the check is done through a Datacenter/vCenter host.
3306 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
3307 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
3308 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
3309 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
3310 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
3311 vmware_sessionfile | **Optional.** Session file name enhancement.
3312 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
3313 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
3314 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
3315 vmware_password | **Optional.** The username's password. No value defined as default.
3316 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
3317 vmware_subselect | **Optional.** Volume name to be checked the free space.
3318 vmware_gigabyte | **Optional.** Output in GB instead of MB.
3319 vmware_usedspace | **Optional.** Output used space instead of free. Defaults to "false".
3320 vmware_alertonly | **Optional.** List only alerting volumes. Defaults to "false".
3321 vmware_exclude | **Optional.** Blacklist volumes name. No value defined as default.
3322 vmware_include | **Optional.** Whitelist volumes name. No value defined as default.
3323 vmware_isregexp | **Optional.** Treat blacklist and whitelist expressions as regexp.
3324 vmware_warn | **Optional.** The warning threshold for volumes. Defaults to "80%".
3325 vmware_crit | **Optional.** The critical threshold for volumes. Defaults to "90%".
3326 vmware_spaceleft | **Optional.** This has to be used in conjunction with thresholds as mentioned above.
3329 ##### <a id="plugin-contrib-vmware-esx-soap-host-io"></a> vmware-esx-soap-host-io
3331 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.
3333 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
3336 ------------------------|--------------
3337 vmware_host | **Required.** ESX or ESXi hostname.
3338 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. In case the check is done through a Datacenter/vCenter host.
3339 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
3340 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
3341 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
3342 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
3343 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
3344 vmware_sessionfile | **Optional.** Session file name enhancement.
3345 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
3346 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
3347 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
3348 vmware_password | **Optional.** The username's password. No value defined as default.
3349 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
3352 ##### <a id="plugin-contrib-vmware-esx-soap-host-io-aborted"></a> vmware-esx-soap-host-io-aborted
3354 Check command object for the `check_vmware_esx` plugin. Number of aborted SCSI commands.
3356 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
3359 ------------------------|--------------
3360 vmware_host | **Required.** ESX or ESXi hostname.
3361 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. In case the check is done through a Datacenter/vCenter host.
3362 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
3363 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
3364 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
3365 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
3366 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
3367 vmware_sessionfile | **Optional.** Session file name enhancement.
3368 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
3369 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
3370 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
3371 vmware_password | **Optional.** The username's password. No value defined as default.
3372 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
3373 vmware_warn | **Optional.** The warning threshold. No value defined as default.
3374 vmware_crit | **Optional.** The critical threshold. No value defined as default.
3377 ##### <a id="plugin-contrib-vmware-esx-soap-host-io-resets"></a> vmware-esx-soap-host-io-resets
3379 Check command object for the `check_vmware_esx` plugin. Number of SCSI bus resets.
3381 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
3384 ------------------------|--------------
3385 vmware_host | **Required.** ESX or ESXi hostname.
3386 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. In case the check is done through a Datacenter/vCenter host.
3387 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
3388 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
3389 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
3390 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
3391 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
3392 vmware_sessionfile | **Optional.** Session file name enhancement.
3393 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
3394 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
3395 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
3396 vmware_password | **Optional.** The username's password. No value defined as default.
3397 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
3398 vmware_warn | **Optional.** The warning threshold. No value defined as default.
3399 vmware_crit | **Optional.** The critical threshold. No value defined as default.
3402 ##### <a id="plugin-contrib-vmware-esx-soap-host-io-read"></a> vmware-esx-soap-host-io-read
3404 Check command object for the `check_vmware_esx` plugin. Average number of kilobytes read from the disk each second.
3406 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
3409 ------------------------|--------------
3410 vmware_host | **Required.** ESX or ESXi hostname.
3411 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. In case the check is done through a Datacenter/vCenter host.
3412 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
3413 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
3414 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
3415 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
3416 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
3417 vmware_sessionfile | **Optional.** Session file name enhancement.
3418 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
3419 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
3420 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
3421 vmware_password | **Optional.** The username's password. No value defined as default.
3422 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
3423 vmware_warn | **Optional.** The warning threshold. No value defined as default.
3424 vmware_crit | **Optional.** The critical threshold. No value defined as default.
3427 ##### <a id="plugin-contrib-vmware-esx-soap-host-io-read-latency"></a> vmware-esx-soap-host-io-read-latency
3429 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.
3431 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
3434 ------------------------|--------------
3435 vmware_host | **Required.** ESX or ESXi hostname.
3436 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. In case the check is done through a Datacenter/vCenter host.
3437 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
3438 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
3439 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
3440 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
3441 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
3442 vmware_sessionfile | **Optional.** Session file name enhancement.
3443 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
3444 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
3445 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
3446 vmware_password | **Optional.** The username's password. No value defined as default.
3447 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
3448 vmware_warn | **Optional.** The warning threshold. No value defined as default.
3449 vmware_crit | **Optional.** The critical threshold. No value defined as default.
3452 ##### <a id="plugin-contrib-vmware-esx-soap-host-io-write"></a> vmware-esx-soap-host-io-write
3454 Check command object for the `check_vmware_esx` plugin. Average number of kilobytes written to disk each second.
3456 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
3459 ------------------------|--------------
3460 vmware_host | **Required.** ESX or ESXi hostname.
3461 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. In case the check is done through a Datacenter/vCenter host.
3462 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
3463 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
3464 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
3465 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
3466 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
3467 vmware_sessionfile | **Optional.** Session file name enhancement.
3468 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
3469 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
3470 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
3471 vmware_password | **Optional.** The username's password. No value defined as default.
3472 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
3473 vmware_warn | **Optional.** The warning threshold. No value defined as default.
3474 vmware_crit | **Optional.** The critical threshold. No value defined as default.
3477 ##### <a id="plugin-contrib-vmware-esx-soap-host-io-write-latency"></a> vmware-esx-soap-host-io-write-latency
3479 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.
3481 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
3484 ------------------------|--------------
3485 vmware_host | **Required.** ESX or ESXi hostname.
3486 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. In case the check is done through a Datacenter/vCenter host.
3487 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
3488 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
3489 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
3490 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
3491 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
3492 vmware_sessionfile | **Optional.** Session file name enhancement.
3493 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
3494 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
3495 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
3496 vmware_password | **Optional.** The username's password. No value defined as default.
3497 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
3498 vmware_warn | **Optional.** The warning threshold. No value defined as default.
3499 vmware_crit | **Optional.** The critical threshold. No value defined as default.
3502 ##### <a id="plugin-contrib-vmware-esx-soap-host-io-usage"></a> vmware-esx-soap-host-io-usage
3504 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.
3506 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
3509 ------------------------|--------------
3510 vmware_host | **Required.** ESX or ESXi hostname.
3511 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. In case the check is done through a Datacenter/vCenter host.
3512 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
3513 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
3514 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
3515 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
3516 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
3517 vmware_sessionfile | **Optional.** Session file name enhancement.
3518 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
3519 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
3520 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
3521 vmware_password | **Optional.** The username's password. No value defined as default.
3522 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
3523 vmware_warn | **Optional.** The warning threshold. No value defined as default.
3524 vmware_crit | **Optional.** The critical threshold. No value defined as default.
3527 ##### <a id="plugin-contrib-vmware-esx-soap-host-io-kernel-latency"></a> vmware-esx-soap-host-io-kernel-latency
3529 Check command object for the `check_vmware_esx` plugin. Average amount of time (ms) spent by VMkernel processing each SCSI command.
3531 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
3534 ------------------------|--------------
3535 vmware_host | **Required.** ESX or ESXi hostname.
3536 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. In case the check is done through a Datacenter/vCenter host.
3537 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
3538 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
3539 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
3540 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
3541 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
3542 vmware_sessionfile | **Optional.** Session file name enhancement.
3543 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
3544 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
3545 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
3546 vmware_password | **Optional.** The username's password. No value defined as default.
3547 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
3548 vmware_warn | **Optional.** The warning threshold. No value defined as default.
3549 vmware_crit | **Optional.** The critical threshold. No value defined as default.
3552 ##### <a id="plugin-contrib-vmware-esx-soap-host-io-device-latency"></a> vmware-esx-soap-host-io-device-latency
3554 Check command object for the `check_vmware_esx` plugin. Average amount of time (ms) to complete a SCSI command from the physical device.
3556 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
3559 ------------------------|--------------
3560 vmware_host | **Required.** ESX or ESXi hostname.
3561 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. In case the check is done through a Datacenter/vCenter host.
3562 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
3563 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
3564 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
3565 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
3566 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
3567 vmware_sessionfile | **Optional.** Session file name enhancement.
3568 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
3569 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
3570 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
3571 vmware_password | **Optional.** The username's password. No value defined as default.
3572 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
3573 vmware_warn | **Optional.** The warning threshold. No value defined as default.
3574 vmware_crit | **Optional.** The critical threshold. No value defined as default.
3577 ##### <a id="plugin-contrib-vmware-esx-soap-host-io-queue-latency"></a> vmware-esx-soap-host-io-queue-latency
3579 Check command object for the `check_vmware_esx` plugin. Average amount of time (ms) spent in the VMkernel queue.
3581 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
3584 ------------------------|--------------
3585 vmware_host | **Required.** ESX or ESXi hostname.
3586 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. In case the check is done through a Datacenter/vCenter host.
3587 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
3588 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
3589 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
3590 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
3591 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
3592 vmware_sessionfile | **Optional.** Session file name enhancement.
3593 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
3594 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
3595 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
3596 vmware_password | **Optional.** The username's password. No value defined as default.
3597 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
3598 vmware_warn | **Optional.** The warning threshold. No value defined as default.
3599 vmware_crit | **Optional.** The critical threshold. No value defined as default.
3602 ##### <a id="plugin-contrib-vmware-esx-soap-host-io-total-latency"></a> vmware-esx-soap-host-io-total-latency
3604 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.
3606 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
3609 ------------------------|--------------
3610 vmware_host | **Required.** ESX or ESXi hostname.
3611 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. In case the check is done through a Datacenter/vCenter host.
3612 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
3613 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
3614 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
3615 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
3616 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
3617 vmware_sessionfile | **Optional.** Session file name enhancement.
3618 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
3619 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
3620 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
3621 vmware_password | **Optional.** The username's password. No value defined as default.
3622 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
3623 vmware_warn | **Optional.** The warning threshold. No value defined as default.
3624 vmware_crit | **Optional.** The critical threshold. No value defined as default.
3627 ##### <a id="plugin-contrib-vmware-esx-soap-host-media"></a> vmware-esx-soap-host-media
3629 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.
3631 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
3634 ------------------------|--------------
3635 vmware_host | **Required.** ESX or ESXi hostname.
3636 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. In case the check is done through a Datacenter/vCenter host.
3637 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
3638 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
3639 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
3640 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
3641 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
3642 vmware_sessionfile | **Optional.** Session file name enhancement.
3643 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
3644 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
3645 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
3646 vmware_password | **Optional.** The username's password. No value defined as default.
3647 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
3648 vmware_exclude | **Optional.** Blacklist VMs name. No value defined as default.
3649 vmware_include | **Optional.** Whitelist VMs name. No value defined as default.
3650 vmware_isregexp | **Optional.** Treat blacklist and whitelist expressions as regexp.
3651 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.
3654 ##### <a id="plugin-contrib-vmware-esx-soap-host-service"></a> vmware-esx-soap-host-service
3656 Check command object for the `check_vmware_esx` plugin. Shows host service info.
3658 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
3661 ------------------------|--------------
3662 vmware_host | **Required.** ESX or ESXi hostname.
3663 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. In case the check is done through a Datacenter/vCenter host.
3664 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
3665 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
3666 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
3667 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
3668 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
3669 vmware_sessionfile | **Optional.** Session file name enhancement.
3670 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
3671 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
3672 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
3673 vmware_password | **Optional.** The username's password. No value defined as default.
3674 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
3675 vmware_exclude | **Optional.** Blacklist services name. No value defined as default.
3676 vmware_include | **Optional.** Whitelist services name. No value defined as default.
3677 vmware_isregexp | **Optional.** Treat blacklist and whitelist expressions as regexp.
3678 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.
3681 ##### <a id="plugin-contrib-vmware-esx-soap-host-runtime"></a> vmware-esx-soap-host-runtime
3683 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.
3685 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
3688 ------------------------|--------------
3689 vmware_host | **Required.** ESX or ESXi hostname.
3690 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. In case the check is done through a Datacenter/vCenter host.
3691 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
3692 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
3693 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
3694 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
3695 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
3696 vmware_sessionfile | **Optional.** Session file name enhancement.
3697 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
3698 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
3699 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
3700 vmware_password | **Optional.** The username's password. No value defined as default.
3701 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
3704 ##### <a id="plugin-contrib-vmware-esx-soap-host-runtime-con"></a> vmware-esx-soap-host-runtime-con
3706 Check command object for the `check_vmware_esx` plugin. Shows connection state.
3708 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
3711 ------------------------|--------------
3712 vmware_host | **Required.** ESX or ESXi hostname.
3713 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. In case the check is done through a Datacenter/vCenter host.
3714 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
3715 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
3716 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
3717 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
3718 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
3719 vmware_sessionfile | **Optional.** Session file name enhancement.
3720 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
3721 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
3722 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
3723 vmware_password | **Optional.** The username's password. No value defined as default.
3724 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
3727 ##### <a id="plugin-contrib-vmware-esx-soap-host-runtime-listvms"></a> vmware-esx-soap-host-runtime-listvms
3729 Check command object for the `check_vmware_esx` plugin. List of VMware machines and their status.
3731 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
3734 ------------------------|--------------
3735 vmware_host | **Required.** ESX or ESXi hostname.
3736 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. In case the check is done through a Datacenter/vCenter host.
3737 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
3738 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
3739 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
3740 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
3741 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
3742 vmware_sessionfile | **Optional.** Session file name enhancement.
3743 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
3744 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
3745 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
3746 vmware_password | **Optional.** The username's password. No value defined as default.
3747 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
3748 vmware_exclude | **Optional.** Blacklist VMs name. No value defined as default.
3749 vmware_include | **Optional.** Whitelist VMs name. No value defined as default.
3750 vmware_isregexp | **Optional.** Treat blacklist and whitelist expressions as regexp.
3751 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.
3754 ##### <a id="plugin-contrib-vmware-esx-soap-host-runtime-status"></a> vmware-esx-soap-host-runtime-status
3756 Check command object for the `check_vmware_esx` plugin. Overall object status (gray/green/red/yellow).
3758 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
3761 ------------------------|--------------
3762 vmware_host | **Required.** ESX or ESXi hostname.
3763 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. In case the check is done through a Datacenter/vCenter host.
3764 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
3765 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
3766 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
3767 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
3768 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
3769 vmware_sessionfile | **Optional.** Session file name enhancement.
3770 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
3771 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
3772 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
3773 vmware_password | **Optional.** The username's password. No value defined as default.
3774 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
3777 ##### <a id="plugin-contrib-vmware-esx-soap-host-runtime-health"></a> vmware-esx-soap-host-runtime-health
3779 Check command object for the `check_vmware_esx` plugin. Checks cpu/storage/memory/sensor status.
3781 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
3784 ------------------------|--------------
3785 vmware_host | **Required.** ESX or ESXi hostname.
3786 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. In case the check is done through a Datacenter/vCenter host.
3787 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
3788 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
3789 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
3790 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
3791 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
3792 vmware_sessionfile | **Optional.** Session file name enhancement.
3793 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
3794 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
3795 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
3796 vmware_password | **Optional.** The username's password. No value defined as default.
3797 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
3798 vmware_exclude | **Optional.** Blacklist status name. No value defined as default.
3799 vmware_include | **Optional.** Whitelist status name. No value defined as default.
3800 vmware_isregexp | **Optional.** Treat blacklist and whitelist expressions as regexp.
3803 ##### <a id="plugin-contrib-vmware-esx-soap-host-runtime-health-listsensors"></a> vmware-esx-soap-host-runtime-health-listsensors
3805 Check command object for the `check_vmware_esx` plugin. List all available sensors(use for listing purpose only).
3807 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
3810 ------------------------|--------------
3811 vmware_host | **Required.** ESX or ESXi hostname.
3812 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. In case the check is done through a Datacenter/vCenter host.
3813 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
3814 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
3815 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
3816 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
3817 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
3818 vmware_sessionfile | **Optional.** Session file name enhancement.
3819 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
3820 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
3821 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
3822 vmware_password | **Optional.** The username's password. No value defined as default.
3823 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
3824 vmware_exclude | **Optional.** Blacklist status name. No value defined as default.
3825 vmware_include | **Optional.** Whitelist status name. No value defined as default.
3826 vmware_isregexp | **Optional.** Treat blacklist and whitelist expressions as regexp.
3829 ##### <a id="plugin-contrib-vmware-esx-soap-host-runtime-health-nostoragestatus"></a> vmware-esx-soap-host-runtime-health-nostoragestatus
3831 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**.
3833 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
3836 ------------------------|--------------
3837 vmware_host | **Required.** ESX or ESXi hostname.
3838 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. In case the check is done through a Datacenter/vCenter host.
3839 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
3840 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
3841 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
3842 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
3843 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
3844 vmware_sessionfile | **Optional.** Session file name enhancement.
3845 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
3846 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
3847 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
3848 vmware_password | **Optional.** The username's password. No value defined as default.
3849 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
3850 vmware_exclude | **Optional.** Blacklist status name. No value defined as default.
3851 vmware_include | **Optional.** Whitelist status name. No value defined as default.
3852 vmware_isregexp | **Optional.** Treat blacklist and whitelist expressions as regexp.
3855 ##### <a id="plugin-contrib-vmware-esx-soap-host-runtime-storagehealth"></a> vmware-esx-soap-host-runtime-storagehealth
3857 Check command object for the `check_vmware_esx` plugin. Local storage status check.
3859 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
3862 ------------------------|--------------
3863 vmware_host | **Required.** ESX or ESXi hostname.
3864 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. In case the check is done through a Datacenter/vCenter host.
3865 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
3866 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
3867 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
3868 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
3869 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
3870 vmware_sessionfile | **Optional.** Session file name enhancement.
3871 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
3872 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
3873 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
3874 vmware_password | **Optional.** The username's password. No value defined as default.
3875 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
3876 vmware_exclude | **Optional.** Blacklist storage name. No value defined as default.
3877 vmware_include | **Optional.** Whitelist storage name. No value defined as default.
3878 vmware_isregexp | **Optional.** Treat blacklist and whitelist expressions as regexp.
3879 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.
3882 ##### <a id="plugin-contrib-vmware-esx-soap-host-runtime-temp"></a> vmware-esx-soap-host-runtime-temp
3884 Check command object for the `check_vmware_esx` plugin. Lists all temperature sensors.
3886 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
3889 ------------------------|--------------
3890 vmware_host | **Required.** ESX or ESXi hostname.
3891 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. In case the check is done through a Datacenter/vCenter host.
3892 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
3893 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
3894 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
3895 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
3896 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
3897 vmware_sessionfile | **Optional.** Session file name enhancement.
3898 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
3899 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
3900 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
3901 vmware_password | **Optional.** The username's password. No value defined as default.
3902 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
3903 vmware_exclude | **Optional.** Blacklist sensor name. No value defined as default.
3904 vmware_include | **Optional.** Whitelist sensor name. No value defined as default.
3905 vmware_isregexp | **Optional.** Treat blacklist and whitelist expressions as regexp.
3906 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.
3909 ##### <a id="plugin-contrib-vmware-esx-soap-host-runtime-issues"></a> vmware-esx-soap-host-runtime-issues
3911 Check command object for the `check_vmware_esx` plugin. Lists all configuration issues for the host.
3913 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
3916 ------------------------|--------------
3917 vmware_host | **Required.** ESX or ESXi hostname.
3918 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. In case the check is done through a Datacenter/vCenter host.
3919 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
3920 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
3921 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
3922 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
3923 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
3924 vmware_sessionfile | **Optional.** Session file name enhancement.
3925 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
3926 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
3927 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
3928 vmware_password | **Optional.** The username's password. No value defined as default.
3929 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
3930 vmware_exclude | **Optional.** Blacklist configuration issues. No value defined as default.
3931 vmware_include | **Optional.** Whitelist configuration issues. No value defined as default.
3932 vmware_isregexp | **Optional.** Treat blacklist and whitelist expressions as regexp.
3933 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.
3936 ##### <a id="plugin-contrib-vmware-esx-soap-host-storage"></a> vmware-esx-soap-host-storage
3938 Check command object for the `check_vmware_esx` plugin. Shows Host storage info.
3940 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
3943 ------------------------|--------------
3944 vmware_host | **Required.** ESX or ESXi hostname.
3945 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. In case the check is done through a Datacenter/vCenter host.
3946 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
3947 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
3948 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
3949 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
3950 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
3951 vmware_sessionfile | **Optional.** Session file name enhancement.
3952 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
3953 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
3954 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
3955 vmware_password | **Optional.** The username's password. No value defined as default.
3956 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
3957 vmware_exclude | **Optional.** Blacklist adapters, luns and paths. No value defined as default.
3958 vmware_include | **Optional.** Whitelist adapters, luns and paths. No value defined as default.
3959 vmware_isregexp | **Optional.** Treat blacklist and whitelist expressions as regexp.
3962 ##### <a id="plugin-contrib-vmware-esx-soap-host-storage-adapter"></a> vmware-esx-soap-host-storage-adapter
3964 Check command object for the `check_vmware_esx` plugin. List host bus adapters.
3966 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
3969 ------------------------|--------------
3970 vmware_host | **Required.** ESX or ESXi hostname.
3971 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. In case the check is done through a Datacenter/vCenter host.
3972 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
3973 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
3974 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
3975 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
3976 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
3977 vmware_sessionfile | **Optional.** Session file name enhancement.
3978 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
3979 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
3980 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
3981 vmware_password | **Optional.** The username's password. No value defined as default.
3982 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
3983 vmware_exclude | **Optional.** Blacklist adapters. No value defined as default.
3984 vmware_include | **Optional.** Whitelist adapters. No value defined as default.
3985 vmware_isregexp | **Optional.** Treat blacklist and whitelist expressions as regexp.
3986 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.
3989 ##### <a id="plugin-contrib-vmware-esx-soap-host-storage-lun"></a> vmware-esx-soap-host-storage-lun
3991 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.
3993 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
3996 ------------------------|--------------
3997 vmware_host | **Required.** ESX or ESXi hostname.
3998 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. In case the check is done through a Datacenter/vCenter host.
3999 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
4000 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
4001 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
4002 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
4003 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
4004 vmware_sessionfile | **Optional.** Session file name enhancement.
4005 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
4006 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
4007 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
4008 vmware_password | **Optional.** The username's password. No value defined as default.
4009 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
4010 vmware_exclude | **Optional.** Blacklist luns. No value defined as default.
4011 vmware_include | **Optional.** Whitelist luns. No value defined as default.
4012 vmware_isregexp | **Optional.** Treat blacklist and whitelist expressions as regexp.
4013 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.
4016 ##### <a id="plugin-contrib-vmware-esx-soap-host-storage-path"></a> vmware-esx-soap-host-storage-path
4018 Check command object for the `check_vmware_esx` plugin. List multipaths and the associated paths.
4020 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
4023 ------------------------|--------------
4024 vmware_host | **Required.** ESX or ESXi hostname.
4025 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. In case the check is done through a Datacenter/vCenter host.
4026 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
4027 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
4028 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
4029 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
4030 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
4031 vmware_sessionfile | **Optional.** Session file name enhancement.
4032 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
4033 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
4034 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
4035 vmware_password | **Optional.** The username's password. No value defined as default.
4036 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
4037 vmware_alertonly | **Optional.** List only alerting units. Important here to avoid masses of data. Defaults to "false".
4038 vmware_exclude | **Optional.** Blacklist paths. No value defined as default.
4039 vmware_include | **Optional.** Whitelist paths. No value defined as default.
4040 vmware_isregexp | **Optional.** Treat blacklist and whitelist expressions as regexp.
4041 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.
4044 ##### <a id="plugin-contrib-vmware-esx-soap-vm-cpu"></a> vmware-esx-soap-vm-cpu
4046 Check command object for the `check_vmware_esx` plugin. Shows all CPU usage info.
4048 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
4051 ------------------------|--------------
4052 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. Conflicts with **vmware_host**.
4053 vmware_host | **Optional.** ESX or ESXi hostname. Conflicts with **vmware_datacenter**.
4054 vmware_vmname | **Required.** Virtual machine name.
4055 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
4056 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
4057 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
4058 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
4059 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
4060 vmware_sessionfile | **Optional.** Session file name enhancement.
4061 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
4062 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
4063 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
4064 vmware_password | **Optional.** The username's password. No value defined as default.
4065 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
4069 ##### <a id="plugin-contrib-vmware-esx-soap-vm-cpu-ready"></a> vmware-esx-soap-vm-cpu-ready
4071 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.
4073 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
4076 ------------------------|--------------
4077 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. Conflicts with **vmware_host**.
4078 vmware_host | **Optional.** ESX or ESXi hostname. Conflicts with **vmware_datacenter**.
4079 vmware_vmname | **Required.** Virtual machine name.
4080 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
4081 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
4082 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
4083 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
4084 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
4085 vmware_sessionfile | **Optional.** Session file name enhancement.
4086 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
4087 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
4088 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
4089 vmware_password | **Optional.** The username's password. No value defined as default.
4090 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
4091 vmware_warn | **Optional.** The warning threshold. No value defined as default.
4092 vmware_crit | **Optional.** The critical threshold. No value defined as default.
4095 ##### <a id="plugin-contrib-vmware-esx-soap-vm-cpu-wait"></a> vmware-esx-soap-vm-cpu-wait
4097 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.
4099 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
4102 ------------------------|--------------
4103 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. Conflicts with **vmware_host**.
4104 vmware_host | **Optional.** ESX or ESXi hostname. Conflicts with **vmware_datacenter**.
4105 vmware_vmname | **Required.** Virtual machine name.
4106 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
4107 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
4108 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
4109 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
4110 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
4111 vmware_sessionfile | **Optional.** Session file name enhancement.
4112 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
4113 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
4114 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
4115 vmware_password | **Optional.** The username's password. No value defined as default.
4116 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
4117 vmware_warn | **Optional.** The warning threshold. No value defined as default.
4118 vmware_crit | **Optional.** The critical threshold. No value defined as default.
4121 ##### <a id="plugin-contrib-vmware-esx-soap-vm-cpu-usage"></a> vmware-esx-soap-vm-cpu-usage
4123 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.
4125 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
4128 ------------------------|--------------
4129 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. Conflicts with **vmware_host**.
4130 vmware_host | **Optional.** ESX or ESXi hostname. Conflicts with **vmware_datacenter**.
4131 vmware_vmname | **Required.** Virtual machine name.
4132 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
4133 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
4134 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
4135 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
4136 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
4137 vmware_sessionfile | **Optional.** Session file name enhancement.
4138 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
4139 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
4140 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
4141 vmware_password | **Optional.** The username's password. No value defined as default.
4142 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
4143 vmware_warn | **Optional.** Warning threshold in percent. Defaults to "80%".
4144 vmware_crit | **Optional.** Critical threshold in percent. Defaults to "90%".
4147 ##### <a id="plugin-contrib-vmware-esx-soap-vm-mem"></a> vmware-esx-soap-vm-mem
4149 Check command object for the `check_vmware_esx` plugin. Shows all memory info, except overall.
4151 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
4154 ------------------------|--------------
4155 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. Conflicts with **vmware_host**.
4156 vmware_host | **Optional.** ESX or ESXi hostname. Conflicts with **vmware_datacenter**.
4157 vmware_vmname | **Required.** Virtual machine name.
4158 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
4159 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
4160 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
4161 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
4162 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
4163 vmware_sessionfile | **Optional.** Session file name enhancement.
4164 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
4165 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
4166 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
4167 vmware_password | **Optional.** The username's password. No value defined as default.
4168 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
4171 ##### <a id="plugin-contrib-vmware-esx-soap-vm-mem-usage"></a> vmware-esx-soap-vm-mem-usage
4173 Check command object for the `check_vmware_esx` plugin. Average mem usage in percentage of configured virtual machine "physical" memory.
4175 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
4178 ------------------------|--------------
4179 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. Conflicts with **vmware_host**.
4180 vmware_host | **Optional.** ESX or ESXi hostname. Conflicts with **vmware_datacenter**.
4181 vmware_vmname | **Required.** Virtual machine name.
4182 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
4183 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
4184 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
4185 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
4186 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
4187 vmware_sessionfile | **Optional.** Session file name enhancement.
4188 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
4189 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
4190 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
4191 vmware_password | **Optional.** The username's password. No value defined as default.
4192 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
4193 vmware_warn | **Optional.** Warning threshold in percent. Defaults to "80%".
4194 vmware_crit | **Optional.** Critical threshold in percent. Defaults to "90%".
4197 ##### <a id="plugin-contrib-vmware-esx-soap-vm-mem-consumed"></a> vmware-esx-soap-vm-mem-consumed
4199 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>
4200 **vm consumed memory = memory granted -- memory saved**
4202 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
4205 ------------------------|--------------
4206 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. Conflicts with **vmware_host**.
4207 vmware_host | **Optional.** ESX or ESXi hostname. Conflicts with **vmware_datacenter**.
4208 vmware_vmname | **Required.** Virtual machine name.
4209 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
4210 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
4211 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
4212 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
4213 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
4214 vmware_sessionfile | **Optional.** Session file name enhancement.
4215 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
4216 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
4217 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
4218 vmware_password | **Optional.** The username's password. No value defined as default.
4219 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
4220 vmware_warn | **Optional.** The warning threshold. No value defined as default.
4221 vmware_crit | **Optional.** The critical threshold. No value defined as default.
4224 ##### <a id="plugin-contrib-vmware-esx-soap-vm-mem-memctl"></a> vmware-esx-soap-vm-mem-memctl
4226 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.
4228 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
4231 ------------------------|--------------
4232 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. Conflicts with **vmware_host**.
4233 vmware_host | **Optional.** ESX or ESXi hostname. Conflicts with **vmware_datacenter**.
4234 vmware_vmname | **Required.** Virtual machine name.
4235 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
4236 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
4237 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
4238 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
4239 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
4240 vmware_sessionfile | **Optional.** Session file name enhancement.
4241 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
4242 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
4243 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
4244 vmware_password | **Optional.** The username's password. No value defined as default.
4245 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
4246 vmware_warn | **Optional.** The warning threshold. No value defined as default.
4247 vmware_crit | **Optional.** The critical threshold. No value defined as default.
4251 ##### <a id="plugin-contrib-vmware-esx-soap-vm-net"></a> vmware-esx-soap-vm-net
4253 Check command object for the `check_vmware_esx` plugin. Shows net info.
4255 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
4258 ------------------------|--------------
4259 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. Conflicts with **vmware_host**.
4260 vmware_host | **Optional.** ESX or ESXi hostname. Conflicts with **vmware_datacenter**.
4261 vmware_vmname | **Required.** Virtual machine name.
4262 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
4263 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
4264 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
4265 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
4266 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
4267 vmware_sessionfile | **Optional.** Session file name enhancement.
4268 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
4269 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
4270 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
4271 vmware_password | **Optional.** The username's password. No value defined as default.
4272 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
4275 ##### <a id="plugin-contrib-vmware-esx-soap-vm-net-usage"></a> vmware-esx-soap-vm-net-usage
4277 Check command object for the `check_vmware_esx` plugin. Overall network usage in KBps(Kilobytes per Second).
4279 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
4282 ------------------------|--------------
4283 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. Conflicts with **vmware_host**.
4284 vmware_host | **Optional.** ESX or ESXi hostname. Conflicts with **vmware_datacenter**.
4285 vmware_vmname | **Required.** Virtual machine name.
4286 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
4287 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
4288 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
4289 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
4290 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
4291 vmware_sessionfile | **Optional.** Session file name enhancement.
4292 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
4293 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
4294 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
4295 vmware_password | **Optional.** The username's password. No value defined as default.
4296 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
4297 vmware_warn | **Optional.** The warning threshold. No value defined as default.
4298 vmware_crit | **Optional.** The critical threshold. No value defined as default.
4301 ##### <a id="plugin-contrib-vmware-esx-soap-vm-net-receive"></a> vmware-esx-soap-vm-net-receive
4303 Check command object for the `check_vmware_esx` plugin. Receive in KBps(Kilobytes per Second).
4305 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
4308 ------------------------|--------------
4309 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. Conflicts with **vmware_host**.
4310 vmware_host | **Optional.** ESX or ESXi hostname. Conflicts with **vmware_datacenter**.
4311 vmware_vmname | **Required.** Virtual machine name.
4312 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
4313 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
4314 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
4315 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
4316 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
4317 vmware_sessionfile | **Optional.** Session file name enhancement.
4318 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
4319 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
4320 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
4321 vmware_password | **Optional.** The username's password. No value defined as default.
4322 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
4323 vmware_warn | **Optional.** The warning threshold. No value defined as default.
4324 vmware_crit | **Optional.** The critical threshold. No value defined as default.
4327 ##### <a id="plugin-contrib-vmware-esx-soap-vm-net-send"></a> vmware-esx-soap-vm-net-send
4329 Check command object for the `check_vmware_esx` plugin. Send in KBps(Kilobytes per Second).
4331 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
4334 ------------------------|--------------
4335 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. Conflicts with **vmware_host**.
4336 vmware_host | **Optional.** ESX or ESXi hostname. Conflicts with **vmware_datacenter**.
4337 vmware_vmname | **Required.** Virtual machine name.
4338 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
4339 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
4340 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
4341 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
4342 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
4343 vmware_sessionfile | **Optional.** Session file name enhancement.
4344 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
4345 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
4346 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
4347 vmware_password | **Optional.** The username's password. No value defined as default.
4348 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
4349 vmware_warn | **Optional.** The warning threshold. No value defined as default.
4350 vmware_crit | **Optional.** The critical threshold. No value defined as default.
4353 ##### <a id="plugin-contrib-vmware-esx-soap-vm-io"></a> vmware-esx-soap-vm-io
4355 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.
4357 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
4360 ------------------------|--------------
4361 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. Conflicts with **vmware_host**.
4362 vmware_host | **Optional.** ESX or ESXi hostname. Conflicts with **vmware_datacenter**.
4363 vmware_vmname | **Required.** Virtual machine name.
4364 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
4365 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
4366 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
4367 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
4368 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
4369 vmware_sessionfile | **Optional.** Session file name enhancement.
4370 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
4371 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
4372 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
4373 vmware_password | **Optional.** The username's password. No value defined as default.
4374 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
4377 ##### <a id="plugin-contrib-vmware-esx-soap-vm-io-read"></a> vmware-esx-soap-vm-io-read
4379 Check command object for the `check_vmware_esx` plugin. Average number of kilobytes read from the disk each second.
4381 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
4384 ------------------------|--------------
4385 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. Conflicts with **vmware_host**.
4386 vmware_host | **Optional.** ESX or ESXi hostname. Conflicts with **vmware_datacenter**.
4387 vmware_vmname | **Required.** Virtual machine name.
4388 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
4389 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
4390 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
4391 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
4392 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
4393 vmware_sessionfile | **Optional.** Session file name enhancement.
4394 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
4395 vmware_nosession | **Optional.** No auth session - IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
4396 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
4397 vmware_password | **Optional.** The username's password. No value defined as default.
4398 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
4399 vmware_warn | **Optional.** The warning threshold. No value defined as default.
4400 vmware_crit | **Optional.** The critical threshold. No value defined as default.
4403 ##### <a id="plugin-contrib-vmware-esx-soap-vm-io-write"></a> vmware-esx-soap-vm-io-write
4405 Check command object for the `check_vmware_esx` plugin. Average number of kilobytes written to disk each second.
4407 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
4410 ------------------------|--------------
4411 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. Conflicts with **vmware_host**.
4412 vmware_host | **Optional.** ESX or ESXi hostname. Conflicts with **vmware_datacenter**.
4413 vmware_vmname | **Required.** Virtual machine name.
4414 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
4415 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
4416 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
4417 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
4418 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
4419 vmware_sessionfile | **Optional.** Session file name enhancement.
4420 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
4421 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
4422 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
4423 vmware_password | **Optional.** The username's password. No value defined as default.
4424 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
4425 vmware_warn | **Optional.** The warning threshold. No value defined as default.
4426 vmware_crit | **Optional.** The critical threshold. No value defined as default.
4429 ##### <a id="plugin-contrib-vmware-esx-soap-vm-io-usage"></a> vmware-esx-soap-vm-io-usage
4431 Check command object for the `check_vmware_esx` plugin. Aggregated disk I/O rate.
4433 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
4436 ------------------------|--------------
4437 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. Conflicts with **vmware_host**.
4438 vmware_host | **Optional.** ESX or ESXi hostname. Conflicts with **vmware_datacenter**.
4439 vmware_vmname | **Required.** Virtual machine name.
4440 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
4441 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
4442 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
4443 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
4444 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
4445 vmware_sessionfile | **Optional.** Session file name enhancement.
4446 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
4447 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
4448 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
4449 vmware_password | **Optional.** The username's password. No value defined as default.
4450 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
4451 vmware_warn | **Optional.** The warning threshold. No value defined as default.
4452 vmware_crit | **Optional.** The critical threshold. No value defined as default.
4455 ##### <a id="plugin-contrib-vmware-esx-soap-vm-runtime"></a> vmware-esx-soap-vm-runtime
4457 Check command object for the `check_vmware_esx` plugin. Shows virtual machine runtime info.
4459 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
4462 ------------------------|--------------
4463 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. Conflicts with **vmware_host**.
4464 vmware_host | **Optional.** ESX or ESXi hostname. Conflicts with **vmware_datacenter**.
4465 vmware_vmname | **Required.** Virtual machine name.
4466 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
4467 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
4468 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
4469 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
4470 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
4471 vmware_sessionfile | **Optional.** Session file name enhancement.
4472 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
4473 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
4474 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
4475 vmware_password | **Optional.** The username's password. No value defined as default.
4476 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
4479 ##### <a id="plugin-contrib-vmware-esx-soap-vm-runtime-con"></a> vmware-esx-soap-vm-runtime-con
4481 Check command object for the `check_vmware_esx` plugin. Shows the connection state.
4483 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
4486 ------------------------|--------------
4487 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. Conflicts with **vmware_host**.
4488 vmware_host | **Optional.** ESX or ESXi hostname. Conflicts with **vmware_datacenter**.
4489 vmware_vmname | **Required.** Virtual machine name.
4490 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
4491 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
4492 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
4493 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
4494 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
4495 vmware_sessionfile | **Optional.** Session file name enhancement.
4496 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
4497 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
4498 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
4499 vmware_password | **Optional.** The username's password. No value defined as default.
4500 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
4503 ##### <a id="plugin-contrib-vmware-esx-soap-vm-runtime-powerstate"></a> vmware-esx-soap-vm-runtime-powerstate
4505 Check command object for the `check_vmware_esx` plugin. Shows virtual machine power state: poweredOn, poweredOff or suspended.
4507 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
4510 ------------------------|--------------
4511 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. Conflicts with **vmware_host**.
4512 vmware_host | **Optional.** ESX or ESXi hostname. Conflicts with **vmware_datacenter**.
4513 vmware_vmname | **Required.** Virtual machine name.
4514 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
4515 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
4516 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
4517 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
4518 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
4519 vmware_sessionfile | **Optional.** Session file name enhancement.
4520 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
4521 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
4522 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
4523 vmware_password | **Optional.** The username's password. No value defined as default.
4524 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
4527 ##### <a id="plugin-contrib-vmware-esx-soap-vm-runtime-status"></a> vmware-esx-soap-vm-runtime-status
4529 Check command object for the `check_vmware_esx` plugin. Overall object status (gray/green/red/yellow).
4531 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
4534 ------------------------|--------------
4535 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. Conflicts with **vmware_host**.
4536 vmware_host | **Optional.** ESX or ESXi hostname. Conflicts with **vmware_datacenter**.
4537 vmware_vmname | **Required.** Virtual machine name.
4538 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
4539 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
4540 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
4541 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
4542 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
4543 vmware_sessionfile | **Optional.** Session file name enhancement.
4544 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
4545 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
4546 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
4547 vmware_password | **Optional.** The username's password. No value defined as default.
4548 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
4551 ##### <a id="plugin-contrib-vmware-esx-soap-vm-runtime-consoleconnections"></a> vmware-esx-soap-vm-runtime-consoleconnections
4553 Check command object for the `check_vmware_esx` plugin. Console connections to virtual machine.
4555 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
4558 ------------------------|--------------
4559 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. Conflicts with **vmware_host**.
4560 vmware_host | **Optional.** ESX or ESXi hostname. Conflicts with **vmware_datacenter**.
4561 vmware_vmname | **Required.** Virtual machine name.
4562 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
4563 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
4564 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
4565 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
4566 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
4567 vmware_sessionfile | **Optional.** Session file name enhancement.
4568 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
4569 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
4570 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
4571 vmware_password | **Optional.** The username's password. No value defined as default.
4572 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
4573 vmware_warn | **Optional.** The warning threshold. No value defined as default.
4574 vmware_crit | **Optional.** The critical threshold. No value defined as default.
4577 ##### <a id="plugin-contrib-vmware-esx-soap-vm-runtime-gueststate"></a> vmware-esx-soap-vm-runtime-gueststate
4579 Check command object for the `check_vmware_esx` plugin. Guest OS status. Needs VMware Tools installed and running.
4581 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
4584 ------------------------|--------------
4585 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. Conflicts with **vmware_host**.
4586 vmware_host | **Optional.** ESX or ESXi hostname. Conflicts with **vmware_datacenter**.
4587 vmware_vmname | **Required.** Virtual machine name.
4588 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
4589 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
4590 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
4591 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
4592 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
4593 vmware_sessionfile | **Optional.** Session file name enhancement.
4594 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
4595 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
4596 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
4597 vmware_password | **Optional.** The username's password. No value defined as default.
4598 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
4600 ##### <a id="plugin-contrib-vmware-esx-soap-vm-runtime-tools"></a> vmware-esx-soap-vm-runtime-tools
4602 Check command object for the `check_vmware_esx` plugin. Guest OS status. VMware tools status.
4604 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
4607 ------------------------|--------------
4608 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. Conflicts with **vmware_host**.
4609 vmware_host | **Optional.** ESX or ESXi hostname. Conflicts with **vmware_datacenter**.
4610 vmware_vmname | **Required.** Virtual machine name.
4611 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
4612 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
4613 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
4614 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
4615 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
4616 vmware_sessionfile | **Optional.** Session file name enhancement.
4617 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
4618 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
4619 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
4620 vmware_password | **Optional.** The username's password. No value defined as default.
4621 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
4622 vmware_openvmtools | **Optional** Prevent CRITICAL state for installed and running Open VM Tools.
4625 ##### <a id="plugin-contrib-vmware-esx-soap-vm-runtime-issues"></a> vmware-esx-soap-vm-runtime-issues
4627 Check command object for the `check_vmware_esx` plugin. All issues for the virtual machine.
4629 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
4632 ------------------------|--------------
4633 vmware_datacenter | **Optional.** Datacenter/vCenter hostname. Conflicts with **vmware_host**.
4634 vmware_host | **Optional.** ESX or ESXi hostname. Conflicts with **vmware_datacenter**.
4635 vmware_vmname | **Required.** Virtual machine name.
4636 vmware_sslport | **Optional.** SSL port connection. Defaults to "443".
4637 vmware_ignoreunknown | **Optional.** Sometimes 3 (unknown) is returned from a component. But the check itself is ok. With this option the plugin will return OK (0) instead of UNKNOWN (3). Defaults to "false".
4638 vmware_ignorewarning | **Optional.** Sometimes 2 (warning) is returned from a component. But the check itself is ok (from an operator view). With this option the plugin will return OK (0) instead of WARNING (1). Defaults to "false".
4639 vmware_timeout | **Optional.** Seconds before plugin times out. Defaults to "90".
4640 vmware_trace | **Optional.** Set verbosity level of vSphere API request/respond trace.
4641 vmware_sessionfile | **Optional.** Session file name enhancement.
4642 vmware_sessionfiledir | **Optional.** Path to store the **vmware_sessionfile** file. Defaults to "/var/spool/icinga2/tmp".
4643 vmware_nosession | **Optional.** No auth session -- IT SHOULD BE USED FOR TESTING PURPOSES ONLY!. Defaults to "false".
4644 vmware_username | **Optional.** The username to connect to Host or vCenter server. No value defined as default.
4645 vmware_password | **Optional.** The username's password. No value defined as default.
4646 vmware_authfile | **Optional.** Use auth file instead username/password to session connect. No effect if **vmware_username** and **vmware_password** are defined <br> **Autentication file content:** <br> username=vmuser <br> password=p@ssw0rd
4647 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.
4650 ### <a id="plugin-contrib-web"></a> Web
4652 This category includes all plugins for web-based checks.
4654 #### <a id="plugin-contrib-command-webinject"></a> webinject
4656 Check command object for the [check_webinject](http://www.webinject.org/manual.html) plugin.
4658 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
4661 ------------------------|--------------
4662 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.
4663 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.
4664 webinject_no_output | **Optional.** Suppresses all output to STDOUT except the results summary.
4665 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.
4666 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.
4667 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.
4669 #### <a id="plugin-contrib-command-jmx4perl"></a> jmx4perl
4671 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.
4673 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
4676 -----------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------
4677 jmx4perl_url | **Required.** URL to agent web application. Defaults to "http://$address$:8080/jolokia".
4678 jmx4perl_product | **Optional.** Name of app server product (e.g. jboss), by default is uses an autodetection facility.
4679 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.
4680 jmx4perl_mbean | **Optional.** MBean name (e.g. java.lang:type=Memory).
4681 jmx4perl_attribute | **Optional.** Attribute name (e.g. HeapMemoryUsage).
4682 jmx4perl_operation | **Optional.** Operation to execute.
4683 jmx4perl_value | **Optional.** Shortcut for specifying mbean/attribute/path. Slashes within names must be escaped with backslash.
4684 jmx4perl_delta | **Optional.** Switches on incremental mode. Optional argument are seconds used for normalizing.
4685 jmx4perl_path | **Optional.** Inner path for extracting a single value from a complex attribute or return value (e.g. used).
4686 jmx4perl_target | **Optional.** JSR-160 Service URL specifing the target server.
4687 jmx4perl_target_user | **Optional.** Username to use for JSR-160 connection.
4688 jmx4perl_target_password | **Optional.** Password to use for JSR-160 connection.
4689 jmx4perl_proxy | **Optional.** Proxy to use.
4690 jmx4perl_user | **Optional.** User for HTTP authentication.
4691 jmx4perl_password | **Optional.** Password for HTTP authentication.
4692 jmx4perl_name | **Optional.** Name to use for output, by default a standard value based on the MBean and attribute will be used.
4693 jmx4perl_method | **Optional.** HTTP method to use, either get or post. By default a method is determined automatically based on the request type.
4694 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.
4695 jmx4perl_base_mbean | **Optional.** Base MBean name, interprets critical and warning values as relative in the range 0 .. 100%. Requires "jmx4perl_base_attribute".
4696 jmx4perl_base_attribute | **Optional.** Base attribute for a relative check. Requires "jmx4perl_base_mbean".
4697 jmx4perl_base_path | **Optional.** Base path for relative checks, where this path is used on the base attribute's value.
4698 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.
4699 jmx4perl_null | **Optional.** Value which should be used in case of a null return value of an operation or attribute. Defaults to null.
4700 jmx4perl_string | **Optional.** Force string comparison for critical and warning checks. Defaults to false.
4701 jmx4perl_numeric | **Optional.** Force numeric comparison for critical and warning checks. Defaults to false.
4702 jmx4perl_critical | **Optional.** Critical threshold for value.
4703 jmx4perl_warning | **Optional.** Warning threshold for value.
4704 jmx4perl_label | **Optional.** Label to be used for printing out the result of the check. For placeholders which can be used see the documentation.
4705 jmx4perl_perfdata | **Optional.** Whether performance data should be omitted, which are included by default. Defaults to "on" for numeric values, to "off" for strings.
4706 jmx4perl_unknown_is_critical | **Optional.** Map UNKNOWN errors to errors with a CRITICAL status. Defaults to false.
4707 jmx4perl_timeout | **Optional.** Seconds before plugin times out. Defaults to "15".
4708 jmx4perl_config | **Optional.** Path to configuration file.
4709 jmx4perl_server | **Optional.** Symbolic name of server url to use, which needs to be configured in the configuration file.
4710 jmx4perl_check | **Optional.** Name of a check configuration as defined in the configuration file, use array if you need arguments.
4712 #### <a id="plugin-contrib-command-squid"></a> squid
4714 Plugin for monitoring [Squid](https://exchange.icinga.com/exchange/check_squid).
4716 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
4719 ------------------------|----------------------------------------------------------------------------------
4720 squid_hostname | **Optional.** The host's address. Defaults to "$address$" if the host's `address` attribute is set, "$address6$" otherwise.
4721 squid_data | **Optional.** Data to fetch (default: Connections) available data: Connections Cache Resources Memory FileDescriptors.
4722 squid_port | **Optional.** Port number (default: 3128).
4723 squid_user | **Optional.** WWW user
4724 squid_password | **Optional.** WWW password
4725 squid_warning | **Optional.** Warning threshold. See http://nagiosplug.sourceforge.net/developer-guidelines.html#THRESHOLDFORMAT for the threshold format.
4726 squid_critical | **Optional.** Critical threshold. See http://nagiosplug.sourceforge.net/developer-guidelines.html#THRESHOLDFORMAT for the threshold format.
4727 squid_client | **Optional.** Path of squidclient (default: /usr/bin/squidclient).
4728 squid_timeout | **Optional.** Seconds before plugin times out (default: 15).
4731 #### <a id="plugin-contrib-command-nginx_status"></a> nginx_status
4733 Plugin for monitoring [nginx_status](https://github.com/regilero/check_nginx_status).
4735 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
4738 ------------------------|----------------------------------------------------------------------------------
4739 nginx_status_host_address | **Optional.** The host's address. Defaults to "$address$" if the host's `address` attribute is set, `address6` otherwise.
4740 nginx_status_port | **Optional.** the http port.
4741 nginx_status_url | **Optional.** URL to use, instead of the default (http://`nginx_status_hostname`/nginx_status).
4742 nginx_status_servername | **Optional.** ServerName to use if you specified an IP to match the good Virtualhost in your target
4743 nginx_status_ssl | **Optional.** set to use ssl connection
4744 nginx_status_disable_sslverify | **Optional.** set to disable SSL hostname verification
4745 nginx_status_user | **Optional.** Username for basic auth
4746 nginx_status_pass | **Optional.** Password for basic auth
4747 nginx_status_realm | **Optional.** Realm for basic auth
4748 nginx_status_maxreach | **Optional.** Number of max processes reached (since last check) that should trigger an alert
4749 nginx_status_timeout | **Optional.** timeout in seconds
4750 nginx_status_warn | **Optional.** Warning threshold (number of active connections, ReqPerSec or ConnPerSec that will cause a WARNING) like '10000,100,200'.
4751 nginx_status_critical | **Optional.** Critical threshold (number of active connections, ReqPerSec or ConnPerSec that will cause a CRITICAL) like '20000,200,300'.
4754 #### <a id="plugin-contrib-command-apache_status"></a> apache_status
4756 Plugin for monitoring [apache_status](https://github.com/lbetz/check_apache_status).
4758 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
4761 ------------------------|----------------------------------------------------------------------------------
4762 apache_status_address | **Optional.** The host's address. Defaults to "$address$" if the host's `address` attribute is set, `address6` otherwise.
4763 apache_status_port | **Optional.** the http port.
4764 apache_status_url | **Optional.** URL to use, instead of the default (http://`apache_status_address`/server-status).
4765 apache_status_ssl | **Optional.** set to use ssl connection
4766 apache_status_timeout | **Optional.** timeout in seconds
4767 apache_status_warning | **Optional.** Warning threshold (number of open slots, busy workers and idle workers that will cause a WARNING) like ':20,50,:50'.
4768 apache_status_critical | **Optional.** Critical threshold (number of open slots, busy workers and idle workers that will cause a CRITICAL) like ':10,25,:20'.
4771 #### <a id="plugin-contrib-command-kdc"></a> kdc
4773 Plugin for monitoring [kdc](https://exchange.nagios.org/directory/Plugins/Security/check_kdc/details).
4775 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
4778 ----------------|--------------------------------------------------------------------------
4779 kdc_address | **Optional.** The host's address. Defaults to "$address$" if the host's `address` attribute is set, `address6` otherwise.
4780 kdc_port | **Optional** Port on which KDC runs (default 88).
4781 kdc_principal | **Required** Principal name to authenticate as (including realm).
4782 kdc_keytab | **Required** Keytab file containing principal's key.
4785 #### <a id="plugin-contrib-command-rbl"></a> rbl
4787 Plugin for monitoring [rbl](https://github.com/matteocorti/check_rbl)
4789 Custom attributes passed as [command parameters](3-monitoring-basics.md#command-passing-parameters):
4792 ----------------|--------------------------------------------------------------------------
4793 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.
4794 rbl_server | **Required** List of RBL servers as an array.
4795 rbl_warning | **Optional** Number of blacklisting servers for a warning.
4796 rbl_critical | **Optional** Number of blacklisting servers for a critical.
4797 tbl_timeout | **Optional** Seconds before plugin times out (default: 15).
projects / icinga2 / blob